Package org.dcm4che.typeddicom.dataelements

Class PatientID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PatientID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class PatientID
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Patient ID
Keyword: PatientID
Tag: (0010,0020)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Patient Module > Other Patient IDs Sequence > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type: 1
  Attribute Description:

  An identifier for the Patient.

  Note

  In the case of imaging a group of small animals simultaneously, the single value of this identifier corresponds to the identification of the entire group. See also DICOM Standard Part 3 - Section C.7.1.4.1.1.

  
  
• Described in the contexts:
  • Patient Group Macro > Group of Patients Identification Sequence > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type: 1
  Attribute Description:

  Primary identifier for an individual subject.

  
  
• Described in the contexts:
  • Patient Identification Module > Other Patient IDs Sequence > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type:
  Attribute Description:

  An identifier for the Patient.

  
  
• Described in the contexts:
  • Unified Procedure Step Relationship Module > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type:
  Attribute Description:

  Primary identifier for the patient.

  Note

  In the case of imaging a group of small animals simultaneously, the single value of this identifier corresponds to the identification of the entire group. See also DICOM Standard Part 3 - Section C.7.1.4.1.1.

  See DICOM Standard Part 3 - Section C.30.4.1

  
  
• Described in the contexts:
  • Patient Module > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type: 2
  Attribute Description:

  Primary identifier for the Patient.

  Note

  In the case of imaging a group of small animals simultaneously, the single value of this identifier corresponds to the identification of the entire group. See also DICOM Standard Part 3 - Section C.7.1.4.1.1.

  
  
• Described in the contexts:
  • Patient Group Macro > Source Patient Group Identification Sequence > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type: 1
  Attribute Description:

  Primary identifier for the group of subjects.

  
  
• Described in the contexts:
  • Substance Administration Log Module > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type:
  Attribute Description:

  Primary identification number or code for the patient.

  
  
• Described in the contexts:
  • Patient Identification Module > Patient ID
  • Performed Procedure Step Relationship Module > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type:
  Attribute Description:

  Primary identifier for the Patient.

  Note

  In the case of imaging a group of small animals simultaneously, the single value of this identifier corresponds to the identification of the entire group. See also DICOM Standard Part 3 - Section C.7.1.4.1.1.

  
  
• Described in the contexts:
  • Unified Procedure Step Relationship Module > Other Patient IDs Sequence > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type:
  Attribute Description:

  An identifier for the patient.

  
  
• Described in the contexts:
  • RT General Machine Verification Module > Patient ID
  as follows:
  Attribute Name: Patient ID
  Type:
  Attribute Description:

  Primary identifier for the patient.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PatientID.Builder<SELF extends PatientID.Builder<SELF,T>,T extends PatientID.Holder>
static interface	PatientID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Patient ID" (see PatientID)

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongStringWrapper

LongStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends LongStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
PatientID()	Creates a new Patient ID object which wraps a new and empty Attributes object.
PatientID(org.dcm4che3.data.Attributes attributes)	Creates a new Patient ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
PatientID	copy()	Returns a new Patient ID which wraps a copy of the Attributes wrapped in this Patient ID.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

PatientID

public PatientID(org.dcm4che3.data.Attributes attributes)

Creates a new Patient ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PatientID

public PatientID()

Creates a new Patient ID object which wraps a new and empty Attributes object.

Method Details

copy

public PatientID copy()

Returns a new Patient ID which wraps a copy of the Attributes wrapped in this Patient ID. (see Attributes(Attributes)

Returns:

a new Patient ID which wraps a copy of the Attributes wrapped in this Patient ID.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.