Package org.dcm4che.typeddicom.dataelements

Class ScheduledProcedureStepID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ScheduledProcedureStepID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class ScheduledProcedureStepID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Scheduled Procedure Step ID
Keyword: ScheduledProcedureStepID
Tag: (0040,0009)
Value Representation: SH
Value Multiplicity: 1

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

  Identifier that identifies the Scheduled Procedure Step.

  Required if procedure was scheduled.

  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 step was not formally scheduled and a value for this identifier is unknown, rather than making up a dummy value.

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

  Identifier that identifies the Scheduled Procedure Step.

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

  Identifier of the related Scheduled Procedure Step.

  
  

Nested Class Summary

Nested Classes

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

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

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

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.ShortStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ScheduledProcedureStepID	copy()	Returns a new Scheduled Procedure Step ID which wraps a copy of the Attributes wrapped in this Scheduled Procedure Step 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.ShortStringWrapper

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

ScheduledProcedureStepID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ScheduledProcedureStepID

public ScheduledProcedureStepID()

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

Method Details

copy

public ScheduledProcedureStepID copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.