Orders
Class Promise

This abstract class contains those properties which are common to all Promise classes (e.g., LabPromise, PharmacyPromise, etc.). A Promise is an intent to perform a service that has the strength of a commitment, i.e., other parties may rely on the originator of such promise that said originator will see to it that the promised act will be fulfilled. A promise can be either solicited or unsolicited. The entity that makes such a promise is also called a "filler", while the entity that requests the service is also called a "placer". The Promise can be looked at as the Order from the filler's point of view.
"An order from the perspective of a fulfillment system." - HL7 CIMI, Promise

Attributes
«CS» Code chargeToPracticeCode chargeToPracticeCode

"This field is the charge to the ordering entity for the studies performed when applicable. The first component is a dollar amount when known by the filler. The second is a charge code when known by the filler (results only)" - HL7 Version 2.8, OBR-23. This property contains the charge code, if available.

«MO» MonetaryAmount chargeToPracticeCost chargeToPracticeCost

"This field is the charge to the ordering entity for the studies performed when applicable. The first component is a dollar amount when known by the filler. The second is a charge code when known by the filler (results only)." - HL7 Version 2.8, OBR-23. This property contains the dollar amount, if available.

«TS» PointInTime dateAccepted dateAccepted

The date/time on which the ordered service was accepted by the filler. In other words, the creation date of the Promise record.

«TS» PointInTime discontinueDate discontinueDate

The date (and optionally, time) upon which the order was canceled or otherwise invalidated by a clinician (who may or may not be the same clinician who created the order). A discontinue order has immediate effect – in contrast, an order for the patient to stop taking a medication in five days will generally be a modification to the end-date of the original order. Once an order has been discontinued, no more actions can be taken upon it. Depending on the system, the order to discontinue an existing order may be considered an order in its own right, or may be considered an order action.
HL7 CIMI, Promise.orderDiscontinueDate

«TS» PointInTime expectedAvailabilityDate expectedAvailabilityDate

"Specifies the date/time the filler expects the services to be available. For example when a prescription is ready for pickup or when a supply will be sent or picked up, or for when a laboratory result is expected to be available." - HL7 Version 2.8, ORC-27

«II» Id fillerOrderId fillerOrderId

A unique identifier of the order from the filling organization's point of view. Note that different terms have been historically been used for the filler order id in different domains. For example, in Pharmacy, the "filler order id" is typically called a "prescription number". Similarly in Lab, it is typically called an "accession number".
"This field is the order number associated with the filling application...." - HL7 Version 2.8, ORC-3 and OBR-3.
"This field is equivalent in uniqueness to the pharmacy/treatment supplier filler order number. At some sites, this may be the pharmacy/treatment supplier (internal) sequential form. At other sites, this may be an external number." - HL7 Version 2.8, RXD-7.

«CS» Code fillerSupplementalInfo fillerSupplementalInfo

"Contains supplemental service information sent from the filler system to the placer system for the procedure code reported in OBR-4 Universal Service ID. This field will be used to report ordering information detail that is not available in other specific fields in the OBR segment. Typically it will reflect the same information as was sent to the filler system in OBR-46-Placer supplemental service information unless the order was modified, in which case the filler system will report what was actually performed using this field...." - HL7 Version 2.8, OBR-47.

Order healthcareOrder healthcareOrder

Points to the Healthcare Order in response to which the Healthcare Promise was created. 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.
"The order that is partly or wholly enacted by the performance of this act." - HL7 CIMI, Promise.fulfillsOrder

«CS» Code orderModality orderModality

The method by which the ordering clinician (or the ordering system on behalf of the ordering clinician) communicated the order to the fulfilling person or organization (or the fulfilling system on behalf of the fulfilling person or organization). Examples include: Duplicate (i.e., an error), Electronically Entered, Policy, Service Correction, Telephoned, Verbal, Written, etc.

"Code indicating the origin of the prescription." - NCPDP Telecommunication (Field 419-DJ, Data Dictionary 201104). Possible values include: Written; Telephone; Electronic; Facsimile; Pharmacy; Not Known.
HL7 CIMI, Promise.orderModality

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

