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
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.
advanceBeneficiaryNoticeOverrideReason"This field contains the reason why the patient did not sign an Advanced Beneficiary Notice." - HL7 Version 2.8, ORC-26
alternatePlacerOrderId"This field enables a shorter number to be communicated that is unique within other identifiers." - HL7 Version 2.8, ORC-53.
basedOn"The proposal that is partly or wholly fulfilled by the performance of this act." - HL7 CIMI, Order.basedOn
billingInformation"Used to provide billing information, on the ordered service, to the filling application." - HL7 Version 2.8, BLG Segment.
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.
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
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.
dateTimeBeginThis 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"When the activity should start." - HL7 CIMI Order.startDateTime"The date or time(s) at which the activity or service is desired to occur or not occur." - HL7 FHIR, Request.occurrence[x] pattern."The time when this communication is to occur." - HL7 FHIR, CommunicationRequest.occurrence[x]
dateTimeCompleted dateTimeEndThis 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"When the activity should end." - HL7 CIMI Order.stopDateTime"The date or time(s) at which the activity or service is desired to occur or not occur." - HL7 FHIR, Request.occurrence[x] pattern."The time when this communication is to occur." - HL7 FHIR, CommunicationRequest.occurrence[x]"The date (and perhaps time) when the prescription was stopped." - HL7 FHIR, MedicationOrder.dateEnded
dateTimeNeeded"Point in time when order must be performed." - HL7 CIMI Order.neededNoLaterThan
dateTimeOrderedThe date/time upon which the Order was authorized (signed) and released by the ordering provider."This is the date and time the order was released from OE/RR. If the TO service entered the order stub through the Add Order (AD) action, this is the service-specified request date." [FileMan 123,3]"The date/time the tubefeeding was ordered and will be effective." FileMan 115,1->115.01,40->115.04,.01"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"Contains the date/time that the changes to the request took effect or are supposed to take effect...." - HL7 Version 2.8, ORC-15"For draft [Request sub-types], indicates the date of initial creation. For requests with other statuses, indicates the date of activation." - HL7 FHIR, Request.authoredOn pattern."For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation." - HL7 FHIR, CommunicationRequest.authoredOn"The date (and perhaps time) when the prescription was initially written or authored on." - HL7 FHIR, MedicationRequest.authoredOn"Date prescription was written." - NCPDP Telecommunication (Field 414-DE, Data Dictionary 201104)."Date the prescription was written (authorized)" - ASAP Standard for PDMP, DSP03: Date Written
diagnosisListA (set of) specific confirmed or suspected patient diagnosis associated with a Health Care Order indicating the health care basis for the Healthcare Order."This field is used to report the ICD-10 code. If required by a PDMP, this field would be populated only when the ICD-10 code is included with the prescription." - ASAP Standard for PDMP, DSP25: Diagnosis Code
doNotPerform"If true indicates that the [Request sub-type] is asking for the specified action to not occur." - HL7 FHIR, Request.doNotPerform pattern."If true indicates that the CommunicationRequest is asking for the specified action to not occur." - HL7 FHIR, CommunicationRequest.doNotPerformNote that this property is included for compatibility with FHIR. In the FHIM, this instruction would be handled by using ActionProposedAgainst.
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.
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
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"Indicates who or what is being asked to perform (or not perform) the [Request sub-type]." - HL7 FHIR, Request.performer pattern.
expectedPerformerType"The type of individual that is desired to act upon / not act upon the [Request sub-type]." - HL7 FHIR, Request.performerType pattern.
isEscortRequiredIndicates whether "the patient needs to be escorted to the diagnostic service department." - HL7 Version 2.8, OBR-42
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
occurrenceTimingThis 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 or not occur." - HL7 FHIR, Request.occurrence[x] pattern.
orderActionA record of action has been taken on an order, including the signature and verification required to release to the service.
orderingFacilityThe institution/hospital (File 4) that is requesting the consult. This field is mandatory if the consult/ request is being sent to another hospital/institution, so that routing information can be obtained in order to return the results to the sending hospital/institution."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
orderingOrganizationThe 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.
orderingProvider"Information about the ordering of the action such as who made the request, when the request was made, how it was made, etc..." - HL7 CIMI, Request.requested"Who initiated the [Request sub-type] and has responsibility for its activation." - HL7 FHIR, Request.requester pattern."The device, individual, or organization who initiated the request and has responsibility for its activation." - HL7 FHIR, CommunicationRequest.requester
patientInstructions"Identifies the ordering provider's instructions to the patient or to the provider on how to deliver or comply with the ordered procedure." - HL7 CIMI, Order.patientInstructions
patientLocationThe 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).Pointer to the location of the patient when the consult/request order was placed. [FileMan 123,.04]"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."Code indicating where patient is located when receiving pharmacy services" - ASAP Standard for PDMP, PAT21: Patient Location Code. Possible values include: Home; Intermediary care; Nursing home; Long-term/extended care; Rest home; Boarding home; Skilled-care facility; Sub-acute care facility; Acute-care facility; Outpatient; Hospice; Unknown; or Other.
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."This field should be populated with the Initiator Reference Number from field UIB-030-01 in the SCRIPT transaction." - ASAP Standard for PDMP, DSP20: Electronic Prescription Reference Number"This field will be populated with the Initiator Control Reference from field UIH-030-01 in the SCRIPT standard." - ASAP Standard for PDMP, DSP21: Electronic Prescription Order Number
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.
plannedPatientTransportCommentContains "comments on special requirements for the transport of the patient to the diagnostic service department." - HL7 Version 2.8, OBR-43
precautionProtocolInvokedPointer 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.
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"How quickly the action must be initiated. Includes concepts such as stat, urgent, routine." - HL7 CIMI, Request.priority"Indicates how quickly the [Request sub-type] should be addressed with respect to other requests." - HL7 FHIR, Request.priority pattern."Indicates how quickly the Medication Request should be addressed with respect to other requests." - HL7 FHIR, MedicationRequest.category
promisePoints 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.
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.
releaseStatusThis 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.
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.
resultCopiesTo"Identifies the people who are to receive copies of the results." - HL7 Version 2.8, OBR-28.
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.
setOfOrdersAn 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.
standingOrderAn 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.
statusA 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 sub-type]." - HL7 FHIR, Request.status pattern.
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
suggestedPrecautionThis 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.
transportationArrangementResponsibilityIndicates "who is responsible for arranging transport to the planned diagnostic service. Examples: Requester, Provider, Patient." - HL7 Version 2.8, OBR-40.
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.
wasTransportArrangedIndicates "whether transport arrangements are known to have been made." - HL7 Version 2.8, OBR-41
FHIM::Common::ActionStatement