Package org.dcm4che.typeddicom.dataelements

Class SeriesInstanceUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SeriesInstanceUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class SeriesInstanceUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Series Instance UID
Keyword: SeriesInstanceUID
Tag: (0020,000E)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • Presentation State Relationship Macro > Referenced Series Sequence > Series Instance UID
  as follows:
  Attribute Name: Series Instance UID
  Type: 1
  Attribute Description:

  Unique identifier of a Series that is part of the Study defined by the Study Instance UID (0020,000D) in the enclosing Data Set.

  Note

  The Study Instance UID (0020,000D) value will be that of the presentation state itself, unless the Macro is invoked from Blending Sequence (0070,0402) in the DICOM Standard Part 3 - Section C.11.14, in which case it will be explicitly specified.

  
  
• Described in the contexts:
  • General Series Module > Series Instance UID
  • Encapsulated Document Series Module > Series Instance UID
  • RT Series Module > Series Instance UID
  as follows:
  Attribute Name: Series Instance UID
  Type: 1
  Attribute Description:

  Unique identifier of the Series.

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

  Unique identifier of the Series of which all the Instances referenced in this Item are part.

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

  Instance UID of Related Series

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

  Uniquely identifies the referenced Series.

  
  
• Described in the contexts:
  • Image Acquisition Results Module > Performed Series Sequence > Series Instance UID
  as follows:
  Attribute Name: Series Instance UID
  Type:
  Attribute Description:

  Unique Identifier of the Series.

  
  
• Described in the contexts:
  • Key Object Document Series Module > Series Instance UID
  as follows:
  Attribute Name: Series Instance UID
  Type: 1
  Attribute Description:

  Unique identifier of the Series.

  Note

  No specific semantics are specified.

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

  Unique identifier of the Series containing the referenced Instances.

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

  Unique identifier of a Series that is part of this Study and contains the referenced Composite Object(s).

  
  
• Described in the contexts:
  • Structure Set Module > Referenced Frame of Reference Sequence > RT Referenced Study Sequence > RT Referenced Series Sequence > Series Instance UID
  as follows:
  Attribute Name: Series Instance UID
  Type: 1
  Attribute Description:

  Unique identifier for the Series containing the images.

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

  Unique identifier of a Series that is part of the Study defined by the Study Instance UID (0020,000D)

  
  
• Described in the contexts:
  • SR Document Series Module > Series Instance UID
  as follows:
  Attribute Name: Series Instance UID
  Type: 1
  Attribute Description:

  Unique identifier of the Series.

  Note

  No SR-specific semantics are specified.

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

  Unique identifier for the Series that is part of the Study identified in Study Instance UID (0020,000D), if present, and contains the referenced object Instance(s).

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

  
  

Nested Class Summary

Nested Classes

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SeriesInstanceUID()	Creates a new Series Instance UID object which wraps a new and empty Attributes object.
SeriesInstanceUID(org.dcm4che3.data.Attributes attributes)	Creates a new Series Instance UID object which wraps the provided attributes.

Method Summary

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

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

SeriesInstanceUID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

SeriesInstanceUID

public SeriesInstanceUID()

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

Method Details

copy

public SeriesInstanceUID copy()

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

Returns:

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

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.