Class Order

This class represents those properties which are common to all orders. This class is "owned" by the Common package so as to avoid package interdependencies. Information that is specific to given order types (e.g., Lab, Pharmacy) are contained in subtypes to this class. These subtype classes are in the the respective domain packages (e.g., the LabRequest class is in the Lab package).

Attributes
«CS» Code advanceBeneficiaryNoticeCode advanceBeneficiaryNoticeCode

"This field indicates the status of the patient's or the patient's representative's consent for responsibility to pay for potentially uninsured services. This element is introduced to satisfy CMS Medical Necessity requirements for outpatient services. This element indicates (a) whether the associated diagnosis codes for the service are subject to medical necessity procedures, (b) whether, for this type of service, the patient has been informed that they may be responsible for payment for the service, and (c) whether the patient agrees to be billed for this service" - HL7 Version 2.8, ORC-20

«TS» PointInTime advanceBeneficiaryNoticeDate advanceBeneficiaryNoticeDate

"Contains the date the patient gave consent to pay for potentially uninsured services or the date that the Advanced Beneficiary Notice Code was collected." - HL7 Version 2.8, ORC-32.

String advanceBeneficiaryNoticeOverrideReason advanceBeneficiaryNoticeOverrideReason

"This field contains the reason why the patient did not sign an Advanced Beneficiary Notice." - HL7 Version 2.8, ORC-26

«II» Id alternatePlacerOrderId alternatePlacerOrderId

"This field enables a shorter number to be communicated that is unique within other identifiers." - HL7 Version 2.8, ORC-53.

ClinicalStatement basedOn basedOn

"The proposal that is partly or wholly fulfilled by the performance of this act." - HL7 CIMI Order.basedOn

BillingInformation billingInformation billingInformation

"Used to provide billing information, on the ordered service, to the filling application." - HL7 Version 2.8, BLG Segment.

«TEL» ContactPoint callbackPhone callbackPhone

"Contains the telephone number to call for clarification of a request or other information regarding the order." - HL7 Version 2.8, ORC-14.
"Contains the telephone number for reporting a status or a result" - HL7 Version 2.8, OBR-17.

«CS» Code confidentialityCode confidentialityCode

"This field contains information about the level of security and/or sensitivity surrounding the order (e.g., highly sensitive, not sensitive, sensitive, etc.)." - HL7 Version 2.8, ORC-28

«CS» Code dangerCode dangerCode

"Contains the code and/or text indicating any known or suspected patient or specimen hazards, e.g., patient with active tuberculosis or blood from a hepatitis patient." - HL7 Version 2.8, OBR-12.

«TS» PointInTime dateTimeBegin dateTimeBegin

This optional property is used by some types of orders which are requesting a repeating or continuous action to convey the first date (and optionally, time) upon which the action should occur. For example a clinician may order a drug to be administered in an inpatient stay. This drug might be administered every 4 hours beginning on a certain date/time. For one-time orders, such as an imaging request or most lab orders, this property is not used. Note that FHIR allows the data type to be a dateTime, a Period, or a Timing. When FHIR uses a dateTime, this property is the equivalent. When FHIR uses a Period, this property is the start time. When FHIR uses a Timing, this property is not used, rather the occurrenceTiming property should be used.

"This field may be specified by the requester, in which case it indicates the earliest date/time at which the services should be started. In many cases, however, the start date/time will be implied or will be defined by other fields in the service request record (e.g., urgency STAT). In such a case, this field will be empty. The filling service will often record a value in this field after receipt of the service request, however, and compute an end time on the basis of the start date/time for the filling service's internal use." - HL7 Version 2.8, TQ1-7
"The date or time(s) at which the activity or service is desired to occur." - HL7 FHIR, Request.occurrence[x]
"When the activity should start." - HL7 CIMI Order.startDateTime

«TS» PointInTime dateTimeCompleted dateTimeCompleted

The date/time this order is considered complete.

«TS» PointInTime dateTimeEnd dateTimeEnd

This optional property is used by some types of orders which are requesting a repeating or continuous action to convey the last date (and optionally, time) upon which the action should occur. For example a clinician may order a drug to be administered in an inpatient stay. This drug might be administered every 4 hours for three days. In this example, this property would contain the date/time three days after the begin date/time. For one-time orders, such as an imaging request or most lab orders, this property is not used. Note that FHIR allows the data type to be a dateTime, a Period, or a Timing. When FHIR uses a dateTime, this property is not used, as the single FHIR dateTime corresponds to the dateTimeStart property. When FHIR uses a Period, this property is the end time. When FHIR uses a Timing, this property is not used, rather the occurrenceTiming property should be used.

