Package org.dcm4che.typeddicom.dataelements

Class ReferencedInstanceSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.dcm4che.typeddicom.SequenceWrapper<ReferencedInstanceSequence,ReferencedInstanceSequence.Item>

org.dcm4che.typeddicom.dataelements.ReferencedInstanceSequence

All Implemented Interfaces:

java.lang.Iterable<ReferencedInstanceSequence.Item>, java.util.Collection<ReferencedInstanceSequence.Item>, java.util.List<ReferencedInstanceSequence.Item>

public class ReferencedInstanceSequence
extends org.dcm4che.typeddicom.SequenceWrapper<ReferencedInstanceSequence,ReferencedInstanceSequence.Item>

Name: Referenced Instance Sequence
Keyword: ReferencedInstanceSequence
Tag: (0008,114A)
Value Representation: Sequence
Value Multiplicity: 1

• Described in the contexts:
  • Structured Display Image Box Module > Structured Display Image Box Sequence > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 1C
  Attribute Description:

  Reference to a non-image SOP Instance (e.g., waveform, SR, encapsulated document) whose content is to be displayed in the Image Box.

  Only a single Item shall be included in this Sequence.

  Required if Referenced Presentation State Sequence (0008,9237), Referenced Stereometric Instance Sequence (0008,1134), and Referenced Image Sequence (0008,1140) are not present.

  See DICOM Standard Part 3 - Section C.11.17.1.3.

  
  
• Described in the contexts:
  • SR Document General Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 1C
  Attribute Description:

  Sequence specifying SOP Instances significantly related to the current SOP Instance. Such referenced Instances may include equivalent documents or renderings of this document.

  One or more Items shall be included in this Sequence.

  Required if the identity of a CDA Document equivalent to the current SOP Instance is known at the time of creation of this SOP Instance (see DICOM Standard Part 3 - Section C.17.2.6). May be present otherwise.

  
  
• Described in the contexts:
  • Raw Data Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 3
  Attribute Description:

  Other Instances significantly related to this Instance.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • RT Dose Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 3
  Attribute Description:

  The set of SOP Instances used to derive this RT Dose SOP Instance.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Enhanced US Image Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 1C
  Attribute Description:

  A Sequence that provides reference to a set of non-image SOP Class/Instance pairs significantly related to this Image, including waveforms that may or may not be temporally synchronized with this image.

  One or more Items shall be included in this Sequence.

  Required if waveforms are acquired in conjunction with image acquisition. May be present otherwise.

  
  
• Described in the contexts:
  • Tractography Results Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 1C
  Attribute Description:

  The set of images used for tractography for all Track Sets within this Instance.

  One or more Items shall be included in this Sequence.

  Required if this Instance was created from DICOM images.

  
  
• Described in the contexts:
  • Intravascular OCT Image Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 3
  Attribute Description:

  A Sequence that provides reference to a set of non-image SOP Class/Instance pairs significantly related to this Image, including waveforms that may or may not be temporally synchronized with this image.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Enhanced XA/XRF Image Module Table > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 3
  Attribute Description:

  Non-image Composite SOP Instances that are significantly related to this Image, including waveforms that may or may not be temporally synchronized with this image.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Encapsulated Document Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 3
  Attribute Description:

  The set of non-image SOP Instances referenced in the encapsulated document.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • General Reference Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 3
  Attribute Description:

  Non-image composite SOP Instances that are significantly related to this Image, including waveforms that may or may not be temporally synchronized with this image.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Waveform Identification Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 3
  Attribute Description:

  Composite SOP Instances that are significantly related to this Waveform.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Ophthalmic Thickness Map Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 1C
  Attribute Description:

  A Sequence that provides reference to a set of SOP Class/Instance pairs identifying images or other composite SOP Instances to plan the acquisition or significant related information.

  Required if Ophthalmic Photography Reference Image available. May be present otherwise.

  See DICOM Standard Part 3 - Section C.7.6.16.2.5.1 for further explanation.

  Zero or more Items may be included in this Sequence.

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

  Sequence of Items each providing a reference to an Instance that is part of the Series defined by Series Instance UID (0020,000E) in the enclosing Item.

  One or more Items shall be included in this Sequence.

  
  
• Described in the contexts:
  • MR Spectroscopy Module > Referenced Instance Sequence
  as follows:
  Attribute Name: Referenced Instance Sequence
  Type: 1C
  Attribute Description:

  References to SOP Instances significantly related to the current SOP Instance, including water reference data.

  Required if Water Reference Acquisition (0018,9297) equals REFERENCED. May be present otherwise.

  One or more Items shall be present in this Sequence.

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

  Non-Image SOP Instances which are relevant in the invocation context.

  One or more Items are permitted for this Sequence.

  
  

Nested Class Summary

Nested Classes

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

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 class org.dcm4che.typeddicom.SequenceWrapper

VALUE_REPRESENTATION

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ReferencedInstanceSequence(org.dcm4che3.data.Sequence sequence)	Creates a new Referenced Instance Sequence object which wraps the provided sequence.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.SequenceWrapper

add, equals, get, getSequence, getValueRepresentation, hashCode, remove, set, size, toString

Methods inherited from class java.util.AbstractList

add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

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

ReferencedInstanceSequence

public ReferencedInstanceSequence(org.dcm4che3.data.Sequence sequence)

Creates a new Referenced Instance Sequence object which wraps the provided sequence.

Parameters:

sequence - the Sequence object to be linked.

Method Detail

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in class org.dcm4che.typeddicom.SequenceWrapper<ReferencedInstanceSequence,ReferencedInstanceSequence.Item>

getTag

public int getTag()

Specified by:

getTag in class org.dcm4che.typeddicom.SequenceWrapper<ReferencedInstanceSequence,ReferencedInstanceSequence.Item>