Package org.dcm4che.typeddicom.dataelements

Class PatientSpeciesCodeSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

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

org.dcm4che.typeddicom.dataelements.PatientSpeciesCodeSequence

All Implemented Interfaces:

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

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

Name: Patient Species Code Sequence
Keyword: PatientSpeciesCodeSequence
Tag: (0010,2202)
Value Representation: SQ
Value Multiplicity: 1

• Described in the contexts:
  • Patient Demographic Module > Patient Species Code Sequence
  as follows:
  Attribute Name: Patient Species Code Sequence
  Type:
  Attribute Description:

  The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. See DICOM Standard Part 3 - Section C.7.1.1.1.3.

  Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Patient Module > Patient Species Code Sequence
  as follows:
  Attribute Name: Patient Species Code Sequence
  Type: 1C
  Attribute Description:

  The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. See DICOM Standard Part 3 - Section C.7.1.1.1.3.

  Only a single Item shall be included in this Sequence.

  Required if the Patient is an animal and if Patient Species Description (0010,2201) is not present. May be present otherwise.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PatientSpeciesCodeSequence.Builder<SELF extends PatientSpeciesCodeSequence.Builder<SELF,T>,T extends PatientSpeciesCodeSequence.Holder>
static interface	PatientSpeciesCodeSequence.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Patient Species Code Sequence" (see PatientSpeciesCodeSequence)
static class	PatientSpeciesCodeSequence.Item
static class	PatientSpeciesCodeSequence.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
PatientSpeciesCodeSequence(org.dcm4che3.data.Sequence sequence)	Creates a new Patient Species 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

PatientSpeciesCodeSequence

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

Creates a new Patient Species 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<PatientSpeciesCodeSequence,PatientSpeciesCodeSequence.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<PatientSpeciesCodeSequence,PatientSpeciesCodeSequence.Item>

Returns:

The DICOM Tag of the wrapped DICOM sequence.