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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class ReferencedSOPInstanceUID
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

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

• 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:
  • Inventory Creation Module > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type:
  Attribute Description:

  SOP Instance UID of the produced Inventory SOP Instance at the root of the tree of incorporated Inventory SOP Instances (see DICOM Standard Part 3 - Section C.38.3.1.1).

  
  
• 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:
  • 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
  • SOP Instance Reference Macro > Referenced SOP Instance UID
  • Intravascular OCT Series Module > Referenced Performed Procedure Step Sequence > 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:
  • 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:
  • Inventory Reference Macro > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type: 1
  Attribute Description:

  SOP Instance UID of the Inventory SOP Instance included by reference.

  
  
• 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:
  • Image Box Pixel Presentation Module > Original Image Sequence > Referenced SOP Instance UID
  as follows:
  Attribute Name: Referenced SOP Instance UID
  Type:
  Attribute Description:

  SOP Instance UID of the original modality image used to create this Image Box.

  
  
• 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:
  • 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.

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

  
  

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 org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends UniqueIdentifierUIDWrapper>

Field Summary

Fields

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

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

VALUE_REPRESENTATION

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.
java.lang.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, getKnownAttributeTags, getUnknownAttributeTags, 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.UniqueIdentifierUIDWrapper

getValueRepresentation

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

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 Detail

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.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper