Package org.dcm4che.typeddicom.dataelements

Class ClinicalTrialProtocolID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ClinicalTrialProtocolID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class ClinicalTrialProtocolID
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Clinical Trial Protocol ID
Keyword: ClinicalTrialProtocolID
Tag: (0012,0020)
Value Representation: LO
Value Multiplicity: 1

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

  Identifier of the clinical trial protocol for which use of the protocol is approved or disapproved.

  Note

  For experimental use this Attribute is used to identify the experiment.

  Required if Assertion Code Sequence (0044,0101) is PS3.16 DCM128604(128604, DCM, "Approved for use in the clinical trial") or PS3.16 DCM128624(128624, DCM, "Disapproved for use in the clinical trial") or PS3.16 DCM128611(128611, DCM, "Approved for experimental use") or PS3.16 DCM128612(128612, DCM, "Disapproved for experimental use").

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

  Identifier for the noted protocol. See DICOM Standard Part 3 - Section C.7.1.3.1.2.

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

  Identifier for the noted protocol .

  See DICOM Standard Part 3 - Section C.7.1.3.1.2.

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

  Identifier for the noted protocol, used by the Clinical Trial Sponsor to uniquely identify the investigational protocol.

  
  
• Described in the contexts:
  • Clinical Trial Study Module > Consent for Clinical Trial Use Sequence > Clinical Trial Protocol ID
  as follows:
  Attribute Name: Clinical Trial Protocol ID
  Type: 1C
  Attribute Description:

  The identifier of the protocol for which consent to distribute has been granted.

  Required if Distribution Type (0012,0084) is NAMED_PROTOCOL and the protocol is not that which is specified in Clinical Trial Protocol ID (0012,0020) in the DICOM Standard Part 3 - Section C.7.1.3.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ClinicalTrialProtocolID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ClinicalTrialProtocolID

public ClinicalTrialProtocolID()

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

Method Details

copy

public ClinicalTrialProtocolID copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.