FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

Responsible Owner: Pharmacy icon Work Group Maturity Level : 2   Trial Use Security Category : Patient Compartments : Encounter , Group , Patient , Practitioner

Detailed Descriptions for the elements in the MedicationDispense resource.

Control Control Control Control Control Control Control Control Control Control Control Control Control Control Control Control Control MedicationDispense.substitution.responsibleParty 0..* Alternate Names Control
Definition Element Id MedicationDispense
Definition

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.

Short Display Dispensing a medication to a named patient
Control Cardinality 1..1 0..*
Comments Type The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html). DomainResource
Invariants Summary false
Constraints : whenHandedOver.empty() or whenPrepared.empty() or
Defined on this element
mdd-1 : Rule whenHandedOver cannot be before whenPrepared ( expression (whenHandedOver.hasValue() and whenPrepared.hasValue()) implies whenHandedOver >= whenPrepared, xpath: not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)) whenPrepared
Definition Element Id MedicationDispense.identifier
Definition

Identifier assigned Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the dispensing facility - this resource itself is an identifier not appropriate. They are business identifiers assigned outside FHIR. to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

Note Short Display External identifier
Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..*
Type Identifier
Summary false
Comments

This is a business identifier, not a resource identifier.

Element Id MedicationDispense.basedOn
Definition

A plan that is fulfilled in whole or in part by this MedicationDispense.

Short Display Plan that is fulfilled by this dispense
Cardinality 0..*
Type Reference ( CarePlan )
Summary false
Definition Element Id MedicationDispense.partOf
Definition

The procedure or medication administration that triggered the dispense.

Short Display Event that dispense is done because of. part of
Control Cardinality 0..*
Type Reference ( Procedure | MedicationAdministration )
Summary false
Comments

While both a procedure and a medication administration may have triggered the dispense, but it is not expected that multiple procedures and/or multiple medication administrations would be triggers.

Definition Element Id MedicationDispense.status
Definition

A code specifying the state of the set of dispense events.

Short Display preparation | in-progress | cancelled | on-hold | completed | entered-in-error | unfulfilled | declined | unknown
Cardinality 0..1 1..1
Terminology Binding MedicationDispenseStatus MedicationDispense Status Codes ( Required )
Type code
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summary true
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Element Id MedicationDispense.notPerformedReason
Definition

Indicates the reason why a dispense was not performed.

Short Display Why a dispense was not performed
Cardinality 0..1
Terminology Binding MedicationDispense Status Reason Codes ( Example )
Type CodeableReference ( DetectedIssue )
Summary false
Element Id MedicationDispense.statusChanged
Definition

The date (and maybe time) when the status of the dispense record changed.

Short Display When the status changed
Cardinality 0..1
Type dateTime
Summary false
Definition Element Id MedicationDispense.category
Definition

Indicates the type of medication dispense and (for example, drug classification like ATC, where the medication is expected to meds would be consumed or administered. administered, legal category of the medication.).

Short Display Type of medication dispense
Control Cardinality 0..1 0..*
Terminology Binding MedicationDispenseCategory MedicationDispense Category Codes ( Preferred Example )
Type CodeableConcept
Summary false
Comments

The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

The committee will revisit these codes, expecting to use a codesystem from terminology.hl7.org icon.

Definition Element Id MedicationDispense.medication
Definition

Identifies the medication being administered. supplied (or intended to be supplied). 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.

Short Display What medication was (or was intended to be) supplied
Control Cardinality 1..1
Terminology Binding SNOMED CT Medication Codes ( Example )
Type CodeableConcept | Reference CodeableReference ( Medication )
[x] Note See Choice of Data Types for further information about how to use [x] Summary true
Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended.  recommended. For example if you require form or lot example, if you require form or lot number, then you must reference must reference the Medication resource. . resource.

Definition Element Id MedicationDispense.subject
Definition

A link to a resource representing the person or the group to whom the medication will be given.

Short Display Who the dispense is for
Cardinality 0..1 1..1
Type Reference ( Patient | Group )
Summary true
Comments

SubstanceAdministration->subject->Patient.

Definition Element Id MedicationDispense.encounter
Definition

The encounter or episode of care that establishes the context for this event.

Short Display Encounter associated with event
Cardinality 0..1
Type Reference ( Encounter | EpisodeOfCare )
Summary false
Definition Element Id MedicationDispense.supportingInformation
Definition

Additional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented.

Short Display Information that supports the dispensing of the medication
Cardinality 0..*
Type Reference ( Any )
Summary false
Definition Element Id MedicationDispense.performer
Definition

Indicates who or what performed the event. It should be assumed that the performer is

Short Display Who performed event
Cardinality 0..*
Summary false
Element Id MedicationDispense.performer.function
Definition

Distinguishes the dispenser type of performer in the medication. dispense. For example, date enterer, packager, final checker.

Short Display Who performed the dispense and what they did
Cardinality 0..1
0..* Terminology Binding MedicationDispense Performer Function Codes ( Example )
Comments Type CodeableConcept
Requirements

The performer will be reviewed as part Allows disambiguation of STU4. the types of involvement of different performers.

Summary false
Definition Element Id MedicationDispense.performer.actor
Definition

The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

Short Display Individual who was performing
Cardinality 1..1
Type Reference ( Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam | Group )
Summary false
Comments

The different performer functions within a dispense process can vary - and some of these functions may be restricted to clinical professionals - such distinction is usually specific to a jurisdiction and context. While performer.function and performer.actor don't add restrictions on which resources can be referenced, this element is expected to be used according to the local restrictions, for example not allowing Group (e.g., household) or RelatedPerson to be the dispenser.

Definition Element Id MedicationDispense.location
Definition

The organization principal physical location where the device or practitioner dispense was acting on behalf of. performed.

Short Display Where the dispense occurred
Cardinality 0..1
Type Reference ( Organization Location )
Summary false
Definition Element Id MedicationDispense.authorizingPrescription
Definition

Indicates the medication order that is being dispensed against.

Short Display Medication order that authorizes the dispense
Control Cardinality 0..*
Type Reference ( MedicationRequest )
Comments Summary false
Comments

Maps to basedOn in Event logical model.

Definition Element Id MedicationDispense.type
Definition

Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

Short Display Trial fill, partial fill, emergency fill, etc
Cardinality 0..1
Terminology Binding ActPharmacySupplyType icon ( Example )
Type CodeableConcept
Summary false
Definition Element Id MedicationDispense.quantity
Definition

The amount of medication that has been (or was intended to be) dispensed. Includes unit of measure.

Short Display Amount of medication
Cardinality 0..1
Type SimpleQuantity
Summary false
Definition Element Id MedicationDispense.daysSupply
Definition

The amount of medication expressed as a timing amount.

Short Display Amount of medication expressed as a timing amount
Cardinality 0..1
Type SimpleQuantity
Summary false
Element Id MedicationDispense.fillNumber
Definition

Represents the known number of the fill over the entire lifetime of the prescription, i.e. if this is the first dispense by this pharmacy but the third fill overall, then the fillNumber will be 3. Each fill number represents one dispensation, even if that dispensation is not for the full quantity. Partial fills are not represented by decimal quantities, i.e., a partial fill of 40 tablets (full quantity is 100 tablets) adds 1 to the prior fill number, not 0.4. This means that the 'fillNumber' may sometimes be higher than the MedicationRequest.numberOfRepeatsAllowed, as the latter assumes full fills, while fillNumber does not.

Short Display A number that represents the known fill this dispense represents
Cardinality 0..1
Type positiveInt
Summary false
Comments

This element may be inaccurate as it relies on the dispensing pharmacy to be aware of all fills that have occurred for the request.

Element Id MedicationDispense.recorded
Definition

The date the occurrence of the MedicationDispense was first captured in the system.

Short Display When the recording of the dispense started
Cardinality 0..1
Type dateTime
Summary false
Definition Element Id MedicationDispense.whenPrepared
Definition

The time when the dispensed product was packaged and reviewed.

Short Display When product was packaged and reviewed
Control Cardinality 0..1
Type dateTime
Summary true
Constraints
Affect this element
mdd-1 Rule whenHandedOver cannot be before whenPrepared (whenHandedOver.hasValue() and whenPrepared.hasValue()) implies whenHandedOver >= whenPrepared
Definition Element Id MedicationDispense.whenHandedOver
Definition

The time the dispensed product was provided to the patient or their representative.

Short Display When product was given out
Cardinality 0..1
Type dateTime
Summary false
Constraints
Affect this element
mdd-1 Rule whenHandedOver cannot be before whenPrepared (whenHandedOver.hasValue() and whenPrepared.hasValue()) implies whenHandedOver >= whenPrepared
Definition Element Id MedicationDispense.destination
Definition

Identification of the facility/location where the medication was was/will be shipped to, as part of the dispense event.

Short Display Where the medication was/will be sent
Cardinality 0..1
Type Reference ( Location )
Summary false
Definition Element Id MedicationDispense.receiver
Definition

Identifies the person who picked up the medication. medication or the location or organization where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. professional or a location, or organization.

Short Display Who collected the medication or where the medication was delivered
Control Cardinality 0..*
Type Reference ( Patient | Practitioner | RelatedPerson | Location | PractitionerRole | Organization | Group )
Summary false
Definition Element Id MedicationDispense.note
Definition

Extra information about the dispense that could not be conveyed in the other attributes.

Short Display Information about the dispense
Control Cardinality 0..*
Type Annotation
Summary false
Element Id MedicationDispense.renderedDosageInstruction
Definition

The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.

Short Display Full representation of the dosage instructions
Cardinality 0..1
Type markdown
Summary false
Comments

The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.

Definition Element Id MedicationDispense.dosageInstruction
Definition

Indicates how the medication is to be used by the patient.

Short Display How the medication is to be used by the patient or administered by the caregiver
Cardinality 0..*
Type Dosage
Summary false
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Element Id MedicationDispense.doseAdministrationAid
Definition

Provides information about the type of adherence packaging supplied for the medication dispense.

Short Display Type of adherence packaging to use for the dispense
Cardinality 0..1
Terminology Binding Medication Dose Aids ( Example )
Type CodeableConcept
Summary false
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Definition Element Id MedicationDispense.substitution
Definition

Indicates whether or not substitution was made as part of the dispense. In some cases 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.

Short Display Whether a substitution was performed on the dispense
Cardinality 0..1
Summary false
Definition Element Id MedicationDispense.substitution.wasSubstituted
Definition

True if the dispenser dispensed a different drug or product from what was prescribed.

Short Display Whether a substitution was or was not performed on the dispense
Cardinality 1..1
Type boolean
Summary false
Definition Element Id MedicationDispense.substitution.type
Definition

A code signifying whether a different drug was dispensed from what was prescribed.

Short Display Code signifying whether a different drug was dispensed from what was prescribed
Cardinality 0..1
Terminology Binding ActSubstanceAdminSubstitutionCode icon ( Example )
Type CodeableConcept
Summary false
Definition Element Id MedicationDispense.substitution.reason
Definition

Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.

Short Display Why was substitution made
Cardinality 0..*
Terminology Binding SubstanceAdminSubstitutionReason icon ( Example )
Type CodeableConcept
Definition The person or organization that has primary responsibility for the substitution. Control 0..* Type Summary Reference ( Practitioner ) false
Type Element Id Reference ( DetectedIssue ) MedicationDispense.substitution.responsibleParty
Contraindication; Drug Utilization Review (DUR); Alert Definition MedicationDispense.notDone

The person or organization that has primary responsibility for the substitution.

Definition Short Display True if the dispense was not performed Who is responsible for some reason. the substitution
Control Cardinality 0..1
Type boolean Reference ( Practitioner | PractitionerRole | Organization )
Summary MedicationDispense.notDoneReason[x] Definition Indicates the reason why a dispense was not performed. false
[x] Note Element Id See Choice of Data Types for further information about how to use [x] MedicationDispense.eventHistory
Definition

A summary of the events of interest that have occurred, such as when the dispense was verified.

Short Display A list of relevant lifecycle events
Cardinality 0..*
Type Reference ( Provenance )
Comments Summary false
Comments

This may might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).