"When filled in by the requester of the service, this field should contain the latest date/time that the service should be performed. If it has not been performed by the specified time, it should not be performed at all. The requester may not always fill in this value, yet the filling service may fill it in on the basis of the instruction it receives and the actual start time. Regardless of the value of the end date/time, the service should be stopped at the earliest of the date/times specified by either the duration or the end date/time." - HL7 Version 2.8, TQ1-8
"The date or time(s) at which the activity or service is desired to occur." - HL7 FHIR, Request.occurrence[x]
"When the activity should end." - HL7 CIMI Order.stopDateTime

«TS» PointInTime dateTimeNeeded dateTimeNeeded

"Point in time when order must be performed." - HL7 CIMI Order.neededNoLaterThan

«TS» PointInTime dateTimeOrdered dateTimeOrdered

The date/time upon which the Order was authorized (signed) and released by the ordering provider.
"For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation." - HL7 FHIR, Request.authoredOn

"Date prescription was written." - NCPDP Telecommunication (Field 414-DE, Data Dictionary 201104).
"The date (and perhaps time) when the prescription was initially written or authored on." - HL7 FHIR, MedicationRequest.authoredOn

DiagnosisListEntry diagnosisList diagnosisList

A (set of) specific confirmed or suspected patient diagnosis associated with a Health Care Order indicating the health care basis for the Healthcare Order.

String duplicateProcedureReason duplicateProcedureReason

"This field is used to document why the procedure found in OBR-44 - Procedure Code is a duplicate of one ordered/charged previously for the same patient within the same date of service and has been determined to be medically necessary." - HL7 Version 2.8, OBR-48.

«EntryPoint» EncounterEvent encounter encounter

Pointer to the Encounter during which the Order was created.
"The encounter or episode of care that establishes the context for making this request." - HL7 FHIR, Request.context

"A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider." - HL7 FHIR, MedicationRequest.context

Participation expectedPerformer expectedPerformer

"Persons who are expected to or intended to perform this action, e.g., the person who will perform the surgery." - HL7 CIMI, Request.expectedPerformer

Promise healthcarePromise healthcarePromise

Points to the Healthcare Promises (if any) created in response to the Healthcare Order. Note that since both the HealthcareOrder and HealthcarePromise are abstract classes, this association is available to all subclasses, such that LabPromise would point to LabOrder, etc.

Boolean isEscortRequired isEscortRequired

Indicates whether "the patient needs to be escorted to the diagnostic service department." - HL7 Version 2.8, OBR-42

Boolean isInpatientOrder isInpatientOrder

"This field indicates whether the order is to be executed in an inpatient setting or an outpatient setting." - HL7 Version 2.8, ORC-29

Timing occurrenceTiming occurrenceTiming

This optional property is used by some types of orders to convey a series of occurrences upon which the action should take place. Note that FHIR has a single occurrence property which can be implemented using one of three data types: a dateTime, a Period, or a Timing. This FHIM property is the equivalent of the FHIR occurrence property utilizing the Timing datatype. The FHIM dateTimeStart and dateTimeEnd properties relate to the FHIR occurrence property using the dateTime or Period datatypes.
"The date or time(s) at which the activity or service is desired to occur." - HL7 FHIR, Request.occurrence[x]

OrderAction orderAction orderAction

A record of action has been taken on an order, including the signature and verification required to release to the service.

Organization orderingOrganization orderingOrganization

Identifies the Organization that created or orginated the Healthcare Order. Used to identify the ordering organization, especially when the ordering organization is different than the performing organization. For example if the VA orders a lab test from Quest Diagnostics, this field would identify the VA.
"This field identifies the organization that the enterer belonged to at the time he/she enters/maintains the order, such as medical group or department." - HL7 V2 ORC 17

ServiceDeliveryLocation patientLocation patientLocation

The physical location of the patient. This information is used to communicate to the performing Service where the Patient might be found, which is particularly important for services that involve the patient (e.g., a Lab Test ordered requires a blood draw).
"Specifies the location of the patient to whom the pharmaceutical substance is to be delivered." - HL7 Version 2.8, RXO-34.
"Specifies the address, either mailing or physical, to which the prescription should be mailed or delivered." - HL7 Version 2.8, RXO-35.

