Package org.dcm4che.typeddicom.dataelements

Class SpecimenIdentifier

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SpecimenIdentifier

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class SpecimenIdentifier
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Specimen Identifier
Keyword: SpecimenIdentifier
Tag: (0040,0551)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Specimen Macro > Specimen Description Sequence > Specimen Identifier
  as follows:
  Attribute Name: Specimen Identifier
  Type: 1
  Attribute Description:

  A departmental information system identifier for the Specimen. See DICOM Standard Part 3 - Section C.7.6.22.1.1 and DICOM Standard Part 3 - Section C.7.6.22.1.2.

  If a single specimen is present in a container, the value of the Specimen Identifier and the value of the Container Identifier are typically the same.

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

  A departmental information system identifier for the Specimen.

  
  

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongStringWrapper

LongStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends LongStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SpecimenIdentifier()	Creates a new Specimen Identifier object which wraps a new and empty Attributes object.
SpecimenIdentifier(org.dcm4che3.data.Attributes attributes)	Creates a new Specimen Identifier object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SpecimenIdentifier	copy()	Returns a new Specimen Identifier which wraps a copy of the Attributes wrapped in this Specimen Identifier.
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, getPrivateCreator, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

SpecimenIdentifier

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

Creates a new Specimen Identifier object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SpecimenIdentifier

public SpecimenIdentifier()

Creates a new Specimen Identifier object which wraps a new and empty Attributes object.

Method Details

copy

public SpecimenIdentifier copy()

Returns a new Specimen Identifier which wraps a copy of the Attributes wrapped in this Specimen Identifier. (see Attributes(Attributes)

Returns:

a new Specimen Identifier which wraps a copy of the Attributes wrapped in this Specimen Identifier.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.