"Describes the urgency of the request. If this field is blank, the default is [Routine]" - HL7 Version 2.8, TQ1-9. Possible values include (from HL7 Table 122): Stat; ASAP; Routine; Preop; Callback; Timing critical*; As needed. *Note that the Timing Critical has a syntax that allows more information, e.g., Timing Critical within 15 minutes.

Organization promisingOrganization promisingOrganization

Identifies the Organization to which the Healthcare Order was sent for performance. Used to identify the performing 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 contain Quest Diagnostics.

«TS» PointInTime scheduledDateTime scheduledDateTime

"The date/time the filler scheduled an observation, when applicable (e.g., action code in OBR-11-specimen action code = "S"). This is a result of a request to schedule a particular test and provides a way to inform the placer of the date/time a study is scheduled (result only)." - HL7 Version 2.8, OBR.36

«CS» Code status status

"Contains the status of results for this order." - HL7 Version 2.8, OBR-25

«TS» PointInTime statusChangeDateTime statusChangeDateTime

"Specifies the date/time when the results were reported or status changed. This conditional field is required whenever [Report Status] is valued. This field is used to indicate the date and time that the results are composed into a report and released, or that [Healthcare Order status] is entered or changed." - HL7 Version 2.8, OBR-22.

«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

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
NamePromise
Name Expression
NamespaceOrders
Owned Template Signature
OwnerOrders
Owning Template Parameter
PackageOrders
Qualified NameFHIM::Orders::Promise
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 chargeToPracticeCode
Public «CS» Code chargeToPracticeCode

"This field is the charge to the ordering entity for the studies performed when applicable. The first component is a dollar amount when known by the filler. The second is a charge code when known by the filler (results only)" - HL7 Version 2.8, OBR-23. This property contains the charge code, if available.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamechargeToPracticeCode
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::chargeToPracticeCode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 chargeToPracticeCost
Public «MO» MonetaryAmount chargeToPracticeCost

"This field is the charge to the ordering entity for the studies performed when applicable. The first component is a dollar amount when known by the filler. The second is a charge code when known by the filler (results only)." - HL7 Version 2.8, OBR-23. This property contains the dollar amount, if available.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamechargeToPracticeCost
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::chargeToPracticeCost
Stereotype
Template Parameter
Type«MO» MonetaryAmount
Upper1
Upper Value(1)
VisibilityPublic


 dateAccepted
Public «TS» PointInTime dateAccepted

The date/time on which the ordered service was accepted by the filler. In other words, the creation date of the Promise record.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamedateAccepted
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::dateAccepted
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 discontinueDate
Public «TS» PointInTime discontinueDate

The date (and optionally, time) upon which the order was canceled or otherwise invalidated by a clinician (who may or may not be the same clinician who created the order). A discontinue order has immediate effect – in contrast, an order for the patient to stop taking a medication in five days will generally be a modification to the end-date of the original order. Once an order has been discontinued, no more actions can be taken upon it. Depending on the system, the order to discontinue an existing order may be considered an order in its own right, or may be considered an order action.
HL7 CIMI, Promise.orderDiscontinueDate

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamediscontinueDate
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::discontinueDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 expectedAvailabilityDate
Public «TS» PointInTime expectedAvailabilityDate

"Specifies the date/time the filler expects the services to be available. For example when a prescription is ready for pickup or when a supply will be sent or picked up, or for when a laboratory result is expected to be available." - HL7 Version 2.8, ORC-27

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NameexpectedAvailabilityDate
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::expectedAvailabilityDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 fillerOrderId
Public «II» Id fillerOrderId

A unique identifier of the order from the filling organization's point of view. Note that different terms have been historically been used for the filler order id in different domains. For example, in Pharmacy, the "filler order id" is typically called a "prescription number". Similarly in Lab, it is typically called an "accession number".
"This field is the order number associated with the filling application...." - HL7 Version 2.8, ORC-3 and OBR-3.
"This field is equivalent in uniqueness to the pharmacy/treatment supplier filler order number. At some sites, this may be the pharmacy/treatment supplier (internal) sequential form. At other sites, this may be an external number." - HL7 Version 2.8, RXD-7.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamefillerOrderId
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::fillerOrderId
Stereotype
Template Parameter
Type«II» Id
Upper1
Upper Value(1)
VisibilityPublic


 fillerSupplementalInfo
Public «CS» Code fillerSupplementalInfo

"Contains supplemental service information sent from the filler system to the placer system for the procedure code reported in OBR-4 Universal Service ID. This field will be used to report ordering information detail that is not available in other specific fields in the OBR segment. Typically it will reflect the same information as was sent to the filler system in OBR-46-Placer supplemental service information unless the order was modified, in which case the filler system will report what was actually performed using this field...." - HL7 Version 2.8, OBR-47.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamefillerSupplementalInfo
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::fillerSupplementalInfo
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 healthcareOrder
Public Order healthcareOrder

Points to the Healthcare Order in response to which the Healthcare Promise was created. 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.
"The order that is partly or wholly enacted by the performance of this act." - HL7 CIMI, Promise.fulfillsOrder

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcarePromise_healthcareOrder
Association End
ClassPromise
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
NamehealthcareOrder
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::healthcareOrder
Stereotype
Template Parameter
TypeOrder
Upper1
Upper Value(1)
VisibilityPublic


 orderModality
Public «CS» Code orderModality

The method by which the ordering clinician (or the ordering system on behalf of the ordering clinician) communicated the order to the fulfilling person or organization (or the fulfilling system on behalf of the fulfilling person or organization). Examples include: Duplicate (i.e., an error), Electronically Entered, Policy, Service Correction, Telephoned, Verbal, Written, etc.

"Code indicating the origin of the prescription." - NCPDP Telecommunication (Field 419-DJ, Data Dictionary 201104). Possible values include: Written; Telephone; Electronic; Facsimile; Pharmacy; Not Known.
HL7 CIMI, Promise.orderModality

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
Datatype
Default(OrderModality)
Default Value((OrderModality))
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
NameorderModality
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::orderModality
Stereotype
Template Parameter
Type«CS» Code
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
AssociationhealthcarePromise_precautionProtocolInvoked
Association End
ClassPromise
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
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::precautionProtocolInvoked
Stereotype
Template Parameter
TypePrecautionProtocol
Upper*
Upper Value(*)
VisibilityPublic


 priority
Public «CS» Code priority

"Describes the urgency of the request. If this field is blank, the default is [Routine]" - HL7 Version 2.8, TQ1-9. Possible values include (from HL7 Table 122): Stat; ASAP; Routine; Preop; Callback; Timing critical*; As needed. *Note that the Timing Critical has a syntax that allows more information, e.g., Timing Critical within 15 minutes.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::priority
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 promisingOrganization
Public Organization promisingOrganization

Identifies the Organization to which the Healthcare Order was sent for performance. Used to identify the performing 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 contain Quest Diagnostics.

Constraints:
Properties:

AggregationNone
Alias
AssociationhealthcareOrder_promisingLocation
Association End
ClassPromise
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
NamepromisingOrganization
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::promisingOrganization
Stereotype
Template Parameter
TypeOrganization
Upper1
Upper Value(1)
VisibilityPublic


 scheduledDateTime
Public «TS» PointInTime scheduledDateTime

"The date/time the filler scheduled an observation, when applicable (e.g., action code in OBR-11-specimen action code = "S"). This is a result of a request to schedule a particular test and provides a way to inform the placer of the date/time a study is scheduled (result only)." - HL7 Version 2.8, OBR.36

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamescheduledDateTime
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::scheduledDateTime
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 status
Public «CS» Code status

"Contains the status of results for this order." - HL7 Version 2.8, OBR-25

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 statusChangeDateTime
Public «TS» PointInTime statusChangeDateTime

"Specifies the date/time when the results were reported or status changed. This conditional field is required whenever [Report Status] is valued. This field is used to indicate the date and time that the results are composed into a report and released, or that [Healthcare Order status] is entered or changed." - HL7 Version 2.8, OBR-22.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPromise
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
NamestatusChangeDateTime
Name Expression
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::statusChangeDateTime
Stereotype
Template Parameter
Type«TS» PointInTime
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
ClassPromise
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
NamespacePromise
Opposite
OwnerPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Orders::Promise::statusModifier
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic