Package org.dcm4che.typeddicom.dataelements

Class PurposeOfReferenceCodeSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

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

org.dcm4che.typeddicom.dataelements.PurposeOfReferenceCodeSequence

All Implemented Interfaces:

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

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

Name: Purpose of Reference Code Sequence
Keyword: PurposeOfReferenceCodeSequence
Tag: (0040,A170)
Value Representation: Sequence
Value Multiplicity: 1
Comment: See Note

• Described in the contexts:
  • General Reference Module > Source Instance Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 3
  Attribute Description:

  Describes the purpose for which the reference is made, that is what role the source Instance(s) played in the derivation of this Instance.

  Only a single Item single Item is permitted in this Sequence.

  
  
• Described in the contexts:
  • Corneal Topography Map Analysis Module > Source Image Sequence > Purpose of Reference Code Sequence
  • Ophthalmic Thickness Map Module > Source Image Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Describes the purpose for which the reference is made, (i.e., the role the source image or frame(s) played in the generation of this image). Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • X-Ray Image Module > Referenced Image Sequence > Purpose of Reference Code Sequence
  • General Reference Module > Referenced Image Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 3
  Attribute Description:

  Describes the purpose for which the reference is made.

  Only a single Item is permitted in this Sequence.

  
  
• Described in the contexts:
  • General Reference Module > Source Image Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 3
  Attribute Description:

  Describes the purpose for which the reference is made, that is what role the source image or frame(s) played in the derivation of this image.

  Only a single Item is permitted in this Sequence.

  
  
• Described in the contexts:
  • Enhanced US Image Module > Source Image Sequence > Purpose of Reference Code Sequence
  • Enhanced US Image Module > Referenced Image Sequence > Purpose of Reference Code Sequence
  • MR Spectroscopy Module > Referenced Instance Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Describes the purpose for which the reference is made.

  Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • RT Dose Module > Referenced Instance Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Code describing the purpose of the reference to the Instance(s).

  Only a single Item is permitted in this Sequence.

  
  
• Described in the contexts:
  • VL Image Module > Referenced Image Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 2
  Attribute Description:

  Describes the purpose for which the reference is made.

  Zero or one Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Encapsulated Document Module > Source Instance Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 3
  Attribute Description:

  Describes the purpose for which the reference is made, that is what role the source Instances played in the derivation of this encapsulated document

  Only a single Item single Item is permitted in this Sequence.

  
  
• Described in the contexts:
  • Referenced Image Macro > Referenced Image Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1C
  Attribute Description:

  Describes the purpose for which the reference is made.

  Only a single Item shall be included in this Sequence.

  Required if SOP Class UID is not "1.2.840.10008.5.1.4.1.1.2.2" (Legacy Converted Enhanced CT Image Storage) and not "1.2.840.10008.5.1.4.1.1.4.4" (Legacy Converted Enhanced MR Image Storage) and not "1.2.840.10008.5.1.4.1.1.128.1" (Legacy Converted Enhanced PET Image Storage), may be present otherwise.

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

  
  
• Described in the contexts:
  • Ophthalmic Optical Coherence Tomography En Face Image Module > Source Image Sequence > Purpose of Reference Code Sequence
  • Ophthalmic Photography Image Module > Source Image Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Describes the purpose for which the reference is made, that is what role the source image or frame(s) played in the derivation of this image.

  Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Hierarchical Series Reference Macro > Referenced SOP Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 3
  Attribute Description:

  Describes the purpose for which the reference is made.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Related Information Entities Macro > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Describes the purpose for which the references are made.

  Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Intravascular OCT Image Module > Referenced Instance Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Code describing the purpose of the reference to the SOP Instances. Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Enhanced XA/XRF Image Module Table > Referenced Instance Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Code describing the purpose of the reference to the SOP Instances.

  Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Ophthalmic Thickness Map Module > Referenced Instance Sequence > Purpose of Reference Code Sequence
  • SR Document General Module > Referenced Instance Sequence > Purpose of Reference Code Sequence
  • General Reference Module > Referenced Instance Sequence > Purpose of Reference Code Sequence
  • Enhanced US Image Module > Referenced Instance Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Code describing the purpose of the reference to the Instance(s).

  Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • SOP Common Module > Contributing Equipment Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Describes the purpose for which the related equipment is being referenced.

  Only a single Item shall be included in this Sequence.

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

  
  
• Described in the contexts:
  • Patient Medical Module > Pertinent Documents Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type:
  Attribute Description:

  Describes the purpose for which the document reference is made. Zero or more Items shall be included in this Sequence.

  
  
• Described in the contexts:
  • Raw Data Module > Referenced Instance Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  Describes the purpose for which the reference is made.

  Only a single Item shall be included in this Sequence.

  See DICOM Standard Part 3 - Section C.7.6.16.2.5.1.

  
  
• Described in the contexts:
  • Derivation Image Macro > Derivation Image Sequence > Source Image Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1C
  Attribute Description:

  Describes the purpose for which the reference is made, that is what role the source image or frame played in the derivation of this image or frame.

  Only a single Item shall be included in this Sequence.

  Required if SOP Class UID is not "1.2.840.10008.5.1.4.1.1.2.2" (Legacy Converted Enhanced CT Image Storage) and not "1.2.840.10008.5.1.4.1.1.4.4" (Legacy Converted Enhanced MR Image Storage) and not "1.2.840.10008.5.1.4.1.1.128.1" (Legacy Converted Enhanced PET Image Storage), may be present otherwise.

  
  
• Described in the contexts:
  • Inventory Module > Inventoried Studies Sequence > Inventoried Series Sequence > Inventoried Instances Sequence > Alternate Representation Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 1
  Attribute Description:

  The nature of the alternate encoding.

  One Item shall be included in this Sequence.

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

  Code describing the purpose of the reference to the Instance(s).

  Only a single Item is permitted in this Sequence.

  
  
• Described in the contexts:
  • General Series Module > Related Series Sequence > Purpose of Reference Code Sequence
  • Enhanced PET Series Module > Related Series Sequence > Purpose of Reference Code Sequence
  as follows:
  Attribute Name: Purpose of Reference Code Sequence
  Type: 2
  Attribute Description:

  Describes the purpose for which the reference is made.

  Zero or more Items shall be included in this Sequence.

  When absent, implies that the reason for the reference is unknown.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PurposeOfReferenceCodeSequence.Builder<SELF extends PurposeOfReferenceCodeSequence.Builder<SELF,T>,T extends PurposeOfReferenceCodeSequence.Holder>
static interface	PurposeOfReferenceCodeSequence.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Purpose of Reference Code Sequence" (see PurposeOfReferenceCodeSequence)
static class	PurposeOfReferenceCodeSequence.Item

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
PurposeOfReferenceCodeSequence(org.dcm4che3.data.Sequence sequence)	Creates a new Purpose of Reference Code 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

PurposeOfReferenceCodeSequence

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

Creates a new Purpose of Reference Code 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<PurposeOfReferenceCodeSequence,PurposeOfReferenceCodeSequence.Item>

getTag

public int getTag()

Specified by:

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