Package org.dcm4che.typeddicom.dataelements

Class ReferencedSOPInstanceUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedSOPInstanceUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class ReferencedSOPInstanceUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Referenced SOP Instance UID
Keyword: ReferencedSOPInstanceUID
Tag: (0008,1155)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • SOP Instance Reference Macro > Referenced SOP Instance UID
  • Intravascular OCT Series Module > Referenced Performed Procedure Step Sequence > Referenced SOP Instance UID
  • Referenced Instances and Access Macro > Referenced SOP Sequence > Referenced SOP Instance UID
  • Ophthalmic Axial Measurements Quality Image SOP Instance Reference Macro > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type: 1
  Attribute Description:

  Uniquely identifies the referenced SOP Instance.

  
  
• Described in the contexts:
  • Ophthalmic Optical Coherence Tomography En Face Image Module > Referenced Surface Mesh Identification Sequence > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type: 1
  Attribute Description:

  Referenced SOP Instance that contains the surface segmentation used in the creation of this SOP Instance.

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

  Unique identifier for the referenced document as used in DICOM Instance references (see DICOM Standard Part 3 - Section C.12.1.1.6)

  
  
• Described in the contexts:
  • Scheduled Procedure Step Module > Scheduled Procedure Step Sequence > Referenced Defined Protocol Sequence > Referenced SOP Instance UID
  • Scheduled Procedure Step Module > Scheduled Procedure Step Sequence > Referenced Performed Protocol Sequence > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type:
  Attribute Description:

  Uniquely identifies the referenced SOP Instance.

  
  
• Described in the contexts:
  • Performed Storage Module > Storage Protocol Element Sequence > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type: 1C
  Attribute Description:

  The UID of the Protocol Instance containing the element referenced in Source Reconstruction Protocol Element Number (0018,993A) or Source Acquisition Protocol Element Number (0018,9938).

  Required if the referenced acquisition or reconstruction protocol element is not in this Instance.

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

  Unique identifier for the HL7 Structured Product Label Document as used in DICOM Instance references (see DICOM Standard Part 3 - Section C.12.1.1.6)

  
  
• Described in the contexts:
  • Performed CT Reconstruction Module > Reconstruction Protocol Element Sequence > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type: 1C
  Attribute Description:

  The UID of the Instance containing the acquisition protocol element referenced in Source Acquisition Protocol Element Number (0018,9938).

  Required if the referenced acquisition protocol element is not in this Instance.

  
  
• Described in the contexts:
  • Performed XA Reconstruction Module > Reconstruction Protocol Element Sequence > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type: 1C
  Attribute Description:

  The UID of the instance containing the acquisition protocol element referenced in Source Acquisition Protocol Element Number (0018,9938).

  Required if the referenced acquisition protocol element is not in this instance.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
ReferencedSOPInstanceUID()	Creates a new Referenced SOP Instance UID object which wraps a new and empty Attributes object.
ReferencedSOPInstanceUID(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced SOP Instance UID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedSOPInstanceUID	copy()	Returns a new Referenced SOP Instance UID which wraps a copy of the Attributes wrapped in this Referenced SOP Instance UID.
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

ReferencedSOPInstanceUID

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

Creates a new Referenced SOP Instance UID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedSOPInstanceUID

public ReferencedSOPInstanceUID()

Creates a new Referenced SOP Instance UID object which wraps a new and empty Attributes object.

Method Details

copy

public ReferencedSOPInstanceUID copy()

Returns a new Referenced SOP Instance UID which wraps a copy of the Attributes wrapped in this Referenced SOP Instance UID. (see Attributes(Attributes)

Returns:

a new Referenced SOP Instance UID which wraps a copy of the Attributes wrapped in this Referenced SOP Instance UID.

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.