STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

D.4.1.4 StructureDefinition: DAF-MedicationDispense - Detailed Descriptions

Definitions for the daf-medicationdispense Profile.

MedicationDispense(DAFMedicationDispense)
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.

Control0..*
Comments

The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html).

InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (xpath: not(parent::f:contained and f:text))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (xpath: not(parent::f:contained and f:contained))
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (xpath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])))
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (xpath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)))
mdd-1: whenHandedOver cannot be before whenPrepared (xpath: not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value))
MedicationDispense.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

MedicationDispense.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
MedicationDispense.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

MedicationDispense.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

MedicationDispense.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

MedicationDispense.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

MedicationDispense.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationDispense.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationDispense.identifier
Definition

Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Must Supporttrue
MedicationDispense.status
Definition

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

Control0..1
BindingA coded concept specifying the state of the dispense event.
The codes SHALL be taken from MedicationDispenseStatus
Typecode
Is Modifiertrue
Must Supporttrue
MedicationDispense.medication[x]
Definition

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.

Control1..1
BindingPrescribable medications
The codes SHALL be taken from Medication Clinical Drug (RxNorm); other codes may be used where these codes are not suitable
TypeChoice of: CodeableConcept, Reference(Profile daf-core-medication)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
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. Note: do not use Medication.name to describe the dispensed medication. When the only available information is a text description of the medication, Medication.code.text should be used.

MedicationDispense.patient
Definition

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

Control1..1
TypeReference(Profile daf-patient)
Must Supporttrue
Comments

SubstanceAdministration->subject->Patient.

MedicationDispense.dispenser
Definition

The individual responsible for dispensing the medication.

Control0..1
TypeReference(Profile daf-pract)
Must Supporttrue
MedicationDispense.dispensingOrganization
Definition

The organizaation responsible for the dispense of the medication.

Control0..1
TypeReference(Organization)
MedicationDispense.authorizingPrescription
Definition

Indicates the medication order that is being dispensed against.

Control0..*
TypeReference(Profile daf-medicationorder)
Must Supporttrue
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.

Control0..1
BindingIndicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
For example codes, see ActPharmacySupplyType
TypeCodeableConcept
MedicationDispense.quantity
Definition

The amount of medication that has been dispensed. Includes unit of measure.

Control0..1
TypeQuantity(SimpleQuantity)
MedicationDispense.daysSupply
Definition

The amount of medication expressed as a timing amount.

Control0..1
TypeQuantity(SimpleQuantity)
MedicationDispense.whenPrepared
Definition

The time when the dispensed product was packaged and reviewed.

Control0..1
TypedateTime
MedicationDispense.whenHandedOver
Definition

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

Control0..1
TypedateTime
MedicationDispense.destination
Definition

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

Control0..1
TypeReference(Location)
MedicationDispense.receiver
Definition

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.

Control0..*
TypeChoice of: Reference(Patient), Reference(Practitioner)
MedicationDispense.note
Definition

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

Control0..*
TypeAnnotation
MedicationDispense.dosageInstruction
Definition

Indicates how the medication is to be used by the patient. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Control0..*
TypeBackboneElement
Must Supporttrue
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.

MedicationDispense.dosageInstruction.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
MedicationDispense.dosageInstruction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationDispense.dosageInstruction.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationDispense.dosageInstruction.text
Definition

Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.

Control0..1
Typestring
MedicationDispense.dosageInstruction.additionalInstructions
Definition

Additional instructions such as "Swallow with plenty of water" which may or may not be coded.

Control0..1
BindingA coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery"
For example codes, see SNOMED CT Additional Dosage Instructions
TypeCodeableConcept
Must Supporttrue
MedicationDispense.dosageInstruction.timing
Definition

The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example, "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Control0..1
TypeTiming
Must Supporttrue
MedicationDispense.dosageInstruction.asNeeded[x]
Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule.

Control0..1
BindingA coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
For example codes, see SNOMED CT Medication As Needed Reason Codes
TypeChoice of: boolean, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
MedicationDispense.dosageInstruction.siteCodeableConcept
Definition

A coded specification of the anatomic site where the medication first enters the body.

Control0..1
BindingThis identifies the body site at which the substance was administered
The codes SHOULD be taken from Vaccine Administered Body Site
TypeCodeableConcept
Must Supporttrue
MedicationDispense.dosageInstruction.route
Definition

A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.

Control0..1
BindingThis identifies the route of substance administration.
The codes SHOULD be taken from Medication Route FDA Value Set
TypeCodeableConcept
Must Supporttrue
MedicationDispense.dosageInstruction.method
Definition

A coded value indicating the method by which the medication is intended to be or was introduced into or on the body.

Control0..1
BindingA coded concept describing the technique by which the medicine is administered
For example codes, see SNOMED CT Administration Method Codes
TypeCodeableConcept
Comments

This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.

MedicationDispense.dosageInstruction.dose[x]
Definition

The amount of therapeutic or other substance given at one administration event.

Control0..1
TypeChoice of: Range, Quantity(SimpleQuantity)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

Note that this specifies the quantity of the specified medication, not the quantity of active ingredient(s). The prescribed strength can be calculated by multiplying the doseQuantity by the strength of each active ingredient in the prescribed Medication. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule.

MedicationDispense.dosageInstruction.rate[x]
Definition

Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Control0..1
TypeChoice of: Ratio, Range, Quantity(SimpleQuantity)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
MedicationDispense.dosageInstruction.maxDosePerPeriod
Definition

The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.

Control0..1
TypeRatio
Must Supporttrue
MedicationDispense.substitution
Definition

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.

Control0..1
TypeBackboneElement
MedicationDispense.substitution.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
MedicationDispense.substitution.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationDispense.substitution.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationDispense.substitution.type
Definition

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

Control1..1
BindingA coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription
For example codes, see ActSubstanceAdminSubstitutionCode
TypeCodeableConcept
MedicationDispense.substitution.reason
Definition

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

Control0..*
BindingA coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed
For example codes, see SubstanceAdminSubstitutionReason
TypeCodeableConcept
MedicationDispense.substitution.responsibleParty
Definition

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

Control0..*
TypeReference(Practitioner)
MedicationDispense.eventHistory
Definition

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

Control0..*
TypeBackboneElement
Comments

This is not the same as an audit trail. It is a view of the important things that happened in the past. Typically, there would only be one entry for any given status, and systems may not record all the status events.

MedicationDispense.eventHistory.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
MedicationDispense.eventHistory.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationDispense.eventHistory.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationDispense.eventHistory.status
Definition

The status for the event.

Control1..1
BindingA coded concept specifying the state of the dispense event.
The codes SHALL be taken from MedicationDispenseStatus
Typecode
MedicationDispense.eventHistory.action
Definition

The action that was taken (e.g. verify).

Control0..1
BindingA coded concept describing an action taken on a medication dispense.
TypeCodeableConcept
MedicationDispense.eventHistory.dateTime
Definition

The date/time at which the event occurred.

Control1..1
TypedateTime
MedicationDispense.eventHistory.actor
Definition

The person responsible for taking the action.

Control0..1
TypeReference(Practitioner)
MedicationDispense.eventHistory.reason
Definition

The reason why the action was taken.

Control0..1
BindingA coded concept describing the reason for an action taken on a medication dispense.
TypeCodeableConcept