Pharmacy
Class PharmacyPromise

This class contains information about a Pharmacy Order, commonly referred to as a prescription. This class represents the prescription from the perspective of the filling system (i.e., the pharmacy) whereas the Pharmacy Request represents the prescription from the ordering system (i.e., the prescriber). This class is a subtype of the more general Healthcare Promise, which describes properties common to all types or Orders from the filling system perspective– this class adds those properties which are specific to medication orders. This class is called Pharmacy Promise rather than Pharmacy Order following the HL7 V3 convention to use the term Promise to indicate that it is from the filling system’s perspective. There are many properties which are identical to the Order; this is because the pharmacy may change the order, within prescribed limits, for example substituting a generic drug for a brand-named one.

Attributes
«TS» PointInTime appointmentTime appointmentTime

Date and time of the appointment for this clinic location.

PharmacyDispense dispense dispense

Pointer to information about the provision of a medication to a Patient or care provider under the authority of the owning Pharmacy Promise. In other words, this is a collection of dispensing events associated with the (pharmacy systems's view of the ) Order.

Dosage dosage dosage

Pointer to information used to describe how the medication should be taken by the Patient, as described by the Pharmacist (the pharmacist can change the ordered dosage under certain circumstances).

«TS» PointInTime expirationDate expirationDate

The date after which the order may no longer be filled.

PractitionerParticipation finisher finisher

A pharmacy personnel who reviews the order and makes any required changes that are allowed under the usual and customary boundaries. The end result of this activity is an order that can be fulfilled. This role also called verifier, or perfecter.

Boolean isHospitalSuppliedSelfAdministered isHospitalSuppliedSelfAdministered

A flag indicating that the medication given to the patient is to be self administered and is to be supplied by the hospitals pharmacy while they are an inpatient.

Boolean isSelfAdministered isSelfAdministered

A flag indicating that the medication given to the patient is to be self administered.

«TS» PointInTime lastDispenseDate lastDispenseDate

The most recent date (and optionally time) that the medication was distributed to a patient, patient care-giver, or the location at which the patient is receiving care.
"Date/time of the most recent refill or dose dispensed." - HL7 Version 2.8, RXE-18.

Boolean needsHumanReview needsHumanReview

This optional property is included for compatibility with HL7 version 2. It is used in version 2 messaging to convey that a warning is present in the dispensing instructions field and that downstream applications are expected to alert the human user to the presence of the warning.
"Yes - Indicates that a warning is present. The application receiving the encoded order needs to warn the person administering the drug or treatment to pay attention to the text in RXE-21-pharmacy/treatment special dispensing instructions. No - Indicates no warning " - HL7 Version 2.8, RXE-20.

Integer numberOfRefillsOrDosesDispensed numberOfRefillsOrDosesDispensed

"Number of refills remaining." - HL7 Version 2.8, RXE-17 (Number of Refills/Doses Dispensed).

Integer numberOfRefillsRemaining numberOfRefillsRemaining

Indicates the number of times the order may be filled without additional authorization. It is calculated by substracting the number of fills already completed from the number of fills authorized by the prescriber.
"This field is conditional because it is required when a prescription is dispensed to an outpatient. It is not relevant to inpatient treatment orders." - HL7 Version 2.8, RXD-8.
"Number of refills remaining." - HL7 Version 2.8, RXE-16 (Number of Refills Remaining).

PatientReportedMedication patientReportedMedication patientReportedMedication

Pointer to information about medication(s) which the patient reports to be using.

Pharmacy pharmacy pharmacy

"Specifies the pharmacy that will dispense or has dispensed the prescription." - HL7 Version 2.8, RXO-32.
"Specifies the address of the dispensing facility." - HL7 Version 2.8, RXO-33.
"Contains the telecommunication contact information for the pharmacy." - HL7 Version 2.8, RXO-36.

PharmacyGeneratedOrderModification pharmacyGeneratedOrderModification pharmacyGeneratedOrderModification

Pointer to information concerning any changes made to the original order by the pharmacist.
"Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done." - HL7 FHIR, MedicationDispense.substitution

DiagnosisListEntry pharmacyInferredDiagnosis pharmacyInferredDiagnosis

Many claims require a diagnosis in order to be adjudicated, especially in workers compensation situations or where multiple payers are involved. In those cases and where the pharmacy does not have a diagnosis supplied by the prescriber, the pharmacy may infer a diagnosis based on the medication or services ordered. See field 6813 of the NCPDP SCRIPT DRU segment.

OrderablePharmacyItem promisedItem promisedItem

Pointer to the medication or pharmacy-stocked item that the Pharmacy has agreed to supply to the Patient. This will normally be the same as the one ordered by the prescriber, but may be different under certain pre-defined conditions. For example, the provider may have ordered a brand-name drug, but indicated that a generic substitution is authorized, and the pharmacy may have substituted a generic drug. Other situations include changes due to inventory at hand, for example the prescriber may have ordered 10 mg tablets, but only 5 mg tablets were available.
"Identifies the medical substance or treatment that has been ordered to be given to the patient, as encoded by the pharmacy or treatment supplier" - HL7 Version 2.8, RXE-2.
"This field accommodates the identification of any codes that might be associated with the pharmaceutical substance. Common codes include: the Generic Product Identifier (GPI), Generic Code Number_Sequence Number (GCN_SEQNO), National Drug Code (NDC)." - HL7 Version 2.8, RXE-31.

«IVL_TS» Period requestedAdministrationTime requestedAdministrationTime

Specifies when the service is to be performed and how frequently. Note that this is a complex data type that may indicate specific times or intervals (e.g., 10:00 AM, MWF, etc).

«PQ» TimeQuantity requestedDuration requestedDuration

The duration of an order as requested by the ordering clinician. The duration would be expressed as a number of days, weeks, hours, etc. Note that this length of time might be determined by a business rule of the facilty. For example, most facilties will have a limit of 7 days for antibiotics, and 3 days for schedule 1 drugs.

ReturnToStock returnToStock returnToStock

Pointer to information about the reversal of a provision of a medication to a patient or care provider under the authority of the owning Pharmacy Promise.

«CS» Code scheduleType scheduleType

"This describes the type of schedule for the dispensing of the medication(s) that make up the order. PRE-OP orders are usually considered to be ON-CALL orders, and orders dispensed as MULTI-DOSE CONTAINERS are usually considered to be FILL ON REQUEST orders. C=Continuous, O=One Time, P=PRN, R=Fill On Request, OC=On Call." (VistA)

«CS» Code substitutionCode substitutionCode

If the Pharmacist has changed the kind of medication to be dispensed to the patient from the one originally ordered by the prescriber, this property provides a categorization of the kind of substitution that was made.
"Refer to HL7 Table 0167 - Substitution Status in Chapter 2C for suggested values." - HL7 Version 2.8, RXD-11.
"Refer to HL7 Table 0167 - Substitution Status in Chapter 2C for suggested values." - HL7 Version 2.8, RXE-9.
"Product/Service Substitution, coded" - NCPDP Script (Field 4457, Data Dictionary 201104)
"Code indicating whether or not the prescriber’s instructions regarding generic substitution were followed." - NCPDP Telecommunication (Field 408-D8, Data Dictionary 201104).

-----
Possible values include (from HL7 Table 167):
No substitute was dispensed. This is equivalent to the default (null) value;
A generic substitution was dispensed;
A therapeutic substitution was dispensed;
No product selection indicated;
Substitution not allowed by prescriber;
Substitution allowed - patient requested product dispensed;
Substitution allowed - pharmacist selected product dispensed;
Substitution allowed - generic drug not in stock;
Substitution allowed - brand drug dispensed as a generic;
Substitution not allowed - brand drug mandated by law;
Substitution allowed - generic drug not available in marketplace.
-----
Possible values include (From NCPDP ECL):
No Product Selection Indicated
Substitution Not Allowed by Prescriber
Substitution Allowed - Patient Requested Product Dispensed
Substitution Allowed - Pharmacist Selected Product Dispensed
Substitution Allowed - Generic Drug Not in Stock
Substitution Allowed - Brand Drug Dispensed as a Generic Override
Substitution Not Allowed - Brand Drug Mandated by Law
Substitution Allowed - Generic Drug Not Available in Marketplace
Substitution Allowed By Prescriber but Plan Requests Brand - Patient's Plan Requested Brand Product To Be Dispensed

Attributes inherited from FHIM::Orders::Promise FHIM::Orders::Promise
chargeToPracticeCode chargeToPracticeCode, chargeToPracticeCost chargeToPracticeCost, dateAccepted dateAccepted, discontinueDate discontinueDate, expectedAvailabilityDate expectedAvailabilityDate, fillerOrderId fillerOrderId, fillerSupplementalInfo fillerSupplementalInfo, order order, orderModality orderModality, precautionProtocolInvoked precautionProtocolInvoked, priority priority, promisingOrganization promisingOrganization, promisingProvider promisingProvider, scheduledDateTime scheduledDateTime, status status, statusChangeDateTime statusChangeDateTime, statusModifier statusModifier

Attributes inherited from FHIM::Common::ActionStatement FHIM::Common::ActionStatement
category category, currentStatus currentStatus, description description, indication indication, inputFinding inputFinding, instantiatesCanonical instantiatesCanonical, instantiatesUri instantiatesUri, insurance insurance, intent intent, justification justification, location location, method method, outputFinding outputFinding, precondition precondition, reasonCode reasonCode, reasonNarrative reasonNarrative, reasonReference reasonReference, relevantHistory relevantHistory, scope scope, supportingInformation supportingInformation, usingDevice usingDevice, wasReported wasReported

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contentVersion contentVersion, contextCode contextCode, encounter encounter, note note, recordStatus recordStatus, relatedClinicalInformation relatedClinicalInformation, sourceRecordType sourceRecordType, sourceSystem sourceSystem, subjectGroup subjectGroup, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord, temporalContext temporalContext, topicCode topicCode, cosigned cosigned, recorded recorded, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsEntryPoint
NamePharmacyPromise
Name Expression
NamespacePharmacy
Owned Template Signature
OwnerPharmacy
Owning Template Parameter
PackagePharmacy
Qualified NameFHIM::Pharmacy::PharmacyPromise
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 appointmentTime
Public «TS» PointInTime appointmentTime

Date and time of the appointment for this clinic location.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NameappointmentTime
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::appointmentTime
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dispense
Public PharmacyDispense dispense

Pointer to information about the provision of a medication to a Patient or care provider under the authority of the owning Pharmacy Promise. In other words, this is a collection of dispensing events associated with the (pharmacy systems's view of the ) Order.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyPromise_dispense
Association End
Class«EntryPoint» PharmacyPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namedispense
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::dispense
Stereotype
Template Parameter
TypePharmacyDispense
Upper*
Upper Value(*)
VisibilityPublic


 dosage
Public Dosage dosage

Pointer to information used to describe how the medication should be taken by the Patient, as described by the Pharmacist (the pharmacist can change the ordered dosage under certain circumstances).

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyPromise_dosage
Association End
Class«EntryPoint» PharmacyPromise
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*
Namedosage
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::dosage
Stereotype
Template Parameter
TypeDosage
Upper*
Upper Value(*)
VisibilityPublic


 expirationDate
Public «TS» PointInTime expirationDate

The date after which the order may no longer be filled.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NameexpirationDate
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::expirationDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 finisher
Public PractitionerParticipation finisher

A pharmacy personnel who reviews the order and makes any required changes that are allowed under the usual and customary boundaries. The end result of this activity is an order that can be fulfilled. This role also called verifier, or perfecter.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
Namefinisher
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::finisher
Stereotype
Template Parameter
TypePractitionerParticipation
Upper1
Upper Value(1)
VisibilityPublic


 isHospitalSuppliedSelfAdministered
Public Boolean isHospitalSuppliedSelfAdministered

A flag indicating that the medication given to the patient is to be self administered and is to be supplied by the hospitals pharmacy while they are an inpatient.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NameisHospitalSuppliedSelfAdministered
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::isHospitalSuppliedSelfAdministered
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isSelfAdministered
Public Boolean isSelfAdministered

A flag indicating that the medication given to the patient is to be self administered.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NameisSelfAdministered
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::isSelfAdministered
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 lastDispenseDate
Public «TS» PointInTime lastDispenseDate

The most recent date (and optionally time) that the medication was distributed to a patient, patient care-giver, or the location at which the patient is receiving care.
"Date/time of the most recent refill or dose dispensed." - HL7 Version 2.8, RXE-18.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NamelastDispenseDate
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::lastDispenseDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 needsHumanReview
Public Boolean needsHumanReview

This optional property is included for compatibility with HL7 version 2. It is used in version 2 messaging to convey that a warning is present in the dispensing instructions field and that downstream applications are expected to alert the human user to the presence of the warning.
"Yes - Indicates that a warning is present. The application receiving the encoded order needs to warn the person administering the drug or treatment to pay attention to the text in RXE-21-pharmacy/treatment special dispensing instructions. No - Indicates no warning " - HL7 Version 2.8, RXE-20.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NameneedsHumanReview
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::needsHumanReview
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 numberOfRefillsOrDosesDispensed
Public Integer numberOfRefillsOrDosesDispensed

"Number of refills remaining." - HL7 Version 2.8, RXE-17 (Number of Refills/Doses Dispensed).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NamenumberOfRefillsOrDosesDispensed
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::numberOfRefillsOrDosesDispensed
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 numberOfRefillsRemaining
Public Integer numberOfRefillsRemaining

Indicates the number of times the order may be filled without additional authorization. It is calculated by substracting the number of fills already completed from the number of fills authorized by the prescriber.
"This field is conditional because it is required when a prescription is dispensed to an outpatient. It is not relevant to inpatient treatment orders." - HL7 Version 2.8, RXD-8.
"Number of refills remaining." - HL7 Version 2.8, RXE-16 (Number of Refills Remaining).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NamenumberOfRefillsRemaining
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::numberOfRefillsRemaining
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 patientReportedMedication
Public PatientReportedMedication patientReportedMedication

Pointer to information about medication(s) which the patient reports to be using.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyPromise_patientReportedMedication
Association End
Class«EntryPoint» PharmacyPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamepatientReportedMedication
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::patientReportedMedication
Stereotype
Template Parameter
TypePatientReportedMedication
Upper*
Upper Value(*)
VisibilityPublic


 pharmacy
Public Pharmacy pharmacy

"Specifies the pharmacy that will dispense or has dispensed the prescription." - HL7 Version 2.8, RXO-32.
"Specifies the address of the dispensing facility." - HL7 Version 2.8, RXO-33.
"Contains the telecommunication contact information for the pharmacy." - HL7 Version 2.8, RXO-36.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyPromise_pharmacy
Association End
Class«EntryPoint» PharmacyPromise
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
Namepharmacy
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::pharmacy
Stereotype
Template Parameter
TypePharmacy
Upper1
Upper Value(1)
VisibilityPublic


 pharmacyGeneratedOrderModification
Public PharmacyGeneratedOrderModification pharmacyGeneratedOrderModification

Pointer to information concerning any changes made to the original order by the pharmacist.
"Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done." - HL7 FHIR, MedicationDispense.substitution

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyPromise_pharmacyGeneratedOrderModification
Association End
Class«EntryPoint» PharmacyPromise
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*
NamepharmacyGeneratedOrderModification
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::pharmacyGeneratedOrderModification
Stereotype
Template Parameter
TypePharmacyGeneratedOrderModification
Upper*
Upper Value(*)
VisibilityPublic


 pharmacyInferredDiagnosis
Public DiagnosisListEntry pharmacyInferredDiagnosis

Many claims require a diagnosis in order to be adjudicated, especially in workers compensation situations or where multiple payers are involved. In those cases and where the pharmacy does not have a diagnosis supplied by the prescriber, the pharmacy may infer a diagnosis based on the medication or services ordered. See field 6813 of the NCPDP SCRIPT DRU segment.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyPromise_pharmacyInferredDiagnosis
Association End
Class«EntryPoint» PharmacyPromise
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*
NamepharmacyInferredDiagnosis
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::pharmacyInferredDiagnosis
Stereotype
Template Parameter
TypeDiagnosisListEntry
Upper*
Upper Value(*)
VisibilityPublic


 promisedItem
Public OrderablePharmacyItem promisedItem

Pointer to the medication or pharmacy-stocked item that the Pharmacy has agreed to supply to the Patient. This will normally be the same as the one ordered by the prescriber, but may be different under certain pre-defined conditions. For example, the provider may have ordered a brand-name drug, but indicated that a generic substitution is authorized, and the pharmacy may have substituted a generic drug. Other situations include changes due to inventory at hand, for example the prescriber may have ordered 10 mg tablets, but only 5 mg tablets were available.
"Identifies the medical substance or treatment that has been ordered to be given to the patient, as encoded by the pharmacy or treatment supplier" - HL7 Version 2.8, RXE-2.
"This field accommodates the identification of any codes that might be associated with the pharmaceutical substance. Common codes include: the Generic Product Identifier (GPI), Generic Code Number_Sequence Number (GCN_SEQNO), National Drug Code (NDC)." - HL7 Version 2.8, RXE-31.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyPromise_promisedItem
Association End
Class«EntryPoint» PharmacyPromise
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
NamepromisedItem
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::promisedItem
Stereotype
Template Parameter
TypeOrderablePharmacyItem
Upper1
Upper Value(1)
VisibilityPublic


 requestedAdministrationTime
Public «IVL_TS» Period requestedAdministrationTime

Specifies when the service is to be performed and how frequently. Note that this is a complex data type that may indicate specific times or intervals (e.g., 10:00 AM, MWF, etc).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedtrue
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamerequestedAdministrationTime
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::requestedAdministrationTime
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper*
Upper Value(*)
VisibilityPublic


 requestedDuration
Public «PQ» TimeQuantity requestedDuration

The duration of an order as requested by the ordering clinician. The duration would be expressed as a number of days, weeks, hours, etc. Note that this length of time might be determined by a business rule of the facilty. For example, most facilties will have a limit of 7 days for antibiotics, and 3 days for schedule 1 drugs.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NamerequestedDuration
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::requestedDuration
Stereotype
Template Parameter
Type«PQ» TimeQuantity
Upper1
Upper Value(1)
VisibilityPublic


 returnToStock
Public ReturnToStock returnToStock

Pointer to information about the reversal of a provision of a medication to a patient or care provider under the authority of the owning Pharmacy Promise.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyPromise_returnToStock
Association End
Class«EntryPoint» PharmacyPromise
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*
NamereturnToStock
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::returnToStock
Stereotype
Template Parameter
TypeReturnToStock
Upper*
Upper Value(*)
VisibilityPublic


 scheduleType
Public «CS» Code scheduleType

"This describes the type of schedule for the dispensing of the medication(s) that make up the order. PRE-OP orders are usually considered to be ON-CALL orders, and orders dispensed as MULTI-DOSE CONTAINERS are usually considered to be FILL ON REQUEST orders. C=Continuous, O=One Time, P=PRN, R=Fill On Request, OC=On Call." (VistA)

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NamescheduleType
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::scheduleType
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 substitutionCode
Public «CS» Code substitutionCode

If the Pharmacist has changed the kind of medication to be dispensed to the patient from the one originally ordered by the prescriber, this property provides a categorization of the kind of substitution that was made.
"Refer to HL7 Table 0167 - Substitution Status in Chapter 2C for suggested values." - HL7 Version 2.8, RXD-11.
"Refer to HL7 Table 0167 - Substitution Status in Chapter 2C for suggested values." - HL7 Version 2.8, RXE-9.
"Product/Service Substitution, coded" - NCPDP Script (Field 4457, Data Dictionary 201104)
"Code indicating whether or not the prescriber’s instructions regarding generic substitution were followed." - NCPDP Telecommunication (Field 408-D8, Data Dictionary 201104).

-----
Possible values include (from HL7 Table 167):
No substitute was dispensed. This is equivalent to the default (null) value;
A generic substitution was dispensed;
A therapeutic substitution was dispensed;
No product selection indicated;
Substitution not allowed by prescriber;
Substitution allowed - patient requested product dispensed;
Substitution allowed - pharmacist selected product dispensed;
Substitution allowed - generic drug not in stock;
Substitution allowed - brand drug dispensed as a generic;
Substitution not allowed - brand drug mandated by law;
Substitution allowed - generic drug not available in marketplace.
-----
Possible values include (From NCPDP ECL):
No Product Selection Indicated
Substitution Not Allowed by Prescriber
Substitution Allowed - Patient Requested Product Dispensed
Substitution Allowed - Pharmacist Selected Product Dispensed
Substitution Allowed - Generic Drug Not in Stock
Substitution Allowed - Brand Drug Dispensed as a Generic Override
Substitution Not Allowed - Brand Drug Mandated by Law
Substitution Allowed - Generic Drug Not Available in Marketplace
Substitution Allowed By Prescriber but Plan Requests Brand - Patient's Plan Requested Brand Product To Be Dispensed

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyPromise
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
NamesubstitutionCode
Name Expression
Namespace«EntryPoint» PharmacyPromise
Opposite
Owner«EntryPoint» PharmacyPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyPromise::substitutionCode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic