Pharmacy
Class PharmacyDispense

This class contains information about the provision of a medication to a patient or care provider under the authority of the owning Pharmacy Promise. This class includes medications placed in a medication cart for a caregiver (usually a nurse) to administer to the patient during scheduled rounds, as well as other inpatient settings, outpatient, retail and even mail-order settings.
It is noted that in the typical Pharmacy workflow, the prescription will be “filled�, for example the pharmacist places 30 tablets into a bottle, then “dispensed� when the patient picks up the medication or the medication leaves the pharmacy’s control. The FHIM combines these notions under a single Pharmacy Dispense as it is presumed that information exchanges for interoperability between systems generally only occur after the dispense, therefore the notion of a fill does not need to be tracked separately.
"Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order." - HL7 FHIR, MedicationDispense

Attributes
«PQ» Quantity actualStrength actualStrength

"Use when [DispensedDrug] does not specify the strength. This is the numeric part of the strength, of a single dosage unit of the dispensed product" - HL7 Version 2.8, RXD-16.
"Use when [DispensedDrug] does not specify the strength. This is the unit of the strength, of a single dosage unit of the dispensed product" - HL7 Version 2.8, RXD-17.

«TS» PointInTime dateTimeDispensed dateTimeDispensed

Indicates when the pharmaceutical/treatment left the control of the pharmacy. This may be when the medication was picked up or mailed (outpatient), or delivered to a ward (inpatient). Note that this differs from the "fill date/time" in that the fill date is when the pharmaceutical/treatment was removed from inventory (e.g., when the pharmacist filled a bottle with tablets from inventory); once filled, the medication may remain in the pharmacy awaiting pick-up. Once delivered to the patient or another caregiver, the medication is then considered "dispensed."
Dispense = "to make up and distribute (medicine), esp. on prescription." - Random House Unabridged Dictionary.
"Indicates when the pharmaceutical/treatment is dispensed from the pharmacy or treatment supplier." - HL7 Version 2.8, RXD-3.
"The time the dispensed product was provided to the patient or their representative." - HL7 FHIR, MedicationDispense.whenHandedOver

«TS» PointInTime dateTimeFilled dateTimeFilled

Indicates when the pharmaceutical/treatment was removed from inventory and prepared for delivery to the patient. Note that this differs from the "dispense date/time" in that the fill date is when the pharmaceutical/treatment was removed from inventory (e.g., when the pharmacist filled a bottle with tablets from inventory); once filled, the medication may remain in the pharmacy awaiting pick-up, where as the dispense date/time is when the mediation leaves the control of the pharmacy. Once delivered to the patient or another caregiver, the medication is then considered "dispensed."
"The time when the dispensed product was packaged and reviewed." - HL7 FHIR, MedicationDispense.whenPrepared
"Date prescription was prepared." - ASAP Standard for PDMP, DSP05: Date Filled

Integer daysSupply daysSupply

The length of time in days that the quantity dispensed will last if consumed at the rate prescribed. For example if the patient is instructed to take 2 pills a day, 60 pills will last 30 days.
"Estimated number of days the prescription will last." - NCPDP Telecommunication (Field 405-D5, Data Dictionary 201104).
"The amount of medication expressed as a timing amount." - HL7 FHIR, MedicationDispense.daysSupply
"The calculated or estimated number of days the medication will cover." - ASAP Standard for PDMP, DSP10: Days Supply
"Days supply. Number of days that the medication supports based on the number of doses as reported by the pharmacist. This amount is typically found on the dispensing record. Integer values are expected." - PCORnet Common Data Model, Dispensing.Dispense_Sup.

DetectedIssueEvent detectedIssue detectedIssue

"Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc." - HL7 FHIR, MedicationDispense.detectedIssue

«CS» Code dispenseCategory dispenseCategory

Categorizes the dispense, primarily along the lines of whether the fill was an original or refill and whether it was a full or partial fill. This property also indicates whether the fill was a manufacturer sample or trial quantity. This property is used to document the circumstances under which the fill occurred. In NCPDP SCRIPT, this information is conveyed in a Response Segment in response to a Prescription Fill Status request. In NCPDP Telecommunication, this property is limited to only Partial Fill or Completion of Partial Fill.
"This is the type of dispensing event that occurred." - HL7 Version 2.8, RXA-26 and RXO-27. Valid values (from HL7 Table 0484) include: Trial Quantity Balance; Compassionate Fill; New/Renew - Full Fill; New/Renew - Part Fill; Refill - Part Fill; Refill - Full Fill; Manufacturer Sample; Trial Quantity; Non-Prescription Fill.
"Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc." - HL7 FHIR, MedicationDispense.type
"Code indicating the quantity dispensed is a partial fill or the completion of a partial fill…." - NCPDP Telecommunication (Field 343-HD, Data Dictionary 201104). Possible values include: Partial Fill; Completion of Partial Fill.

DispensedDrug dispensedDrug dispensedDrug

Pointer to the medication or pharmacy-stocked item that the Pharmacy actually supplied to the Patient or the Patient’s caregiver. 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. Note that the ordering application will typically indicate a Medicinal Product using a code like RxNorm, while the dispensing system will typically be more specific by indicating the Packaged Medicinal Product, using a code like the National Drug Code to specify the container from which the medication was dispensed, for pricing, inventory tracking, and recall-management purposes.

"Identifies the medical substance or treatment ordered to be given to the patient; it is equivalent to [the Ordered Item]." - HL7 Version 2.8, RXD-2.
"Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications." - HL7 FHIR, MedicationDispense.medication[x]
"Full product identification as indicated in DSP07 [Product Id Qualifier], including leading zeros without punctuation. If the product is a compound, use 99999 as the first five characters of the product code. The remaining six characters are assigned by the pharmacy." - ASAP Standard for PDMP, DSP08: Product Id
"
Used to identify the type of product ID contained in DSP08 [Product Id]." - ASAP Standard for PDMP, DSP07: Product ID Qualifier. Possible values include: NDC; UPC; HRI; UPN; DIN; Compound (Used to indicate it is a compound. The CDI segment then becomes a required segment. Also, see instructions for DSP08.) Note that in FHIM, this information is in the Code data type

«CS» Code dispenseMethod dispenseMethod

This optional property is included for compatibility to HL7 version 2. It is meant to convey how the medication was supplied, probably for pricing or workflow purposes. No specific federal requirements or uses for this field have been identified.
"Contains the method by which treatment is dispensed." - HL7 Version 2.8, RXD-24. Possible values (from HL7 Table 321) include: Traditional; Unit Dose; Floor Stock; Automatic Dispensing.

String dispenseNotes dispenseNotes

"Contains free text notes to the person dispensing the medication/treatment (may include the ordering provider's original notes, as well as any notes from the formulary or the pharmacy or treatment supplier). This may contain free text describing a custom IV, mixture, or salve for example." - HL7 Version 2.8, RXD-9.
"Extra information about the dispense that could not be conveyed in the other attributes." - HL7 FHIR, MedicationDispense.note

PractitionerParticipation dispenser dispenser

Pointer to the person who dispensed the prescription. The dispenser is the person who facilitated the release of the medication from the pharmacy's control, as opposed to the filler who is the person who measured out and packaged the medication. For example, the person who counted out the pills and put them in the bottle is the filler, the person who gave the bottle of pills to the patient is the dispenser. The person playing the filler role and the person playing the dispenser role may be the same person.
"Contains the provider ID of the person dispensing the pharmaceutical." - HL7 Version 2.8, RXD-10.
"The individual responsible for dispensing the medication." - HL7 FHIR, MedicationDispense.dispenser

DispenseRecipient dispenseRecipient dispenseRecipient

Pointer to the person who picked up (i.e., took custody of) the dispensed medication.
"Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional." - HL7 FHIR, MedicationDispense.receiver

dispenseToLocation dispenseToLocation

"Contains the inpatient or outpatient location where the drug or treatment was dispensed (if applicable). The default (null) value is the current census location for the patient." - HL7 Version 2.8, RXD-13.
"Identification of the facility/location where the medication was shipped to, as part of the dispense event." - HL7 FHIR, MedicationDispense.destination

Device dispensingDevice dispensingDevice

Pointer to information about the automated equipment which was used to fill the prescription.

String dispensingInstructions dispensingInstructions

"Contains pharmacy or treatment supplier-generated special instructions to the provider dispensing/administering the order." - HL7 Version 2.8, RXD-15.

PractitionerParticipation filler filler

