Package org.dcm4che.typeddicom.dataelements

Class HL7InstanceIdentifier

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.HL7InstanceIdentifier

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class HL7InstanceIdentifier
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: HL7 Instance Identifier
Keyword: HL7InstanceIdentifier
Tag: (0040,E001)
Value Representation: ST
Value Multiplicity: 1

• Described in the contexts:
  • Product Characteristics Module > Pertinent Documents Sequence > HL7 Instance Identifier
  as follows:
  Attribute Name: HL7 Instance Identifier
  Type:
  Attribute Description:

  Instance Identifier of the referenced HL7 Structured Document, encoded as a UID (OID or UUID), concatenated with a caret ("^") and Extension value (if Extension is present in Instance Identifier).

  
  
• Described in the contexts:
  • SOP Common Module > HL7 Structured Document Reference Sequence > HL7 Instance Identifier
  as follows:
  Attribute Name: HL7 Instance Identifier
  Type: 1
  Attribute Description:

  Instance Identifier of the referenced HL7 Structured Document, encoded as a UID (OID or UUID), concatenated with a caret ("^") and Extension value (if Extension is present in Instance Identifier).

  
  
• Described in the contexts:
  • Referenced Instances and Access Macro > Referenced SOP Sequence > HL7 Instance Identifier
  as follows:
  Attribute Name: HL7 Instance Identifier
  Type: 1C
  Attribute Description:

  Instance Identifier of the encapsulated HL7 Structured Document, encoded as a UID (OID or UUID), concatenated with a caret ("^") and Extension value (if Extension is present in Instance Identifier).

  Required if Type of Instances (0040,E020) is CDA.

  
  
• Described in the contexts:
  • Assertion Macro > Pertinent Documents Sequence > HL7 Instance Identifier
  as follows:
  Attribute Name: HL7 Instance Identifier
  Type: 3
  Attribute Description:

  Instance Identifier of the referenced document, encoded as a UID (OID or UUID), concatenated with a caret ("^") and Extension value (if Extension is present in Instance Identifier).

  
  
• Described in the contexts:
  • Encapsulated Document Module > HL7 Instance Identifier
  as follows:
  Attribute Name: HL7 Instance Identifier
  Type: 1C
  Attribute Description:

  Instance Identifier of the encapsulated HL7 Structured Document, encoded as a UID (OID or UUID), concatenated with a caret ("^") and Extension value (if Extension is present in Instance Identifier).

  Required if encapsulated document is a CDA document.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
HL7InstanceIdentifier()	Creates a new HL7 Instance Identifier object which wraps a new and empty Attributes object.
HL7InstanceIdentifier(org.dcm4che3.data.Attributes attributes)	Creates a new HL7 Instance Identifier object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
HL7InstanceIdentifier	copy()	Returns a new HL7 Instance Identifier which wraps a copy of the Attributes wrapped in this HL7 Instance Identifier.
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, getPrivateCreator, getValue

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

getValueRepresentation

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

Constructor Details

HL7InstanceIdentifier

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

Creates a new HL7 Instance Identifier object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

HL7InstanceIdentifier

public HL7InstanceIdentifier()

Creates a new HL7 Instance Identifier object which wraps a new and empty Attributes object.

Method Details

copy

public HL7InstanceIdentifier copy()

Returns a new HL7 Instance Identifier which wraps a copy of the Attributes wrapped in this HL7 Instance Identifier. (see Attributes(Attributes)

Returns:

a new HL7 Instance Identifier which wraps a copy of the Attributes wrapped in this HL7 Instance Identifier.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.