«II» Id placerOrderId placerOrderId

"This field is the placer application's order number." - HL7 Version 2.8, ORC-2
"This field is identical to ORC-2-Placer Order Number.... It identifies an order uniquely among all orders from a particular ordering application." - HL7 Version 2.8, OBR-2.

«CS» Code placerSupplementalInfo placerSupplementalInfo

"Contains supplemental service information sent from the placer system to the filler system for the universal procedure code reported in OBR-4 Universal Service ID. This field will be used to provide ordering information detail that is not available in other specific fields in the OBR segment." - HL7 Version 2.8, OBR-46.

String plannedPatientTransportComment plannedPatientTransportComment

Contains "comments on special requirements for the transport of the patient to the diagnostic service department." - HL7 Version 2.8, OBR-43

PrecautionProtocol precautionProtocolInvoked precautionProtocolInvoked

Pointer to a list of zero-to-many procedures that is invoked as a precaution to prevent harm to the patient, guests, or healthcare workers in response to a known situation where a potential danger may exist.

«CS» Code priority priority

"This field describes the urgency of the request. If this field is blank, the default is R" (Routine) - HL7 Version 2.8, TQ1-9
"Indicates how quickly the [request] should be addressed with respect to other requests." - HL7 FHIR, Request.priority
"Indicates how quickly the Medication Request should be addressed with respect to other requests." - HL7 FHIR, MedicationRequest.category
"How quickly the action must be initiated. Includes concepts such as stat, urgent, routine." - HL7 CIMI, Request.priority

«CS» Code reasonForStudy reasonForStudy

"This is required for some studies to obtain proper reimbursement." - HL7 Version 2.8, OBR-31. Used to link various tests or procedures together in order to provide a more complete picture of a patient's condition. Also used for billing purposes.

«CS» Code relevantClinicalInformation relevantClinicalInformation

"Contains the additional clinical information about the patient or specimen. This field is used to report the suspected diagnosis and clinical findings on requests for interpreted diagnostic studies. Examples include reporting the amount of inspired carbon dioxide for blood gasses, the point in the menstrual cycle for cervical pap tests, and other conditions that influence test interpretations." - HL7 Version 2.8, OBR-13. Possible values include (from HL7 Table 916): Patient was fasting prior to the procedure; The patient indicated they did not fast prior to the procedure; Not Given – Patient was not asked at the time of the procedure; Fasting not asked of the patient at time of procedure.

String remarks remarks

General textual comments about this Order.

PractitionerParticipation resultCopiesTo resultCopiesTo

"Identifies the people who are to receive copies of the results." - HL7 Version 2.8, OBR-28.

«CS» Code resultHandling resultHandling

"Information regarding the handling of the result. For example, an order may specify that the result (e.g., an x-ray film) should be given to the patient for return to the requestor.... If this field is not populated then routine handling is implied." - HL7 Version 2.8, OBR-49 Note that the HL7 V2 value set only contains values pertinent to Radiology (e.g., give film to patient). However, it is envisioned that other scenarios might be handled by this property. This property is optional.

SetOfOrders setOfOrders setOfOrders

An aggregation of Orders that are assembled so that they might be managed as a group. The member Orders will generally be for a single Patient, and commonly issued by a single Provider, but otherwise these orders will have no other inherent relationships between themselves. This concept is different from an Order Set, Panel, or Battery, in that the SetOfOrders is composed after the orders have been created; wheras the latter concepts are defined before the order is created.

StandingOrder standingOrder standingOrder

An order that is created by policy, and which is not tied to a single patient, but which is generated for a patient when certain conditions are met. For example, a policy might exist that persons deploying to a particular region must have a particular vaccination administered beforehand.

«CS» Code status status

A code specifying the current state of the Order. Valid status codes should reflect the HL7 state machine, e.g., Active, Held, Canceled, Aborted, New, Nullified, Obsolete.
"Specifies the status of an order.... The purpose of this field is to report the status of an order either upon request (solicited), or when the status changes (unsolicited). It does not initiate action. It is assumed that the order status always reflects the status as it is known to the sending application at the time that the message is sent. Only the filler can originate the value of this field." - HL7 Version 2.8, ORC-5
"The current state of the request." - HL7 FHIR, Request.status

«CS» Code statusModifier statusModifier

"This field is a modifier or refiner of the ORC-5-Order status field. This field may be used to provide additional levels of specificity or additional information for the defined order status codes." - HL7 Version 2.8, ORC-25

«CS» Code suggestedPrecaution suggestedPrecaution

This property indicates the kind of precaution(s) that the orderer suggests be taken in order to prevent transmission of infectious disease. Possible values include: blood-borne pathogen precaution, airborne pathogen precaution, droplet precaution, contact precautions, etc. This property categorizes the precaution protocol that ought to be invoked. The actual protocol invoked may be indicated in the PrecautionProtocol class. Note that a precaution will in some cases be ordered, in which case a separate instance of the HealthcareOrder would be created. This property is not intended to order a precaution but to suggest one that might be taken while fulfilling the subject order. For a system that implements a Boolean flag to indicate that the patient is to be in an isolation protocol, one approach would be to set that flag based on the content of this property.

«IVL_TS» TimeInterval timing timing

"The proposed timing for the request." - HL7 CIMI, Request.timing

String transportationArrangementResponsibility transportationArrangementResponsibility

Indicates "who is responsible for arranging transport to the planned diagnostic service. Examples: Requester, Provider, Patient." - HL7 Version 2.8, OBR-40.

«CS» Code transportationMode transportationMode

"Identifies how (or whether) to transport a patient, when applicable." - HL7 Version 2.8, OBR-30. Possible values include (from HL7 Table 124): Cart - patient travels on cart or gurney; The examining device goes to patient's location; Patient walks to diagnostic service; Wheelchair.

Boolean wasTransportArranged wasTransportArranged

Indicates "whether transport arrangements are known to have been made." - HL7 Version 2.8, OBR-41

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
contextCode contextCode, topicCode topicCode, encounter encounter, temporalContext temporalContext, clinicalDataSource clinicalDataSource, relatedClinicalInformation relatedClinicalInformation, 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
NameOrder
Name Expression
NamespaceOrders
Owned Template Signature
OwnerOrders
Owning Template Parameter
PackageOrders
Qualified NameFHIM::Orders::Order
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 advanceBeneficiaryNoticeCode
Public «CS» Code advanceBeneficiaryNoticeCode

"This field indicates the status of the patient's or the patient's representative's consent for responsibility to pay for potentially uninsured services. This element is introduced to satisfy CMS Medical Necessity requirements for outpatient services. This element indicates (a) whether the associated diagnosis codes for the service are subject to medical necessity procedures, (b) whether, for this type of service, the patient has been informed that they may be responsible for payment for the service, and (c) whether the patient agrees to be billed for this service" - HL7 Version 2.8, ORC-20

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameadvanceBeneficiaryNoticeCode
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::advanceBeneficiaryNoticeCode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 advanceBeneficiaryNoticeDate
Public «TS» PointInTime advanceBeneficiaryNoticeDate

"Contains the date the patient gave consent to pay for potentially uninsured services or the date that the Advanced Beneficiary Notice Code was collected." - HL7 Version 2.8, ORC-32.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameadvanceBeneficiaryNoticeDate
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::advanceBeneficiaryNoticeDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 advanceBeneficiaryNoticeOverrideReason
Public String advanceBeneficiaryNoticeOverrideReason

"This field contains the reason why the patient did not sign an Advanced Beneficiary Notice." - HL7 Version 2.8, ORC-26

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameadvanceBeneficiaryNoticeOverrideReason
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::advanceBeneficiaryNoticeOverrideReason
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 alternatePlacerOrderId
Public «II» Id alternatePlacerOrderId

"This field enables a shorter number to be communicated that is unique within other identifiers." - HL7 Version 2.8, ORC-53.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamealternatePlacerOrderId
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::alternatePlacerOrderId
Stereotype
Template Parameter
Type«II» Id
Upper1
Upper Value(1)
VisibilityPublic


 basedOn
Public ClinicalStatement basedOn

"The proposal that is partly or wholly fulfilled by the performance of this act." - HL7 CIMI Order.basedOn

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamebasedOn
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::basedOn
Stereotype
Template Parameter
TypeClinicalStatement
Upper1
Upper Value(1)
VisibilityPublic


 billingInformation
Public BillingInformation billingInformation

"Used to provide billing information, on the ordered service, to the filling application." - HL7 Version 2.8, BLG Segment.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_billingInformation
Association End
ClassOrder
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*
NamebillingInformation
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::billingInformation
Stereotype
Template Parameter
TypeBillingInformation
Upper*
Upper Value(*)
VisibilityPublic


 callbackPhone
