Orders
Class OrderAction

A record of an action that has been taken on an order, which has the effect of changing the state (Act Status) of the Order. This class incorporates the notion that the act of changing an Order is itself a kind of Order. For example, Dr. Smith may order blood thinners to be administered to a patient, but Dr. Jones later suspends that order in preparation for an upcoming surgery. After the surgery, the order may then be resumed. Thus the order to suspend the original order is an order. This mechanism has the side effect of duplicating the authoring information for new orders - the author of the order is listed both in the Order instance and in the New Order Action instance which created the order. Implementations may choose mechanisms to avoid this duplication, but logically, we consider these two separate albeit simultaneous actions.
It is noted that this class is roughly equivalent to an ORC segment in HL7 version 2 where the Order Action code (ORC-1) reflects an event request (e.g., New, Suspend, Cancel).

Attributes
«CS» Code actionCategory actionCategory

Indicates the action that was ordered (e.g., New, Hold, Discontinue, etc),
"Determines the function of the order segment.... Depending on the message, the action of the control code may refer to an order or an individual service. For example, the code CA in an OMP message cancels the order. The same code in an RDS message, cancels the dispense. Very detailed explanatory notes are given at the end of this section." HL7 2.9, ORC-1. HL7 Table 119 contains 56 possible values for this field.
Note that the FHIM Order Action is equivalent to the ORC-1 action in only those situations where the order event is being requested (e.g., New, Suspend, Resume, Cancel). For other situations, such as acknowlegements between computer systems, the ORC-1 action has no equivelent in the FHIM.

ChartReview chartReview chartReview

Identifies a chart review that was performed on this Order Action.

String comment comment

Contains any remarks about the Order Action

DetectedIssueEvent detectedIssueEvent detectedIssueEvent

Identifies any issues that were detected (aka Order Checks) during the creation of the Order Action.

«TS» PointInTime effectiveDate effectiveDate

"Contains the date/time that the changes to the request took effect or are supposed to take effect...." - HL7 Version 2.8, ORC-15

ServiceDeliveryLocation enteringLocation enteringLocation

"Specifies the location (e.g., nurse station, ancillary service location, clinic, floor) where the person who entered the request was physically located when the order was entered. " - HL7 Version 2.8, ORC-13

«TS» PointInTime orderActionDate orderActionDate

"Contains the date and time of the event that initiated the current transaction as reflected in ORC-1 Order Control Code." - HL7 Version 2.8, ORC-9

ServiceDeliveryLocation orderingFacility orderingFacility

"This field contains the name of the facility placing the order." - HL7 Version 2.8, ORC-21
"This field contains the address of the facility placing the order." - HL7 Version 2.8, ORC-22
"This field contains the telephone number of the facility placing the order." - HL7 Version 2.8, ORC-23

«CS» Code reasonForAction reasonForAction

"This field contains a coded explanation of the reason for the order event described by the order control code " - HL7 Version 2.8, ORC-16

String reasonForActionNarrative reasonForActionNarrative

"This field contains the explanation (in text form) of the reason for the order event described by the order control code" - HL7 Version 2.8, ORC-16

«CS» Code releaseStatus releaseStatus

This optional field tracks the status of the order action within the ordering workflow. This is different from the order status. Valid values include: Unreleased, Pre-release, Rejected, Signature Needed, Co-signature needed, etc.

OrderPatientEvent trigger trigger

A patient-related event that automatically triggers an order action. For example, if the patient is scheduled for surgery, an particular Order Action might be placed on hold (i.e., "held") four hours before surgery.

Attributes inherited from FHIM::Common::_deprecated_ActionStatement FHIM::Common::_deprecated_ActionStatement
category category, currentStatus currentStatus, justification justification, supportingInformation supportingInformation

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contextCode contextCode, encounter encounter, temporalContext temporalContext, relatedClinicalInformation relatedClinicalInformation, topicCode topicCode, cosigned cosigned, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
comment comment, contentVersion contentVersion, identifier identifier, recordStatus recordStatus, sourceRecordType sourceRecordType, sourceSystem sourceSystem, recorded recorded, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameOrderAction
Name Expression
NamespaceOrders
Owned Template Signature
OwnerOrders
Owning Template Parameter
PackageOrders
Qualified NameFHIM::Orders::OrderAction
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 actionCategory
Public «CS» Code actionCategory

