Package org.dcm4che.typeddicom.dataelements

Class UniversalEntityID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.UniversalEntityID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UnlimitedTextWrapper

public class UniversalEntityID
extends AbstractDataElementWrapper
implements UnlimitedTextWrapper

Name: Universal Entity ID
Keyword: UniversalEntityID
Tag: (0040,0032)
Value Representation: UT
Value Multiplicity: 1

• Described in the contexts:
  • HL7v2 Hierarchic Designator Macro > Universal Entity ID
  as follows:
  Attribute Name: Universal Entity ID
  Type: 1C
  Attribute Description:

  Universal or unique identifier for an entity. Required if Local Namespace Entity ID (0040,0031) is not present; may be present otherwise.

  
  
• Described in the contexts:
  • Issuer of Patient ID Macro > Issuer of Patient ID Qualifiers Sequence > Universal Entity ID
  as follows:
  Attribute Name: Universal Entity ID
  Type: 3
  Attribute Description:

  Universal or unique identifier for the Patient ID Assigning Authority. The authority identified by this Attribute shall be the same as that of Issuer of Patient ID (0010,0021), if present.

  Note

  Equivalent to HL7 v2 CX component 4 subcomponent 2 (Universal ID).

  
  

Nested Class Summary

Nested Classes

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

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

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

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.UnlimitedTextWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
UniversalEntityID	copy()	Returns a new Universal Entity ID which wraps a copy of the Attributes wrapped in this Universal Entity 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.DataElementWrapper

exists, getValue

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

getString, setString

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

getValueRepresentation

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

UniversalEntityID

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

Creates a new Universal Entity ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

UniversalEntityID

public UniversalEntityID()

Creates a new Universal Entity ID object which wraps a new and empty Attributes object.

Method Details

copy

public UniversalEntityID copy()

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

Returns:

a new Universal Entity ID which wraps a copy of the Attributes wrapped in this Universal Entity 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.