| Orders UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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. The order to suspend the original order is itself an order.In practice, the notion that one Order can affect another Order is useful only when both orders are maintained in the same system. If, in the above scenario, Dr. Smith's order for blood thinners is not in the same system that Dr. Jones is using, Dr. Smith's system will be unaware that the order was suspended. Therefore, this OrderAction mechanism will generally only be used when the original order is known to the system. Otherwise Dr. Jones' order would appear as a stand-alone order (e.g., "Stop taking Warfarin"). Later, the order to resume the Warfarin would be a new order from Dr. Jones, as if the previous order never existed. 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 | ||
DetectedIssueEvent | detectedIssueEvent |
Identifies any issues that were detected (aka Order Checks) during the creation of the Order Action. |
«TS» PointInTime | effectiveTime |
"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 |
"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 |
«CS» Code | kind |
Indicates the action that was ordered (e.g., New, Hold, Discontinue, etc.). 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."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." HL7 2.9, ORC-1. HL7 Table 119 contains 56 possible values for this field."Indicates the type of the request that is made, for example, to initiate an action, to suspend an ongoing activity, to discontinue an ongoing activity, or to cancel an existing request." - HL7 CIMI, Request.type"A code that identifies the specific service or action being asked to be done (or not done)." - HL7 FHIR, Request.code pattern. |
Order | order | |
«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 |
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 |
«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. |
OrderPatientEvent | trigger |
A patient-related event that automatically triggers an order action. For example, if the patient is scheduled for surgery, a particular Order Action might be placed on hold (i.e., "held") four hours before surgery. |
Attributes inherited from FHIM::Common::ClinicalStatement | ||
clinicalDataSource, contentVersion, contextCode, encounter, note, recordStatus, relatedClinicalInformation, sourceRecordType, sourceSystem, subjectGroup, subjectOfInformation, subjectOfRecord, temporalContext, topicCode, cosigned, recorded, signed, verified |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | OrderAction |
Name Expression | |
Namespace | Orders |
Owned Template Signature | |
Owner | Orders |
Owning Template Parameter | |
Package | Orders |
Qualified Name | FHIM::Orders::OrderAction |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public DetectedIssueEvent detectedIssueEvent
Identifies any issues that were detected (aka Order Checks) during the creation of the Order Action.
Aggregation | None |
Alias | |
Association | orderAction_detectedIssueEvent |
Association End | |
Class | OrderAction |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | detectedIssueEvent |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::detectedIssueEvent |
Stereotype | |
Template Parameter | |
Type | DetectedIssueEvent |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime effectiveTime
"Contains the date/time that the changes to the request took effect or are supposed to take effect...." - HL7 Version 2.8, ORC-15
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OrderAction |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | effectiveTime |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::effectiveTime |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OrderAction |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | enteringLocation |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::enteringLocation |
Stereotype | |
Template Parameter | |
Type | ServiceDeliveryLocation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code kind
Indicates the action that was ordered (e.g., New, Hold, Discontinue, etc.). 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."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." HL7 2.9, ORC-1. HL7 Table 119 contains 56 possible values for this field."Indicates the type of the request that is made, for example, to initiate an action, to suspend an ongoing activity, to discontinue an ongoing activity, or to cancel an existing request." - HL7 CIMI, Request.type"A code that identifies the specific service or action being asked to be done (or not done)." - HL7 FHIR, Request.code pattern.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OrderAction |
Terminologies | [ HL7_FHIR_R4 Procedure Codes (SNOMED CT) http://hl7.org/fhir/ValueSet/procedure-code , HL7_FHIR_R4 Service Request Order Details Codes http://hl7.org/fhir/ValueSet/servicerequest-orderdetail ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | kind |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::kind |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Order order
Aggregation | None |
Alias | |
Association | orderAction_order |
Association End | |
Class | OrderAction |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | order |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::order |
Stereotype | |
Template Parameter | |
Type | Order |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OrderAction |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | orderActionDate |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::orderActionDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OrderAction |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | orderingFacility |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::orderingFacility |
Stereotype | |
Template Parameter | |
Type | ServiceDeliveryLocation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OrderAction |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | releaseStatus |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::releaseStatus |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public OrderPatientEvent trigger
A patient-related event that automatically triggers an order action. For example, if the patient is scheduled for surgery, a particular Order Action might be placed on hold (i.e., "held") four hours before surgery.
Aggregation | None |
Alias | |
Association | orderAction_trigger |
Association End | |
Class | OrderAction |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | trigger |
Name Expression | |
Namespace | OrderAction |
Opposite | |
Owner | OrderAction |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Orders::OrderAction::trigger |
Stereotype | |
Template Parameter | |
Type | OrderPatientEvent |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Orders UML Documentation |
Summary:AttributesProperties | Detail:Attributes |