Indicates the action that was ordered (e.g., New, Hold, Discontinue, etc),
"Determines the function of the order segment.... Depending on the message, the action of the control code may refer to an order or an individual service. For example, the code CA in an OMP message cancels the order. The same code in an RDS message, cancels the dispense. Very detailed explanatory notes are given at the end of this section." HL7 2.9, ORC-1. HL7 Table 119 contains 56 possible values for this field.
Note that the FHIM Order Action is equivalent to the ORC-1 action in only those situations where the order event is being requested (e.g., New, Suspend, Resume, Cancel). For other situations, such as acknowlegements between computer systems, the ORC-1 action has no equivelent in the FHIM.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameactionCategory
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::actionCategory
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 chartReview
Public ChartReview chartReview

Identifies a chart review that was performed on this Order Action.

Constraints:
Properties:

AggregationNone
Alias
AssociationorderAction_chartReview
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamechartReview
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::chartReview
Stereotype
Template Parameter
TypeChartReview
Upper1
Upper Value(1)
VisibilityPublic


 comment
Public String comment

Contains any remarks about the Order Action

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namecomment
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::comment
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 detectedIssueEvent
Public DetectedIssueEvent detectedIssueEvent

Identifies any issues that were detected (aka Order Checks) during the creation of the Order Action.

Constraints:
Properties:

AggregationNone
Alias
AssociationorderAction_detectedIssueEvent
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedetectedIssueEvent
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::detectedIssueEvent
Stereotype
Template Parameter
TypeDetectedIssueEvent
Upper*
Upper Value(*)
VisibilityPublic


 effectiveDate
Public «TS» PointInTime effectiveDate

"Contains the date/time that the changes to the request took effect or are supposed to take effect...." - HL7 Version 2.8, ORC-15

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameeffectiveDate
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::effectiveDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 enteringLocation
Public ServiceDeliveryLocation enteringLocation

"Specifies the location (e.g., nurse station, ancillary service location, clinic, floor) where the person who entered the request was physically located when the order was entered. " - HL7 Version 2.8, ORC-13

Constraints:
Properties:

AggregationNone
Alias
AssociationorderAction_enteringLocation
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameenteringLocation
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::enteringLocation
Stereotype
Template Parameter
TypeServiceDeliveryLocation
Upper1
Upper Value(1)
VisibilityPublic


 orderActionDate
Public «TS» PointInTime orderActionDate

"Contains the date and time of the event that initiated the current transaction as reflected in ORC-1 Order Control Code." - HL7 Version 2.8, ORC-9

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameorderActionDate
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::orderActionDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 orderingFacility
Public ServiceDeliveryLocation orderingFacility

"This field contains the name of the facility placing the order." - HL7 Version 2.8, ORC-21
"This field contains the address of the facility placing the order." - HL7 Version 2.8, ORC-22
"This field contains the telephone number of the facility placing the order." - HL7 Version 2.8, ORC-23

Constraints:
Properties:

AggregationNone
Alias
AssociationorderAction_orderingFacility
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameorderingFacility
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::orderingFacility
Stereotype
Template Parameter
TypeServiceDeliveryLocation
Upper*
Upper Value(*)
VisibilityPublic


 reasonForAction
Public «CS» Code reasonForAction

"This field contains a coded explanation of the reason for the order event described by the order control code " - HL7 Version 2.8, ORC-16

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamereasonForAction
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::reasonForAction
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 reasonForActionNarrative
Public String reasonForActionNarrative

"This field contains the explanation (in text form) of the reason for the order event described by the order control code" - HL7 Version 2.8, ORC-16

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamereasonForActionNarrative
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::reasonForActionNarrative
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 releaseStatus
Public «CS» Code releaseStatus

This optional field tracks the status of the order action within the ordering workflow. This is different from the order status. Valid values include: Unreleased, Pre-release, Rejected, Signature Needed, Co-signature needed, etc.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamereleaseStatus
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::releaseStatus
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 trigger
Public OrderPatientEvent trigger

A patient-related event that automatically triggers an order action. For example, if the patient is scheduled for surgery, an particular Order Action might be placed on hold (i.e., "held") four hours before surgery.

Constraints:
Properties:

AggregationNone
Alias
AssociationorderAction_trigger
Association End
ClassOrderAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower1
Lower Value(1)
Multiplicity1
Nametrigger
Name Expression
NamespaceOrderAction
Opposite
OwnerOrderAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::OrderAction::trigger
Stereotype
Template Parameter
TypeOrderPatientEvent
Upper1
Upper Value(1)
VisibilityPublic