Package org.dcm4che.typeddicom.dataelements

Class TypeOfPatientID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TypeOfPatientID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class TypeOfPatientID
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Type of Patient ID
Keyword: TypeOfPatientID
Tag: (0010,0022)
Value Representation: CS
Value Multiplicity: 1

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

  The type of identifier in the Patient ID (0010,0020).

  Defined Terms:

  TEXT

  RFID

  BARCODE

  Note

  1. The identifier is coded as a string regardless of the type, not as a binary value.

  2. When this Attribute has a value of BARCODE, Patient ID (0010,0020) may or may not have the same value as Barcode Value (2200,0005) in the Scheduled Procedure Step Module, if present.

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

  The type of identifier in the Patient ID (0010,0020).

  Defined Terms:

  TEXT

  RFID

  BARCODE

  Note

  1. The identifier is coded as a string regardless of the type, not as a binary value.

  2. When this Attribute has a value of BARCODE, Patient ID (0010,0020) may or may not have the same value as Barcode Value (2200,0005) in the SOP Common Module, if present.

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

  The type of identifier in the Patient ID (0010,0020) in this Item.

  Defined Terms:

  TEXT

  RFID

  BARCODE

  Note

  1. The identifier is coded as a string regardless of the type, not as a binary value.

  2. When this Attribute has a value of BARCODE, Patient ID (0010,0020) may or may not have the same value as Barcode Value (2200,0005) in the Scheduled Procedure Step Module, if present.

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

  The type of identifier in the Patient ID (0010,0020).

  Defined Terms:

  TEXT

  RFID

  BARCODE

  Note

  1. The identifier is coded as a string regardless of the type, not as a binary value.

  2. When this Attribute has a value of BARCODE, Patient ID (0010,0020) may or may not have the same value as Barcode Value (2200,0005) in the SOP Common Module, if present.

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

  The type of identifier in the Patient ID (0010,0020) in this Item.

  Defined Terms:

  TEXT

  RFID

  BARCODE

  Note

  1. The identifier is coded as a string regardless of the type, not as a binary value.

  2. When this Attribute has a value of BARCODE, Patient ID (0010,0020) may or may not have the same value as Barcode Value (2200,0005) in the SOP Common Module, if present.

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

  The type of identifier in the Patient ID (0010,0020) in this Item.

  Defined Terms:

  TEXT

  RFID

  BARCODE

  Note

  1. The identifier is coded as a string regardless of the type, not as a binary value.

  2. When this Attribute has a value of BARCODE, Patient ID (0010,0020) may or may not have the same value as Barcode Value (2200,0005) in the SOP Common Module, if present.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TypeOfPatientID	copy()	Returns a new Type of Patient ID which wraps a copy of the Attributes wrapped in this Type of Patient ID.
String	getPrivateCreator()
int	getTag()

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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

TypeOfPatientID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

TypeOfPatientID

public TypeOfPatientID()

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

Method Details

copy

public TypeOfPatientID copy()

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

Returns:

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

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.