ImagingProcedure (BICEPS 0.6.1-SNAPSHOT API)

java.lang.Object
- com.draeger.medical.biceps.common.model.ImagingProcedure

```
public class ImagingProcedure
extends Object
```
ImagingProcedure provides identifiers used by the DICOM and HL7 standard to identify the requested imaging procedures resulting from an order in a the hospital. Often these identifiers are created/assigned by the main hospital information system or departmental information systems and are taken over into any medical images by DICOM equipment in the context of this procedure. The listed ELEMENTs have been taken over from the IHE Radiology Technical Framework's RAD-4 transaction ("Procedure Scheduled") and re-uses the identifiers listed for the HL7 Version 2.5.1 IPC segment group of the OBR segment. Therefore, it is recommended to comply to the underlying HL7 and DICOM data types in order to have seamless integration with other clinical IT such as DICOM modalities or image archives (PACS). In order to comply to the hierarchy behind the given identifiers, the following rules (taken from IHE) SHALL apply: if a Requested Procedure is comprised of multiple Scheduled Procedure Steps and/or if a Scheduled Procedure Step is comprised of multiple Protocol Codes, each applicable Scheduled Procedure Step / Protocol Code combination shall be included as a separate ProcedureDetails structure, i.e., the complex type "ProcedureDetails" SHALL occur the same amount of times as there are different Scheduled Procedure Step IDs plus the amount of different Scheduled Procedure Step / Protocol Code combinations.
Java class for ImagingProcedure complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="ImagingProcedure">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://p11073-10207/draft6/ext/2016/12/08}Extension" minOccurs="0"/>
         <element name="AccessionIdentifier" type="{http://p11073-10207/draft6/pm/2016/12/08}InstanceIdentifier"/>
         <element name="RequestedProcedureId" type="{http://p11073-10207/draft6/pm/2016/12/08}InstanceIdentifier"/>
         <element name="StudyInstanceUid" type="{http://p11073-10207/draft6/pm/2016/12/08}InstanceIdentifier"/>
         <element name="ScheduledProcedureStepId" type="{http://p11073-10207/draft6/pm/2016/12/08}InstanceIdentifier"/>
         <element name="Modality" type="{http://p11073-10207/draft6/pm/2016/12/08}CodedValue" minOccurs="0"/>
         <element name="ProtocolCode" type="{http://p11073-10207/draft6/pm/2016/12/08}CodedValue" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected InstanceIdentifier`	`accessionIdentifier`
`protected ExtensionType`	`extension`
`protected CodedValue`	`modality`
`protected CodedValue`	`protocolCode`
`protected InstanceIdentifier`	`requestedProcedureID`
`protected InstanceIdentifier`	`scheduledProcedureStepID`
`protected InstanceIdentifier`	`studyInstanceUID`

Constructor Summary

Constructors
Constructor and Description

ImagingProcedure()

Constructors
Constructor and Description
`ImagingProcedure()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object that)`
`InstanceIdentifier`	`getAccessionIdentifier()` Gets the value of the accessionIdentifier property.
`ExtensionType`	`getExtension()` Gets the value of the extension property.
`CodedValue`	`getModality()` Gets the value of the modality property.
`CodedValue`	`getProtocolCode()` Gets the value of the protocolCode property.
`InstanceIdentifier`	`getRequestedProcedureID()` An pm:ImagingProcedure/pm:AccessionIdentifier can result in various Requested Procedures, each identified uniquely (within the context of the pm:ImagingProcedure/pm:AccessionIdentifier) through a RequestedProcedureID.
`InstanceIdentifier`	`getScheduledProcedureStepID()` Under a Study (i.e.
`InstanceIdentifier`	`getStudyInstanceUID()` The Study Instance UID is a world-wide unique identifier used by DICOM modalities to group together images in a so-called Study.
`int`	`hashCode()`
`void`	`setAccessionIdentifier(InstanceIdentifier value)` Sets the value of the accessionIdentifier property.
`void`	`setExtension(ExtensionType value)` Sets the value of the extension property.
`void`	`setModality(CodedValue value)` Sets the value of the modality property.
`void`	`setProtocolCode(CodedValue value)` Sets the value of the protocolCode property.
`void`	`setRequestedProcedureID(InstanceIdentifier value)` Sets the value of the requestedProcedureID property.
`void`	`setScheduledProcedureStepID(InstanceIdentifier value)` Sets the value of the scheduledProcedureStepID property.
`void`	`setStudyInstanceUID(InstanceIdentifier value)` Sets the value of the studyInstanceUID property.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - extension
```
protected ExtensionType extension
```
  - accessionIdentifier
```
protected InstanceIdentifier accessionIdentifier
```
  - requestedProcedureID
```
protected InstanceIdentifier requestedProcedureID
```
  - studyInstanceUID
```
protected InstanceIdentifier studyInstanceUID
```
  - scheduledProcedureStepID
```
protected InstanceIdentifier scheduledProcedureStepID
```
  - modality
```
protected CodedValue modality
```
  - protocolCode
```
protected CodedValue protocolCode
```
- Constructor Detail
  - ImagingProcedure
```
public ImagingProcedure()
```
- Method Detail
  - getExtension
```
public ExtensionType getExtension()
```
    Gets the value of the extension property.
    
    Returns:
    
    possible object is ExtensionType
  - setExtension
```
public void setExtension(ExtensionType value)
```
    Sets the value of the extension property.
    
    Parameters:
    
    value - allowed object is ExtensionType
  - getAccessionIdentifier
```
public InstanceIdentifier getAccessionIdentifier()
```
    Gets the value of the accessionIdentifier property.
    
    Returns:
    
    possible object is InstanceIdentifier
  - setAccessionIdentifier
```
public void setAccessionIdentifier(InstanceIdentifier value)
```
    Sets the value of the accessionIdentifier property.
    
    Parameters:
    
    value - allowed object is InstanceIdentifier
  - getRequestedProcedureID
```
public InstanceIdentifier getRequestedProcedureID()
```
    An pm:ImagingProcedure/pm:AccessionIdentifier can result in various Requested Procedures, each identified uniquely (within the context of the pm:ImagingProcedure/pm:AccessionIdentifier) through a RequestedProcedureID. A limit of sixteen (16) characters is required to allow compatibility with DICOM.
    
    Returns:
    
    possible object is InstanceIdentifier
  - setRequestedProcedureID
```
public void setRequestedProcedureID(InstanceIdentifier value)
```
    Sets the value of the requestedProcedureID property.
    
    Parameters:
    
    value - allowed object is InstanceIdentifier
  - getStudyInstanceUID
```
public InstanceIdentifier getStudyInstanceUID()
```
    The Study Instance UID is a world-wide unique identifier used by DICOM modalities to group together images in a so-called Study. This grouping is REQUIRED. Under the Study, the modality creates one or more so-called Series which again contain the images. The Series identification ("Series Instance UID") is part of the Procedure Details which refer to a planning process, since a modality is responsible to decide how many Series are created and how their identifiers should look like. A limit of sixty-four (64) characters is required to allow compatibility with DICOM, with only numbers and dot characters permitted (e.g. 1.2.134124.4.12.34).
    
    Returns:
    
    possible object is InstanceIdentifier
  - setStudyInstanceUID
```
public void setStudyInstanceUID(InstanceIdentifier value)
```
    Sets the value of the studyInstanceUID property.
    
    Parameters:
    
    value - allowed object is InstanceIdentifier
  - getScheduledProcedureStepID
```
public InstanceIdentifier getScheduledProcedureStepID()
```
    Under a Study (i.e. a Study Instance UID), a Procedure reflected by these ProcedureDetails can be planned in a finer granularity by scheduling different steps that should be performed (usually at a DICOM modality), the so-called "Scheduled Procedure Step"s. Each of these steps is identified by a Scheduled Procedure Step ID. A limit of sixteen (16) characters is required to allow compatibility with DICOM.
    
    Returns:
    
    possible object is InstanceIdentifier
  - setScheduledProcedureStepID
```
public void setScheduledProcedureStepID(InstanceIdentifier value)
```
    Sets the value of the scheduledProcedureStepID property.
    
    Parameters:
    
    value - allowed object is InstanceIdentifier
  - getModality
```
public CodedValue getModality()
```
    Gets the value of the modality property.
    
    Returns:
    
    possible object is CodedValue
  - setModality
```
public void setModality(CodedValue value)
```
    Sets the value of the modality property.
    
    Parameters:
    
    value - allowed object is CodedValue
  - getProtocolCode
```
public CodedValue getProtocolCode()
```
    Gets the value of the protocolCode property.
    
    Returns:
    
    possible object is CodedValue
  - setProtocolCode
```
public void setProtocolCode(CodedValue value)
```
    Sets the value of the protocolCode property.
    
    Parameters:
    
    value - allowed object is CodedValue
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ImagingProcedure

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extension

accessionIdentifier

requestedProcedureID

studyInstanceUID

scheduledProcedureStepID

modality

protocolCode

Constructor Detail

ImagingProcedure

Method Detail

getExtension

setExtension

getAccessionIdentifier

setAccessionIdentifier

getRequestedProcedureID

setRequestedProcedureID

getStudyInstanceUID

setStudyInstanceUID

getScheduledProcedureStepID

setScheduledProcedureStepID

getModality

setModality

getProtocolCode

setProtocolCode

toString

equals

hashCode