Package org.dcm4che.typeddicom.dataelements

Class StudyInstanceUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.StudyInstanceUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class StudyInstanceUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Study Instance UID
Keyword: StudyInstanceUID
Tag: (0020,000D)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • Requested Procedure Module > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type:
  Attribute Description:

  Unique identifier to be used to identify the Study

  
  
• Described in the contexts:
  • General Series Module > Related Series Sequence > Study Instance UID
  • Enhanced PET Series Module > Related Series Sequence > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 1
  Attribute Description:

  Instance UID of Study to which the related Series belongs

  
  
• Described in the contexts:
  • Common Instance Reference Module > Studies Containing Other Referenced Instances Sequence > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 1
  Attribute Description:

  Unique identifier of the Study containing the referenced Instances.

  
  
• Described in the contexts:
  • General Contributing Sources Macro > Contributing SOP Instances Reference Sequence > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 1
  Attribute Description:

  Unique identifier for the Study of the Contributing SOP Instances.

  
  
• Described in the contexts:
  • Instance Availability Notification Module > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type:
  Attribute Description:

  Unique identifier for the Study of which all the Instances referenced in this notification are part.

  
  
• Described in the contexts:
  • Unified Procedure Step Relationship Module > Referenced Request Sequence > Study Instance UID
  • Performed Procedure Step Relationship Module > Scheduled Step Attributes Sequence > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type:
  Attribute Description:

  Unique identifier for the Study.

  
  
• Described in the contexts:
  • Unified Procedure Step Scheduled Procedure Information Module > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type:
  Attribute Description:

  Unique Study identification that shall be used for the created Composite SOP Instances resulting from this Unified Procedure Step.

  
  
• Described in the contexts:
  • Hierarchical SOP Instance Reference Macro > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 1
  Attribute Description:

  Unique identifier for the Study

  
  
• Described in the contexts:
  • Related Information Entities Macro > Referenced Study Sequence > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 1
  Attribute Description:

  Uniquely identifies the referenced Study.

  
  
• Described in the contexts:
  • Presentation State Blending Module > Blending Sequence > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 1
  Attribute Description:

  Unique identifier for the Study that contains the images, which may differ from the Study in which the presentation state is contained.

  
  
• Described in the contexts:
  • Referenced Instances and Access Macro > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 1C
  Attribute Description:

  Unique identifier for the Study.

  Required if Type of Instances (0040,E020) is DICOM and the Information Model of the referenced Instance contains the Study IE

  
  
• Described in the contexts:
  • Request Macro > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 3
  Attribute Description:

  The unique identifier for the Study provided for this Requested Procedure.

  
  
• Described in the contexts:
  • Key Object Document Module > Referenced Request Sequence > Study Instance UID
  • General Study Module > Study Instance UID
  • SR Document General Module > Referenced Request Sequence > Study Instance UID
  • Advanced Blending Presentation State Module > Advanced Blending Sequence > Study Instance UID
  as follows:
  Attribute Name: Study Instance UID
  Type: 1
  Attribute Description:

  Unique identifier for the Study.

  
  

Nested Class Summary

Nested Classes

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

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

Method Summary

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

StudyInstanceUID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

StudyInstanceUID

public StudyInstanceUID()

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

Method Details

copy

public StudyInstanceUID copy()

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

Returns:

a new Study Instance UID which wraps a copy of the Attributes wrapped in this Study 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.