Public «TEL» ContactPoint callbackPhone

"Contains the telephone number to call for clarification of a request or other information regarding the order." - HL7 Version 2.8, ORC-14.
"Contains the telephone number for reporting a status or a result" - HL7 Version 2.8, OBR-17.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamecallbackPhone
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::callbackPhone
Stereotype
Template Parameter
Type«TEL» ContactPoint
Upper1
Upper Value(1)
VisibilityPublic


 confidentialityCode
Public «CS» Code confidentialityCode

"This field contains information about the level of security and/or sensitivity surrounding the order (e.g., highly sensitive, not sensitive, sensitive, etc.)." - HL7 Version 2.8, ORC-28

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameconfidentialityCode
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::confidentialityCode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 dangerCode
Public «CS» Code dangerCode

"Contains the code and/or text indicating any known or suspected patient or specimen hazards, e.g., patient with active tuberculosis or blood from a hepatitis patient." - HL7 Version 2.8, OBR-12.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamedangerCode
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::dangerCode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeBegin
Public «TS» PointInTime dateTimeBegin

This optional property is used by some types of orders which are requesting a repeating or continuous action to convey the first date (and optionally, time) upon which the action should occur. For example a clinician may order a drug to be administered in an inpatient stay. This drug might be administered every 4 hours beginning on a certain date/time. For one-time orders, such as an imaging request or most lab orders, this property is not used. Note that FHIR allows the data type to be a dateTime, a Period, or a Timing. When FHIR uses a dateTime, this property is the equivalent. When FHIR uses a Period, this property is the start time. When FHIR uses a Timing, this property is not used, rather the occurrenceTiming property should be used.

"This field may be specified by the requester, in which case it indicates the earliest date/time at which the services should be started. In many cases, however, the start date/time will be implied or will be defined by other fields in the service request record (e.g., urgency STAT). In such a case, this field will be empty. The filling service will often record a value in this field after receipt of the service request, however, and compute an end time on the basis of the start date/time for the filling service's internal use." - HL7 Version 2.8, TQ1-7
"The date or time(s) at which the activity or service is desired to occur." - HL7 FHIR, Request.occurrence[x]
"When the activity should start." - HL7 CIMI Order.startDateTime

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamedateTimeBegin
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::dateTimeBegin
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeCompleted
Public «TS» PointInTime dateTimeCompleted

The date/time this order is considered complete.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamedateTimeCompleted
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::dateTimeCompleted
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeEnd
Public «TS» PointInTime dateTimeEnd

This optional property is used by some types of orders which are requesting a repeating or continuous action to convey the last date (and optionally, time) upon which the action should occur. For example a clinician may order a drug to be administered in an inpatient stay. This drug might be administered every 4 hours for three days. In this example, this property would contain the date/time three days after the begin date/time. For one-time orders, such as an imaging request or most lab orders, this property is not used. Note that FHIR allows the data type to be a dateTime, a Period, or a Timing. When FHIR uses a dateTime, this property is not used, as the single FHIR dateTime corresponds to the dateTimeStart property. When FHIR uses a Period, this property is the end time. When FHIR uses a Timing, this property is not used, rather the occurrenceTiming property should be used.

"When filled in by the requester of the service, this field should contain the latest date/time that the service should be performed. If it has not been performed by the specified time, it should not be performed at all. The requester may not always fill in this value, yet the filling service may fill it in on the basis of the instruction it receives and the actual start time. Regardless of the value of the end date/time, the service should be stopped at the earliest of the date/times specified by either the duration or the end date/time." - HL7 Version 2.8, TQ1-8
"The date or time(s) at which the activity or service is desired to occur." - HL7 FHIR, Request.occurrence[x]
"When the activity should end." - HL7 CIMI Order.stopDateTime

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamedateTimeEnd
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::dateTimeEnd
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeNeeded
Public «TS» PointInTime dateTimeNeeded

"Point in time when order must be performed." - HL7 CIMI Order.neededNoLaterThan

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamedateTimeNeeded
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::dateTimeNeeded
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeOrdered
Public «TS» PointInTime dateTimeOrdered

The date/time upon which the Order was authorized (signed) and released by the ordering provider.
"For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation." - HL7 FHIR, Request.authoredOn

"Date prescription was written." - NCPDP Telecommunication (Field 414-DE, Data Dictionary 201104).
"The date (and perhaps time) when the prescription was initially written or authored on." - HL7 FHIR, MedicationRequest.authoredOn

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamedateTimeOrdered
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::dateTimeOrdered
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 diagnosisList
Public DiagnosisListEntry diagnosisList

A (set of) specific confirmed or suspected patient diagnosis associated with a Health Care Order indicating the health care basis for the Healthcare Order.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_diagnosisList
Association End
ClassOrder
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*
NamediagnosisList
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::diagnosisList
Stereotype
Template Parameter
TypeDiagnosisListEntry
Upper*
Upper Value(*)
VisibilityPublic


 duplicateProcedureReason
Public String duplicateProcedureReason

"This field is used to document why the procedure found in OBR-44 - Procedure Code is a duplicate of one ordered/charged previously for the same patient within the same date of service and has been determined to be medically necessary." - HL7 Version 2.8, OBR-48.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameduplicateProcedureReason
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::duplicateProcedureReason
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 encounter
Public «EntryPoint» EncounterEvent encounter

Pointer to the Encounter during which the Order was created.
"The encounter or episode of care that establishes the context for making this request." - HL7 FHIR, Request.context

"A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider." - HL7 FHIR, MedicationRequest.context

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_encounter
Association End
ClassOrder
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
Nameencounter
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::encounter
Stereotype
Template Parameter
Type«EntryPoint» EncounterEvent
Upper1
Upper Value(1)
VisibilityPublic


 expectedPerformer
Public Participation expectedPerformer

"Persons who are expected to or intended to perform this action, e.g., the person who will perform the surgery." - HL7 CIMI, Request.expectedPerformer

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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*
NameexpectedPerformer
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::expectedPerformer
Stereotype
Template Parameter
TypeParticipation
Upper*
Upper Value(*)
VisibilityPublic


 healthcarePromise
Public Promise healthcarePromise

Points to the Healthcare Promises (if any) created in response to the Healthcare Order. Note that since both the HealthcareOrder and HealthcarePromise are abstract classes, this association is available to all subclasses, such that LabPromise would point to LabOrder, etc.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_healthcarePromise
Association End
ClassOrder
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*
NamehealthcarePromise
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::healthcarePromise
Stereotype
Template Parameter
TypePromise
Upper*
Upper Value(*)
VisibilityPublic


 isEscortRequired
Public Boolean isEscortRequired

Indicates whether "the patient needs to be escorted to the diagnostic service department." - HL7 Version 2.8, OBR-42

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameisEscortRequired
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::isEscortRequired
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isInpatientOrder
Public Boolean isInpatientOrder

"This field indicates whether the order is to be executed in an inpatient setting or an outpatient setting." - HL7 Version 2.8, ORC-29

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameisInpatientOrder
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::isInpatientOrder
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 occurrenceTiming
Public Timing occurrenceTiming

This optional property is used by some types of orders to convey a series of occurrences upon which the action should take place. Note that FHIR has a single occurrence property which can be implemented using one of three data types: a dateTime, a Period, or a Timing. This FHIM property is the equivalent of the FHIR occurrence property utilizing the Timing datatype. The FHIM dateTimeStart and dateTimeEnd properties relate to the FHIR occurrence property using the dateTime or Period datatypes.
"The date or time(s) at which the activity or service is desired to occur." - HL7 FHIR, Request.occurrence[x]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameoccurrenceTiming
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::occurrenceTiming
Stereotype
Template Parameter
TypeTiming
Upper1
Upper Value(1)
VisibilityPublic


 orderAction
Public OrderAction orderAction

A record of action has been taken on an order, including the signature and verification required to release to the service.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_orderAction
Association End
ClassOrder
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*
NameorderAction
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::orderAction
Stereotype
Template Parameter
TypeOrderAction
Upper*
Upper Value(*)
VisibilityPublic


 orderingOrganization
Public Organization orderingOrganization

Identifies the Organization that created or orginated the Healthcare Order. Used to identify the ordering organization, especially when the ordering organization is different than the performing organization. For example if the VA orders a lab test from Quest Diagnostics, this field would identify the VA.
"This field identifies the organization that the enterer belonged to at the time he/she enters/maintains the order, such as medical group or department." - HL7 V2 ORC 17

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_orderingLocation
Association End
ClassOrder
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
NameorderingOrganization
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::orderingOrganization
Stereotype
Template Parameter
TypeOrganization
Upper1
Upper Value(1)
VisibilityPublic


 patientLocation
Public ServiceDeliveryLocation patientLocation

The physical location of the patient. This information is used to communicate to the performing Service where the Patient might be found, which is particularly important for services that involve the patient (e.g., a Lab Test ordered requires a blood draw).
"Specifies the location of the patient to whom the pharmaceutical substance is to be delivered." - HL7 Version 2.8, RXO-34.
"Specifies the address, either mailing or physical, to which the prescription should be mailed or delivered." - HL7 Version 2.8, RXO-35.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_patientLocation
Association End
ClassOrder
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
NamepatientLocation
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::patientLocation
Stereotype
Template Parameter
TypeServiceDeliveryLocation
Upper1
Upper Value(1)
VisibilityPublic


 placerOrderId
Public «II» Id placerOrderId

"This field is the placer application's order number." - HL7 Version 2.8, ORC-2
"This field is identical to ORC-2-Placer Order Number.... It identifies an order uniquely among all orders from a particular ordering application." - HL7 Version 2.8, OBR-2.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameplacerOrderId
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::placerOrderId
Stereotype
Template Parameter
Type«II» Id
Upper1
Upper Value(1)
VisibilityPublic


 placerSupplementalInfo
Public «CS» Code placerSupplementalInfo

"Contains supplemental service information sent from the placer system to the filler system for the universal procedure code reported in OBR-4 Universal Service ID. This field will be used to provide ordering information detail that is not available in other specific fields in the OBR segment." - HL7 Version 2.8, OBR-46.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameplacerSupplementalInfo
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::placerSupplementalInfo
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 plannedPatientTransportComment
Public String plannedPatientTransportComment

Contains "comments on special requirements for the transport of the patient to the diagnostic service department." - HL7 Version 2.8, OBR-43

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameplannedPatientTransportComment
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::plannedPatientTransportComment
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 precautionProtocolInvoked
Public PrecautionProtocol precautionProtocolInvoked

Pointer to a list of zero-to-many procedures that is invoked as a precaution to prevent harm to the patient, guests, or healthcare workers in response to a known situation where a potential danger may exist.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_precautionProtocolInvoked
Association End
ClassOrder
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*
NameprecautionProtocolInvoked
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::precautionProtocolInvoked
Stereotype
Template Parameter
TypePrecautionProtocol
Upper*
Upper Value(*)
VisibilityPublic


 priority
Public «CS» Code priority

"This field describes the urgency of the request. If this field is blank, the default is R" (Routine) - HL7 Version 2.8, TQ1-9
"Indicates how quickly the [request] should be addressed with respect to other requests." - HL7 FHIR, Request.priority
"Indicates how quickly the Medication Request should be addressed with respect to other requests." - HL7 FHIR, MedicationRequest.category
"How quickly the action must be initiated. Includes concepts such as stat, urgent, routine." - HL7 CIMI, Request.priority

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
Namepriority
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::priority
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 reasonForStudy
Public «CS» Code reasonForStudy

"This is required for some studies to obtain proper reimbursement." - HL7 Version 2.8, OBR-31. Used to link various tests or procedures together in order to provide a more complete picture of a patient's condition. Also used for billing purposes.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamereasonForStudy
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::reasonForStudy
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 relevantClinicalInformation
Public «CS» Code relevantClinicalInformation

"Contains the additional clinical information about the patient or specimen. This field is used to report the suspected diagnosis and clinical findings on requests for interpreted diagnostic studies. Examples include reporting the amount of inspired carbon dioxide for blood gasses, the point in the menstrual cycle for cervical pap tests, and other conditions that influence test interpretations." - HL7 Version 2.8, OBR-13. Possible values include (from HL7 Table 916): Patient was fasting prior to the procedure; The patient indicated they did not fast prior to the procedure; Not Given – Patient was not asked at the time of the procedure; Fasting not asked of the patient at time of procedure.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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*
NamerelevantClinicalInformation
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::relevantClinicalInformation
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 remarks
Public String remarks

General textual comments about this Order.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
Nameremarks
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::remarks
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 resultCopiesTo
Public PractitionerParticipation resultCopiesTo

"Identifies the people who are to receive copies of the results." - HL7 Version 2.8, OBR-28.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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*
NameresultCopiesTo
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::resultCopiesTo
Stereotype
Template Parameter
TypePractitionerParticipation
Upper*
Upper Value(*)
VisibilityPublic


 resultHandling
Public «CS» Code resultHandling

