Package org.dcm4che.typeddicom.dataelements

Class RequestedProcedureID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RequestedProcedureID

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, ShortStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class RequestedProcedureID
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements ShortStringWrapper

Name: Requested Procedure ID
Keyword: RequestedProcedureID
Tag: (0040,1001)
Value Representation: ShortString
Value Multiplicity: 1

• Described in the contexts:
  • Request Macro > Requested Procedure ID
  as follows:
  Attribute Name: Requested Procedure ID
  Type: 1C
  Attribute Description:

  Identifier that identifies the Requested Procedure in the Imaging Service Request.

  Required if procedure was scheduled. May be present otherwise.

  Note

  The condition is to allow the contents of this Macro to be present (e.g., to convey the reason for the procedure, such as whether a mammogram is for screening or diagnostic purposes) even when the procedure was not formally scheduled and a value for this identifier is unknown, rather than making up a dummy value.

  
  
• Described in the contexts:
  • Requested Procedure Module > Requested Procedure ID
  as follows:
  Attribute Name: Requested Procedure ID
  Type:
  Attribute Description:

  Identifier that identifies the Requested Procedure in the Imaging Service Request.

  
  
• Described in the contexts:
  • Performed Procedure Step Relationship Module > Scheduled Step Attributes Sequence > Requested Procedure ID
  • Unified Procedure Step Relationship Module > Referenced Request Sequence > Requested Procedure ID
  as follows:
  Attribute Name: Requested Procedure ID
  Type:
  Attribute Description:

  Identifier of the related Requested Procedure.

  
  
• Described in the contexts:
  • Referenced Request Macro > Requested Procedure ID
  as follows:
  Attribute Name: Requested Procedure ID
  Type: 2
  Attribute Description:

  Identifier of the related Requested Procedure.

  
  

Nested Class Summary

Nested Classes

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

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

ShortStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends ShortStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RequestedProcedureID()	Creates a new Requested Procedure ID object which wraps a new and empty Attributes object.
RequestedProcedureID(org.dcm4che3.data.Attributes attributes)	Creates a new Requested Procedure ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RequestedProcedureID	copy()	Returns a new Requested Procedure ID which wraps a copy of the Attributes wrapped in this Requested Procedure ID.
java.lang.String	getPrivateCreator()
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, getValue

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

getValueRepresentation

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

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

RequestedProcedureID

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

Creates a new Requested Procedure ID object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

RequestedProcedureID

public RequestedProcedureID()

Creates a new Requested Procedure ID object which wraps a new and empty Attributes object.

Method Detail

copy

public RequestedProcedureID copy()

Returns a new Requested Procedure ID which wraps a copy of the Attributes wrapped in this Requested Procedure ID. (see Attributes(Attributes)

Returns:

a new Requested Procedure ID which wraps a copy of the Attributes wrapped in this Requested Procedure ID.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper