Package org.dcm4che.typeddicom.dataelements

Interface PatientID.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

PatientIdentificationModule, PatientModule, PerformedProcedureStepRelationshipModule, RTGeneralMachineVerificationModule, SubstanceAdministrationLogModule, UnifiedProcedureStepRelationshipModule

All Known Implementing Classes:

AcquisitionContextSRIOD, AdvancedBlendingPresentationStateIOD, AmbulatoryECGIOD, ArterialPulseWaveformIOD, AutorefractionMeasurementsIOD, BasicCardiacElectrophysiologyWaveformIOD, BasicStructuredDisplayIOD, BasicTextSRIOD, BasicVoiceAudioWaveformIOD, BlendingSoftcopyPresentationStateIOD, BodyPositionWaveformIOD, BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, ChestCADSRIOD, ColonCADSRIOD, ColorSoftcopyPresentationStateIOD, Comprehensive3DSRIOD, ComprehensiveSRIOD, ContentAssessmentResultsIOD, CornealTopographyMapIOD, CRImageIOD, CTImageIOD, CTPerformedProcedureProtocolIOD, DeformableSpatialRegistrationIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, ElectromyogramIOD, ElectrooculogramIOD, EncapsulatedCDAIOD, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedSRIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRayRadiationDoseStructuredReportIOD, EnhancedXRFImageIOD, ExtensibleSRIOD, GeneralAudioWaveformIOD, GeneralECGIOD, GrayscaleSoftcopyPresentationStateIOD, GroupOfPatientsIdentificationSequence.Item, HemodynamicWaveformIOD, ImplantationPlanSRDocumentIOD, IntraocularLensCalculationsIOD, IntravascularOpticalCoherenceTomographyImageIOD, InventoriedStudiesSequence.Item, KeratometryMeasurementsIOD, KeyObjectSelectionDocumentIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, LensometryMeasurementsIOD, MacularGridThicknessAndVolumeReportIOD, MammographyCADSRIOD, MicroscopyBulkSimpleAnnotationsIOD, ModalityPerformedProcedureStepIOD, MRImageIOD, MRSpectroscopyIOD, MultiChannelRespiratoryWaveformIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicAxialMeasurementsIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicTomographyImageIOD, OphthalmicVisualFieldStaticPerimetryMeasurementsIOD, OriginalImageSequence.Item, OtherPatientIDsSequence.Item, ParametricMapIOD, PatientIdentificationModule.SimpleWrapper, PatientModule.SimpleWrapper, PatientRadiationDoseStructuredReportIOD, PerformedImagingAgentAdministrationSRIOD, PerformedProcedureStepRelationshipModule.SimpleWrapper, PETImageIOD, PlanarMPRVolumetricPresentationStateIOD, PlannedImagingAgentAdministrationSRIOD, ProcedureLogIOD, ProposedStudySequence.Item, PseudoColorSoftcopyPresentationStateIOD, RadiopharmaceuticalRadiationDoseSRIOD, RawDataIOD, RealTimeAudioWaveformIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RealWorldValueMappingIOD, RenditionSelectionDocumentIOD, RespiratoryWaveformIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RoutineScalpElectroencephalogramIOD, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTConventionalMachineVerificationIOD, RTDoseIOD, RTGeneralMachineVerificationModule.SimpleWrapper, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonMachineVerificationIOD, RTIonPlanIOD, RTPhysicianIntentIOD, RTPlanIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTStructureSetIOD, RTTreatmentPreparationIOD, RTTreatmentSummaryRecordIOD, SecondaryCaptureImageIOD, SegmentationIOD, SimplifiedAdultEchoSRIOD, SleepElectroencephalogramIOD, SourcePatientGroupIdentificationSequence.Item, SpatialFiducialsIOD, SpatialRegistrationIOD, SpectaclePrescriptionReportIOD, StereometricRelationshipIOD, SubjectiveRefractionMeasurementsIOD, SubstanceAdministrationLogModule.SimpleWrapper, SurfaceScanMeshIOD, SurfaceScanPointCloudIOD, SurfaceSegmentationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, TractographyResultsIOD, TwelveLeadECGIOD, UnifiedProcedureStepIOD, UnifiedProcedureStepRelationshipModule.SimpleWrapper, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VisualAcuityMeasurementsIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, VolumeRenderingVolumetricPresentationStateIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XAPerformedProcedureProtocolIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiationDoseSRIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

PatientID

public static interface PatientID.Holder
extends org.dcm4che.typeddicom.AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Patient ID" (see PatientID)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PatientID.Holder.Builder

Method Summary

Modifier and Type	Method	Description
static PatientID.Holder.Builder	builder()
static PatientID.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientID()
default PatientID	getPatientID()
default void	removePatientID()	Removes the Patient ID (see PatientID
static PatientID.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

static PatientID.Holder wrap(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - an attributes object containing the Patient ID (see PatientID)

Returns:

a wrapper object implementing the PatientID.Holder interface.

builder

static PatientID.Holder.Builder builder()

Returns:

a PatientID.Holder.Builder to create Patient ID Items with a fluent API.

builder

static PatientID.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - the Attributes to be wrapped by the PatientID.Holder.Builder.

Returns:

a PatientID.Holder.Builder to create Patient ID Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPatientID

default PatientID getPatientID()

Returns:

the Patient ID (see PatientID)

containsPatientID

default boolean containsPatientID()

Returns:

whether it contains the Patient ID (see PatientID)

removePatientID

default void removePatientID()

Removes the Patient ID (see PatientID