"Information regarding the handling of the result. For example, an order may specify that the result (e.g., an x-ray film) should be given to the patient for return to the requestor.... If this field is not populated then routine handling is implied." - HL7 Version 2.8, OBR-49 Note that the HL7 V2 value set only contains values pertinent to Radiology (e.g., give film to patient). However, it is envisioned that other scenarios might be handled by this property. This property is optional.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NameresultHandling
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::resultHandling
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 setOfOrders
Public SetOfOrders setOfOrders

An aggregation of Orders that are assembled so that they might be managed as a group. The member Orders will generally be for a single Patient, and commonly issued by a single Provider, but otherwise these orders will have no other inherent relationships between themselves. This concept is different from an Order Set, Panel, or Battery, in that the SetOfOrders is composed after the orders have been created; wheras the latter concepts are defined before the order is created.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_setOfOrders
Association End
ClassOrder
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
NamesetOfOrders
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::setOfOrders
Stereotype
Template Parameter
TypeSetOfOrders
Upper1
Upper Value(1)
VisibilityPublic


 standingOrder
Public StandingOrder standingOrder

An order that is created by policy, and which is not tied to a single patient, but which is generated for a patient when certain conditions are met. For example, a policy might exist that persons deploying to a particular region must have a particular vaccination administered beforehand.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_standingOrder
Association End
ClassOrder
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
NamestandingOrder
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::standingOrder
Stereotype
Template Parameter
TypeStandingOrder
Upper1
Upper Value(1)
VisibilityPublic


 status
Public «CS» Code status

A code specifying the current state of the Order. Valid status codes should reflect the HL7 state machine, e.g., Active, Held, Canceled, Aborted, New, Nullified, Obsolete.
"Specifies the status of an order.... The purpose of this field is to report the status of an order either upon request (solicited), or when the status changes (unsolicited). It does not initiate action. It is assumed that the order status always reflects the status as it is known to the sending application at the time that the message is sent. Only the filler can originate the value of this field." - HL7 Version 2.8, ORC-5
"The current state of the request." - HL7 FHIR, Request.status

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
Namestatus
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 statusModifier
Public «CS» Code statusModifier

"This field is a modifier or refiner of the ORC-5-Order status field. This field may be used to provide additional levels of specificity or additional information for the defined order status codes." - HL7 Version 2.8, ORC-25

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamestatusModifier
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::statusModifier
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 suggestedPrecaution
Public «CS» Code suggestedPrecaution

This property indicates the kind of precaution(s) that the orderer suggests be taken in order to prevent transmission of infectious disease. Possible values include: blood-borne pathogen precaution, airborne pathogen precaution, droplet precaution, contact precautions, etc. This property categorizes the precaution protocol that ought to be invoked. The actual protocol invoked may be indicated in the PrecautionProtocol class. Note that a precaution will in some cases be ordered, in which case a separate instance of the HealthcareOrder would be created. This property is not intended to order a precaution but to suggest one that might be taken while fulfilling the subject order. For a system that implements a Boolean flag to indicate that the patient is to be in an isolation protocol, one approach would be to set that flag based on the content of this property.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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*
NamesuggestedPrecaution
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::suggestedPrecaution
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 timing
Public «IVL_TS» TimeInterval timing

"The proposed timing for the request." - HL7 CIMI, Request.timing

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
Nametiming
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::timing
Stereotype
Template Parameter
Type«IVL_TS» TimeInterval
Upper1
Upper Value(1)
VisibilityPublic


 transportationArrangementResponsibility
Public String transportationArrangementResponsibility

Indicates "who is responsible for arranging transport to the planned diagnostic service. Examples: Requester, Provider, Patient." - HL7 Version 2.8, OBR-40.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NametransportationArrangementResponsibility
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::transportationArrangementResponsibility
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 transportationMode
Public «CS» Code transportationMode

"Identifies how (or whether) to transport a patient, when applicable." - HL7 Version 2.8, OBR-30. Possible values include (from HL7 Table 124): Cart - patient travels on cart or gurney; The examining device goes to patient's location; Patient walks to diagnostic service; Wheelchair.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NametransportationMode
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::transportationMode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 wasTransportArranged
Public Boolean wasTransportArranged

Indicates "whether transport arrangements are known to have been made." - HL7 Version 2.8, OBR-41

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOrder
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
NamewasTransportArranged
Name Expression
NamespaceOrder
Opposite
OwnerOrder
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Order::wasTransportArranged
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic