Package org.dcm4che.typeddicom.dataelements

Class InstitutionCodeSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

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

org.dcm4che.typeddicom.dataelements.InstitutionCodeSequence

All Implemented Interfaces:

Iterable<InstitutionCodeSequence.Item>, Collection<InstitutionCodeSequence.Item>, List<InstitutionCodeSequence.Item>

public class InstitutionCodeSequence
extends SequenceWrapper<InstitutionCodeSequence,InstitutionCodeSequence.Item>

Name: Institution Code Sequence
Keyword: InstitutionCodeSequence
Tag: (0008,0082)
Value Representation: SQ
Value Multiplicity: 1

• Described in the contexts:
  • SR Document General Module > Custodial Organization Sequence > Institution Code Sequence
  • Protocol Context Module > Custodial Organization Sequence > Institution Code Sequence
  as follows:
  Attribute Name: Institution Code Sequence
  Type: 2
  Attribute Description:

  Coded identifier of Custodial Institution or Organization.

  Zero or one Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Visit Identification Module > Institution Code Sequence
  as follows:
  Attribute Name: Institution Code Sequence
  Type:
  Attribute Description:

  A Sequence that conveys the healthcare facility identification. Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Identified Person or Device Macro > Institution Code Sequence
  as follows:
  Attribute Name: Institution Code Sequence
  Type: 2
  Attribute Description:

  Institution or organization to which the identified person is responsible or accountable, or that manages the identified device.

  Zero or one Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Person Identification Macro Description > Institution Code Sequence
  as follows:
  Attribute Name: Institution Code Sequence
  Type: 1C
  Attribute Description:

  Institution or organization to which the identified individual is responsible or accountable.

  Required if Institution Name (0008,0080) is not present. May be present otherwise.

  Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Protocol Approval Module > Approval Sequence > Institution Code Sequence
  as follows:
  Attribute Name: Institution Code Sequence
  Type: 1C
  Attribute Description:

  Institution or organization for which use of the protocol is approved/disapproved or eligible/ineligible for reimbursement.

  Note

  The institution identified by the code can represent a hospital network, a hospital, a clinic or a department. An institution can assign codes for it's subsidiary organizations.

  Required if Assertion Code Sequence (0044,0101) is PS3.16 DCM128603(128603, DCM, "Approved for use at the institution") or PS3.16 DCM128623(128623, DCM, "Disapproved for use at the institution") or PS3.16 DCM128613(128613, DCM, "Eligible for reimbursement") or PS3.16 DCM128614(128614, DCM, "Eligible for reimbursement on per patient basis") or PS3.16 DCM128615(128615, DCM, "Ineligible for reimbursement").

  
  

Nested Class Summary

Nested Classes

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

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

VALUE_REPRESENTATION

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
InstitutionCodeSequence(org.dcm4che3.data.Sequence sequence)	Creates a new Institution Code Sequence object which wraps the provided sequence.

Method Summary

Modifier and Type	Method	Description
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 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

InstitutionCodeSequence

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

Creates a new Institution Code Sequence object which wraps the provided sequence.

Parameters:

sequence - The Sequence object to be linked.

Method Details

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in class SequenceWrapper<InstitutionCodeSequence,InstitutionCodeSequence.Item>

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in class SequenceWrapper<InstitutionCodeSequence,InstitutionCodeSequence.Item>

Returns:

The DICOM Tag of the wrapped DICOM sequence.