Package org.dcm4che.typeddicom.dataelements

Class ClinicalTrialSubjectID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ClinicalTrialSubjectID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class ClinicalTrialSubjectID
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Clinical Trial Subject ID
Keyword: ClinicalTrialSubjectID
Tag: (0012,0040)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Clinical Trial Subject Module > Clinical Trial Subject ID
  as follows:
  Attribute Name: Clinical Trial Subject ID
  Type: 1C
  Attribute Description:

  The assigned identifier for the clinical trial or research subject. See DICOM Standard Part 3 - Section C.7.1.3.1.6. Shall be present if Clinical Trial Subject Reading ID (0012,0042) is absent. May be present otherwise.

  
  
• Described in the contexts:
  • Patient Medical Module > Patient Clinical Trial Participation Sequence > Clinical Trial Subject ID
  as follows:
  Attribute Name: Clinical Trial Subject ID
  Type:
  Attribute Description:

  The assigned identifier for the Patient as a clinical trial or research subject.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClinicalTrialSubjectID.Builder<SELF extends ClinicalTrialSubjectID.Builder<SELF,T>,T extends ClinicalTrialSubjectID.Holder>
static interface	ClinicalTrialSubjectID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Clinical Trial Subject ID" (see ClinicalTrialSubjectID)
static class	ClinicalTrialSubjectID.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
ClinicalTrialSubjectID()	Creates a new Clinical Trial Subject ID object which wraps a new and empty Attributes object.
ClinicalTrialSubjectID(org.dcm4che3.data.Attributes attributes)	Creates a new Clinical Trial Subject ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ClinicalTrialSubjectID	copy()	Returns a new Clinical Trial Subject ID which wraps a copy of the Attributes wrapped in this Clinical Trial Subject ID.
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

ClinicalTrialSubjectID

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

Creates a new Clinical Trial Subject ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ClinicalTrialSubjectID

public ClinicalTrialSubjectID()

Creates a new Clinical Trial Subject ID object which wraps a new and empty Attributes object.

Method Details

copy

public ClinicalTrialSubjectID copy()

Returns a new Clinical Trial Subject ID which wraps a copy of the Attributes wrapped in this Clinical Trial Subject ID. (see Attributes(Attributes)

Returns:

a new Clinical Trial Subject ID which wraps a copy of the Attributes wrapped in this Clinical Trial Subject ID.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.