Pointer to the person who filled the prescription. The filler is the person who measured out and packaged the medication, as opposed to the dispenser who is the person who facilitated the release of the medication from the pharmacy's control. For example, the person who counted out the pills and put them in the bottle is the filler, the person who gave the bottle of pills to the patient is the dispenser. The person playing the filler role and the person playing the dispenser role may be the same person.

Integer fillSequenceNumber fillSequenceNumber

This property enumerates how the current fill relates to the number of times that the medication request (prescription) has been filled. It is noted that this concept exists in both NCPDP and in HL7 version 2, yet the numbering is different in these two standards: NCPDP uses zero for the original fill then increments for each refill, while HL7 version 2 uses one for the original fill then increments for each refill. Implementers are cautioned to be cognizant of how this data is locally stored and how it is represented in the target standard.
"This field starts with 1 the first time that medication/treatment is delivered/dispensed for this order. Increments by one with each additional issuance." - HL7 Version 2.8, RXD-1.
"The code indicating whether the prescription is an original or a refill." - NCPDP Telecommunication (Field 403-D3, Data Dictionary 201104). Note that while the NCPDP Telecommunication structure treats this field as a code, it contains a number from 0-99, where zero is the original fill, and 1-99 are refills.
"Number of the fill of the prescription.
0 indicates original dispensing, 01-99 is the refill number." - ASAP Standard for PDMP, DSP06: Refill Number

Boolean isCompound isCompound

Indicates whether the dispensed medication was locally created by combining two or more products (one of which may be distilled water, which is a product). Common examples include mixing medications in flavored syrup for children, reconstituting a dried medication in distilled water, or mixing a medication into a cream for topical application. Note that this property is marked as derived in that it could be calculated based on whether the DispensedDrug is a LocallyManufacturedProduct.
"Code indicating whether or not the prescription is a compound." - NCPDP Telecommunication (Field 406-D6, Data Dictionary 201104). Note that the NCPDP Telecommunication structure treats this as a code, but the values are essentially Yes (Compound), No (Not a compound), and Not Specified. Note also that this property could be derived from the medication dispensed.

«CS» Code kind kind

"Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient))." - HL7 FHIR, MedicationDispense.category

Boolean needsHumanReview needsHumanReview

Indicates whether "the application receiving the dispense order needs to warn the person dispensing/administering the drug or treatment to pay attention to the text in [Dispensing Instructions]." - HL7 Version 2.8, RXD-14.

String partialFill partialFill

"This field is used when the quantity in DSP09 is less than the metric quantity per dispensing authorized by the prescriber. This dispensing activity is often referred to as a split filling." - ASAP Standard for PDMP, DSP13: Partial Fill Indicator. Possible values include: 00=Not a Partial Fill; 01=First Partial Fill; 02-99=Additional Fills.
Note: For additional fills per prescription, increment by one. So the second partial fill would be reported as 02, up to a maximum of 99.

String patientInstructions patientInstructions

"Indicates how the medication is to be used by the patient." - HL7 FHIR, MedicationDispense.dosageInstruction
Note that there is a patientInstruction property in the Pharmacy Request (i.e., the Prescription), which contains the prescriber's instructions to the patient. That information may be copied into this property and provided as-is, or be modified to include the Pharmacist's instructions.

PractitionerParticipation pharmacist pharmacist

Pointer to the Person (in the Role of Pharmacist) who is responsible for fulfillment of the medication order and providing oversight.

Pharmacy pharmacy pharmacy

"Specifies the pharmacy that will dispense or has dispensed the prescription." - HL7 Version 2.8, RXD-30.
"Specifies the address of the dispensing facility or the patient's location where the dispensing will occur." - HL7 Version 2.8, RXD-31.

«EntryPoint» PharmacyPromise pharmacyPromise pharmacyPromise

Pointer to the Pharmacy Promise under which this Dispense event was authorized. Through Pharmacy Promise the Dispense also has visibility of the original Request, or prescription.
"Indicates the medication order that is being dispensed against." - HL7 FHIR, MedicationDispense.authorizingPrescription

«CS» Code productSelectionCode productSelectionCode

"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: Substitution Not Allowed by Prescriber; Substitution Not Allowed-Brand Drug Mandated by Law; 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 Allowed-Generic Drug Not Available in Marketplace; Substitution Allowed By Prescriber but Plan Requests Brand; Override; No Product Selection Indicated.

«PQ» Quantity quantityDispensed quantityDispensed

The quanitity of the medication dispensed to this patient in fulfillment of a request.
"Quantity dispensed expressed in metric decimal units." - NCPDP Telecommunication (Field 442-E7, Data Dictionary 201104).
"The amount of medication that has been dispensed. Includes unit of measure." - HL7 FHIR, MedicationDispense.quantity
"Number of metric units dispensed in metric decimal format. Example: 2.5. Note: For compounds show the first quantity in [Compound Ingredient Quantity]." - ASAP Standard for PDMP, DSP09: Quantity Dispensed
"Number of units (pills, tablets, vials) dispensed. Net amount per NDC per dispensing. This amount is typically found on the dispensing record. Positive values are expected." - PCORnet Common Data Model, Dispensing.Dispense_Amt.
"Identifies the unit of measure for the quantity dispensed in DSP09 [Quantity Dispensed]" - ASAP Standard for PDMP, DSP11: Drug Dosage Units Code. Possible values include: Each (used to report solid dosage units or indivisible package; Milliliters (ml) (for liters adjust to the decimal milliliter equivalent); Grams (gm) (for milligrams adjust to the decimal gram equivalent).

reasonNotPerformed reasonNotPerformed

"Indicates the reason why a dispense was not performed." - HL7 FHIR, MedicationDispense.statusReason[x]

«CS» Code specialPackaging specialPackaging

"Code indicating the type of dispensing dose." - NCPDP Telecommunication (Field 429-DT, Data Dictionary 201104). Possible values include: Not Unit Dose; Manufacturer Unit Dose; Pharmacy Unit Dose; Pharmacy Unit Dose Patient Compliance Packaging; Pharmacy Multi-drug Patient Compliance Packaging; Remote Device Unit Dose; Remote Device Multi- drug Compliance; Manufacturer Unit of Use Package (not unit dose); Not Specified.

«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

Boolean wasSubstituted wasSubstituted

"True if the dispenser dispensed a different drug or product from what was prescribed." - HL7 FHIR, MedicationDispense.substitution.wasSubstituted
Note that this property could potentially be calcualted from either the substitution code or the Pharmacy Generated Order Modification, therefore this property is marked as derived.

Attributes inherited from FHIM::Common::ActionPerformed FHIM::Common::ActionPerformed
basedOn basedOn, bodySite bodySite, complication complication, complicationDetail complicationDetail, duration duration, enactsPlan enactsPlan, focalDevice focalDevice, followUp followUp, fulfillsOrder fulfillsOrder, fulfillsPromise fulfillsPromise, nonCompletionTimeframe nonCompletionTimeframe, outcome outcome, partOf partOf, performancePeriod performancePeriod, performer performer, procedureModifier procedureModifier, report report, researchStudy researchStudy, status status, statusReason statusReason, timesPerformed timesPerformed, topicCode topicCode, usedCode usedCode, usedReference usedReference, wasCompleted wasCompleted

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 Abstracttrue
Is Activefalse
Is Leaffalse
Keywords
NamePharmacyDispense
Name Expression
NamespacePharmacy
Owned Template Signature
OwnerPharmacy
Owning Template Parameter
PackagePharmacy
Qualified NameFHIM::Pharmacy::PharmacyDispense
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 actualStrength
Public Â«PQ» Quantity actualStrength

"Use when [DispensedDrug] does not specify the strength. This is the numeric part of the strength, of a single dosage unit of the dispensed product" - HL7 Version 2.8, RXD-16.
"Use when [DispensedDrug] does not specify the strength. This is the unit of the strength, of a single dosage unit of the dispensed product" - HL7 Version 2.8, RXD-17.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NameactualStrength
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::actualStrength
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeDispensed
Public Â«TS» PointInTime dateTimeDispensed

Indicates when the pharmaceutical/treatment left the control of the pharmacy. This may be when the medication was picked up or mailed (outpatient), or delivered to a ward (inpatient). Note that this differs from the "fill date/time" in that the fill date is when the pharmaceutical/treatment was removed from inventory (e.g., when the pharmacist filled a bottle with tablets from inventory); once filled, the medication may remain in the pharmacy awaiting pick-up. Once delivered to the patient or another caregiver, the medication is then considered "dispensed."
Dispense = "to make up and distribute (medicine), esp. on prescription." - Random House Unabridged Dictionary.
"Indicates when the pharmaceutical/treatment is dispensed from the pharmacy or treatment supplier." - HL7 Version 2.8, RXD-3.
"The time the dispensed product was provided to the patient or their representative." - HL7 FHIR, MedicationDispense.whenHandedOver

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamedateTimeDispensed
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dateTimeDispensed
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateTimeFilled
Public Â«TS» PointInTime dateTimeFilled

Indicates when the pharmaceutical/treatment was removed from inventory and prepared for delivery to the patient. Note that this differs from the "dispense date/time" in that the fill date is when the pharmaceutical/treatment was removed from inventory (e.g., when the pharmacist filled a bottle with tablets from inventory); once filled, the medication may remain in the pharmacy awaiting pick-up, where as the dispense date/time is when the mediation leaves the control of the pharmacy. Once delivered to the patient or another caregiver, the medication is then considered "dispensed."
"The time when the dispensed product was packaged and reviewed." - HL7 FHIR, MedicationDispense.whenPrepared
"Date prescription was prepared." - ASAP Standard for PDMP, DSP05: Date Filled

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamedateTimeFilled
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dateTimeFilled
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 daysSupply
Public Integer daysSupply

The length of time in days that the quantity dispensed will last if consumed at the rate prescribed. For example if the patient is instructed to take 2 pills a day, 60 pills will last 30 days.
"Estimated number of days the prescription will last." - NCPDP Telecommunication (Field 405-D5, Data Dictionary 201104).
"The amount of medication expressed as a timing amount." - HL7 FHIR, MedicationDispense.daysSupply
"The calculated or estimated number of days the medication will cover." - ASAP Standard for PDMP, DSP10: Days Supply
"Days supply. Number of days that the medication supports based on the number of doses as reported by the pharmacist. This amount is typically found on the dispensing record. Integer values are expected." - PCORnet Common Data Model, Dispensing.Dispense_Sup.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamedaysSupply
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::daysSupply
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 detectedIssue
Public DetectedIssueEvent detectedIssue

"Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc." - HL7 FHIR, MedicationDispense.detectedIssue

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamedetectedIssue
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::detectedIssue
Stereotype
Template Parameter
TypeDetectedIssueEvent
Upper1
Upper Value(1)
VisibilityPublic


 dispenseCategory
Public Â«CS» Code dispenseCategory

Categorizes the dispense, primarily along the lines of whether the fill was an original or refill and whether it was a full or partial fill. This property also indicates whether the fill was a manufacturer sample or trial quantity. This property is used to document the circumstances under which the fill occurred. In NCPDP SCRIPT, this information is conveyed in a Response Segment in response to a Prescription Fill Status request. In NCPDP Telecommunication, this property is limited to only Partial Fill or Completion of Partial Fill.
"This is the type of dispensing event that occurred." - HL7 Version 2.8, RXA-26 and RXO-27. Valid values (from HL7 Table 0484) include: Trial Quantity Balance; Compassionate Fill; New/Renew - Full Fill; New/Renew - Part Fill; Refill - Part Fill; Refill - Full Fill; Manufacturer Sample; Trial Quantity; Non-Prescription Fill.
"Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc." - HL7 FHIR, MedicationDispense.type
"Code indicating the quantity dispensed is a partial fill or the completion of a partial fill…." - NCPDP Telecommunication (Field 343-HD, Data Dictionary 201104). Possible values include: Partial Fill; Completion of Partial Fill.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
Terminologies[
HL7_FHIR_R4 V3 Value SetActPharmacySupplyType http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
]
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
NamedispenseCategory
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispenseCategory
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 dispensedDrug
Public DispensedDrug dispensedDrug

Pointer to the medication or pharmacy-stocked item that the Pharmacy actually supplied to the Patient or the Patient’s caregiver. 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. Note that the ordering application will typically indicate a Medicinal Product using a code like RxNorm, while the dispensing system will typically be more specific by indicating the Packaged Medicinal Product, using a code like the National Drug Code to specify the container from which the medication was dispensed, for pricing, inventory tracking, and recall-management purposes.

"Identifies the medical substance or treatment ordered to be given to the patient; it is equivalent to [the Ordered Item]." - HL7 Version 2.8, RXD-2.
"Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications." - HL7 FHIR, MedicationDispense.medication[x]
"Full product identification as indicated in DSP07 [Product Id Qualifier], including leading zeros without punctuation. If the product is a compound, use 99999 as the first five characters of the product code. The remaining six characters are assigned by the pharmacy." - ASAP Standard for PDMP, DSP08: Product Id
"
Used to identify the type of product ID contained in DSP08 [Product Id]." - ASAP Standard for PDMP, DSP07: Product ID Qualifier. Possible values include: NDC; UPC; HRI; UPN; DIN; Compound (Used to indicate it is a compound. The CDI segment then becomes a required segment. Also, see instructions for DSP08.) Note that in FHIM, this information is in the Code data type

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyDispense_dispensedDrug
Association End
ClassPharmacyDispense
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*
NamedispensedDrug
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispensedDrug
Stereotype
Template Parameter
TypeDispensedDrug
Upper*
Upper Value(*)
VisibilityPublic


 dispenseMethod
Public Â«CS» Code dispenseMethod

This optional property is included for compatibility to HL7 version 2. It is meant to convey how the medication was supplied, probably for pricing or workflow purposes. No specific federal requirements or uses for this field have been identified.
"Contains the method by which treatment is dispensed." - HL7 Version 2.8, RXD-24. Possible values (from HL7 Table 321) include: Traditional; Unit Dose; Floor Stock; Automatic Dispensing.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamedispenseMethod
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispenseMethod
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 dispenseNotes
Public String dispenseNotes

"Contains free text notes to the person dispensing the medication/treatment (may include the ordering provider's original notes, as well as any notes from the formulary or the pharmacy or treatment supplier). This may contain free text describing a custom IV, mixture, or salve for example." - HL7 Version 2.8, RXD-9.
"Extra information about the dispense that could not be conveyed in the other attributes." - HL7 FHIR, MedicationDispense.note

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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*
NamedispenseNotes
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispenseNotes
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 dispenser
Public PractitionerParticipation dispenser

Pointer to the person who dispensed the prescription. The dispenser is the person who facilitated the release of the medication from the pharmacy's control, as opposed to the filler who is the person who measured out and packaged the medication. For example, the person who counted out the pills and put them in the bottle is the filler, the person who gave the bottle of pills to the patient is the dispenser. The person playing the filler role and the person playing the dispenser role may be the same person.
"Contains the provider ID of the person dispensing the pharmaceutical." - HL7 Version 2.8, RXD-10.
"The individual responsible for dispensing the medication." - HL7 FHIR, MedicationDispense.dispenser

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
Namedispenser
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispenser
Stereotype
Template Parameter
TypePractitionerParticipation
Upper1
Upper Value(1)
VisibilityPublic


 dispenseRecipient
Public DispenseRecipient dispenseRecipient

Pointer to the person who picked up (i.e., took custody of) the dispensed medication.
"Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional." - HL7 FHIR, MedicationDispense.receiver

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyDispense_dispenseRecipient
Association End
ClassPharmacyDispense
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
NamedispenseRecipient
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispenseRecipient
Stereotype
Template Parameter
TypeDispenseRecipient
Upper1
Upper Value(1)
VisibilityPublic


 dispenseToLocation
Public  dispenseToLocation

"Contains the inpatient or outpatient location where the drug or treatment was dispensed (if applicable). The default (null) value is the current census location for the patient." - HL7 Version 2.8, RXD-13.
"Identification of the facility/location where the medication was shipped to, as part of the dispense event." - HL7 FHIR, MedicationDispense.destination

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamedispenseToLocation
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispenseToLocation
Stereotype
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 dispensingDevice
Public Device dispensingDevice

Pointer to information about the automated equipment which was used to fill the prescription.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyDispense_dispensingDevice
Association End
ClassPharmacyDispense
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
NamedispensingDevice
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispensingDevice
Stereotype
Template Parameter
TypeDevice
Upper1
Upper Value(1)
VisibilityPublic


 dispensingInstructions
Public String dispensingInstructions

"Contains pharmacy or treatment supplier-generated special instructions to the provider dispensing/administering the order." - HL7 Version 2.8, RXD-15.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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*
NamedispensingInstructions
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::dispensingInstructions
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 filler
Public PractitionerParticipation filler

Pointer to the person who filled the prescription. The filler is the person who measured out and packaged the medication, as opposed to the dispenser who is the person who facilitated the release of the medication from the pharmacy's control. For example, the person who counted out the pills and put them in the bottle is the filler, the person who gave the bottle of pills to the patient is the dispenser. The person playing the filler role and the person playing the dispenser role may be the same person.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
Namefiller
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::filler
Stereotype
Template Parameter
TypePractitionerParticipation
Upper1
Upper Value(1)
VisibilityPublic


 fillSequenceNumber
Public Integer fillSequenceNumber

This property enumerates how the current fill relates to the number of times that the medication request (prescription) has been filled. It is noted that this concept exists in both NCPDP and in HL7 version 2, yet the numbering is different in these two standards: NCPDP uses zero for the original fill then increments for each refill, while HL7 version 2 uses one for the original fill then increments for each refill. Implementers are cautioned to be cognizant of how this data is locally stored and how it is represented in the target standard.
"This field starts with 1 the first time that medication/treatment is delivered/dispensed for this order. Increments by one with each additional issuance." - HL7 Version 2.8, RXD-1.
"The code indicating whether the prescription is an original or a refill." - NCPDP Telecommunication (Field 403-D3, Data Dictionary 201104). Note that while the NCPDP Telecommunication structure treats this field as a code, it contains a number from 0-99, where zero is the original fill, and 1-99 are refills.
"Number of the fill of the prescription.
0 indicates original dispensing, 01-99 is the refill number." - ASAP Standard for PDMP, DSP06: Refill Number

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamefillSequenceNumber
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::fillSequenceNumber
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 isCompound
Public Boolean isCompound

Indicates whether the dispensed medication was locally created by combining two or more products (one of which may be distilled water, which is a product). Common examples include mixing medications in flavored syrup for children, reconstituting a dried medication in distilled water, or mixing a medication into a cream for topical application. Note that this property is marked as derived in that it could be calculated based on whether the DispensedDrug is a LocallyManufacturedProduct.
"Code indicating whether or not the prescription is a compound." - NCPDP Telecommunication (Field 406-D6, Data Dictionary 201104). Note that the NCPDP Telecommunication structure treats this as a code, but the values are essentially Yes (Compound), No (Not a compound), and Not Specified. Note also that this property could be derived from the medication dispensed.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisCompound
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::isCompound
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 kind
Public Â«CS» Code kind

"Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient))." - HL7 FHIR, MedicationDispense.category

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
Terminologies[
HL7_FHIR_R4 Medication dispense category codes http://hl7.org/fhir/ValueSet/medicationdispense-category
]
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
Namekind
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::kind
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 needsHumanReview
Public Boolean needsHumanReview

Indicates whether "the application receiving the dispense order needs to warn the person dispensing/administering the drug or treatment to pay attention to the text in [Dispensing Instructions]." - HL7 Version 2.8, RXD-14.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::needsHumanReview
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 partialFill
Public String partialFill

"This field is used when the quantity in DSP09 is less than the metric quantity per dispensing authorized by the prescriber. This dispensing activity is often referred to as a split filling." - ASAP Standard for PDMP, DSP13: Partial Fill Indicator. Possible values include: 00=Not a Partial Fill; 01=First Partial Fill; 02-99=Additional Fills.
Note: For additional fills per prescription, increment by one. So the second partial fill would be reported as 02, up to a maximum of 99.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamepartialFill
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::partialFill
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 patientInstructions
Public String patientInstructions

"Indicates how the medication is to be used by the patient." - HL7 FHIR, MedicationDispense.dosageInstruction
Note that there is a patientInstruction property in the Pharmacy Request (i.e., the Prescription), which contains the prescriber's instructions to the patient. That information may be copied into this property and provided as-is, or be modified to include the Pharmacist's instructions.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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*
NamepatientInstructions
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::patientInstructions
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 pharmacist
Public PractitionerParticipation pharmacist

Pointer to the Person (in the Role of Pharmacist) who is responsible for fulfillment of the medication order and providing oversight.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
Namepharmacist
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::pharmacist
Stereotype
Template Parameter
TypePractitionerParticipation
Upper1
Upper Value(1)
VisibilityPublic


 pharmacy
Public Pharmacy pharmacy

"Specifies the pharmacy that will dispense or has dispensed the prescription." - HL7 Version 2.8, RXD-30.
"Specifies the address of the dispensing facility or the patient's location where the dispensing will occur." - HL7 Version 2.8, RXD-31.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyDispense_pharmacy
Association End
ClassPharmacyDispense
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
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::pharmacy
Stereotype
Template Parameter
TypePharmacy
Upper1
Upper Value(1)
VisibilityPublic


 pharmacyPromise
Public Â«EntryPoint» PharmacyPromise pharmacyPromise

Pointer to the Pharmacy Promise under which this Dispense event was authorized. Through Pharmacy Promise the Dispense also has visibility of the original Request, or prescription.
"Indicates the medication order that is being dispensed against." - HL7 FHIR, MedicationDispense.authorizingPrescription

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyDispense_pharmacyPromise
Association End
ClassPharmacyDispense
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
NamepharmacyPromise
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::pharmacyPromise
Stereotype
Template Parameter
Type«EntryPoint» PharmacyPromise
Upper1
Upper Value(1)
VisibilityPublic


 productSelectionCode
Public Â«CS» Code productSelectionCode

"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: Substitution Not Allowed by Prescriber; Substitution Not Allowed-Brand Drug Mandated by Law; 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 Allowed-Generic Drug Not Available in Marketplace; Substitution Allowed By Prescriber but Plan Requests Brand; Override; No Product Selection Indicated.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NameproductSelectionCode
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::productSelectionCode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 quantityDispensed
Public Â«PQ» Quantity quantityDispensed

The quanitity of the medication dispensed to this patient in fulfillment of a request.
"Quantity dispensed expressed in metric decimal units." - NCPDP Telecommunication (Field 442-E7, Data Dictionary 201104).
"The amount of medication that has been dispensed. Includes unit of measure." - HL7 FHIR, MedicationDispense.quantity
"Number of metric units dispensed in metric decimal format. Example: 2.5. Note: For compounds show the first quantity in [Compound Ingredient Quantity]." - ASAP Standard for PDMP, DSP09: Quantity Dispensed
"Number of units (pills, tablets, vials) dispensed. Net amount per NDC per dispensing. This amount is typically found on the dispensing record. Positive values are expected." - PCORnet Common Data Model, Dispensing.Dispense_Amt.
"Identifies the unit of measure for the quantity dispensed in DSP09 [Quantity Dispensed]" - ASAP Standard for PDMP, DSP11: Drug Dosage Units Code. Possible values include: Each (used to report solid dosage units or indivisible package; Milliliters (ml) (for liters adjust to the decimal milliliter equivalent); Grams (gm) (for milligrams adjust to the decimal gram equivalent).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamequantityDispensed
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::quantityDispensed
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic


 reasonNotPerformed
Public  reasonNotPerformed

"Indicates the reason why a dispense was not performed." - HL7 FHIR, MedicationDispense.statusReason[x]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamereasonNotPerformed
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::reasonNotPerformed
Stereotype
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 specialPackaging
Public Â«CS» Code specialPackaging

"Code indicating the type of dispensing dose." - NCPDP Telecommunication (Field 429-DT, Data Dictionary 201104). Possible values include: Not Unit Dose; Manufacturer Unit Dose; Pharmacy Unit Dose; Pharmacy Unit Dose Patient Compliance Packaging; Pharmacy Multi-drug Patient Compliance Packaging; Remote Device Unit Dose; Remote Device Multi- drug Compliance; Manufacturer Unit of Use Package (not unit dose); Not Specified.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
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
NamespecialPackaging
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::specialPackaging
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
ClassPharmacyDispense
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
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::substitutionCode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 wasSubstituted
Public Boolean wasSubstituted

"True if the dispenser dispensed a different drug or product from what was prescribed." - HL7 FHIR, MedicationDispense.substitution.wasSubstituted
Note that this property could potentially be calcualted from either the substitution code or the Pharmacy Generated Order Modification, therefore this property is marked as derived.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassPharmacyDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamewasSubstituted
Name Expression
NamespacePharmacyDispense
Opposite
OwnerPharmacyDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyDispense::wasSubstituted
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic

Comments