haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://haau3.com/fhir/StructureDefinition/haau3-medication-dispense | Version: 1.0.0 | |||
| Draft as of 2026-10-14 | Computable Name: Haau3MedicationDispense | |||
A pharmacy dispense recorded about a care recipient — a fill or refill handed over. Delivered exactly as the source system stated it, naming both the medication and the prescription it filled; hand-over time and quantity are present, preparation time and days-supply are not sent by current sources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||
|---|---|---|---|---|---|---|---|---|
  MedicationDispense |
C | 0..* | USCoreMedicationDispenseProfile(6.1.0) | Dispensing a medication to a named patient Constraints: mdd-1, us-core-20 | ||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
 identifier |
1..* | Identifier | External identifier | |||||
| status |
C | 1..1 | code | (USCDI) preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. | ||||
  medication[x] |
1..1 | (USCDI) What medication was supplied Binding: Medication Clinical Drug  (extensible) | ||||||
 medicationCodeableConcept |
CodeableConcept | |||||||
  medicationReference |
Reference(US Core Medication Profile) | |||||||
| subject |
1..1 | Reference(US Core Patient Profile) | (USCDI) Who the dispense is for | |||||
| performer |
0..* | BackboneElement | (USCDI) Who performed event | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| actor |
1..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | (USCDI) Individual who was performing | |||||
| authorizingPrescription |
0..* | Reference(US Core MedicationRequest Profile) | (USCDI) Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | (USCDI) Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | |||||
| quantity |
0..1 | Quantity | (USCDI) Amount dispensed Binding: Common UCUM units (preferred)
| |||||
| whenHandedOver |
C | 0..1 | dateTime | (USCDI) When product was given out or mailed | ||||
 dosageInstruction |
0..* | Dosage | (USCDI) How the medication is to be used by the patient or administered by the caregiver | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| text |
0..1 | string | (USCDI) Free text dosage instructions e.g. SIG | |||||
| timing |
0..1 | Timing | (USCDI) When medication should be administered | |||||
| doseAndRate |
0..* | Element | (USCDI) Amount of medication administered | |||||
| dose[x] |
0..1 | (USCDI) Amount of medication per dose Binding: Common UCUM units (preferred)
| ||||||
| doseQuantity |
Quantity | |||||||
| doseRange |
Range | |||||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | extensible |
Medication Clinical Drug
|
📦20170601 | VSAC v0.11 |
| MedicationDispense.type | Base | extensible | ActPharmacySupplyType | 📦3.0.0 | THO v7.4 |
| MedicationDispense.quantity | Base | preferred | Common UCUM units | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.doseAndRate.dose[x] | Base | preferred | Common UCUM units | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared |
whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
|
| us-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" |
status='completed' implies whenHandedOver.exists()
|
This structure is derived from USCoreMedicationDispenseProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationDispense |
0..* | USCoreMedicationDispenseProfile(6.1.0) | Dispensing a medication to a named patient | |
 identifier |
1..* | Identifier | External identifier | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | USCoreMedicationDispenseProfile(6.1.0) | Dispensing a medication to a named patient Constraints: mdd-1, us-core-20 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | External identifier | |||||
| partOf |
0..* | Reference(Procedure) | Event that dispense is part of | |||||
| status |
C | 1..1 | code | (USCDI) preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. | ||||
| statusReason[x] |
0..1 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
| statusReasonCodeableConcept |
CodeableConcept | |||||||
| statusReasonReference |
Reference(DetectedIssue) | |||||||
| category |
0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered. | |||||
| medication[x] |
1..1 | (USCDI) What medication was supplied Binding: Medication Clinical Drug (extensible) | ||||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(US Core Medication Profile) | |||||||
| subject |
1..1 | Reference(US Core Patient Profile) | (USCDI) Who the dispense is for | |||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |||||
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||
| performer |
0..* | BackboneElement | (USCDI) Who performed event | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication. | |||||
| actor |
1..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | (USCDI) Individual who was performing | |||||
| location |
0..1 | Reference(Location) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(US Core MedicationRequest Profile) | (USCDI) Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | (USCDI) Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | |||||
| quantity |
0..1 | Quantity | (USCDI) Amount dispensed Binding: Common UCUM units (preferred)
| |||||
| daysSupply |
C | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount Constraints: sqty-1 | ||||
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |||||
| whenHandedOver |
C | 0..1 | dateTime | (USCDI) When product was given out or mailed | ||||
| destination |
0..1 | Reference(Location) | Where the medication was sent | |||||
| receiver |
0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||
| note |
0..* | Annotation | Information about the dispense | |||||
| dosageInstruction |
0..* | Dosage | (USCDI) How the medication is to be used by the patient or administered by the caregiver | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| sequence |
0..1 | integer | The order of the dosage instructions | |||||
| text |
0..1 | string | (USCDI) Free text dosage instructions e.g. SIG | |||||
| additionalInstruction |
0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | |||||
| patientInstruction |
0..1 | string | Patient or consumer oriented instructions | |||||
| timing |
0..1 | Timing | (USCDI) When medication should be administered | |||||
| asNeeded[x] |
0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A 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. | ||||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| site |
0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| method |
0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| doseAndRate |
0..* | Element | (USCDI) Amount of medication administered | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | |||||
| dose[x] |
0..1 | (USCDI) Amount of medication per dose Binding: Common UCUM units (preferred)
| ||||||
| doseQuantity |
Quantity | |||||||
| doseRange |
Range | |||||||
| rate[x] |
0..1 | Amount of medication per unit of time | ||||||
| rateRatio |
Ratio | |||||||
| rateRange |
Range | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| maxDosePerPeriod |
0..1 | Ratio | Upper limit on medication per unit of time | |||||
| maxDosePerAdministration |
C | 0..1 | SimpleQuantity | Upper limit on medication per administration Constraints: sqty-1 | ||||
| maxDosePerLifetime |
C | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient Constraints: sqty-1 | ||||
| substitution |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| wasSubstituted |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||
| type |
0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. | |||||
| reason |
0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
| responsibleParty |
0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |||||
| detectedIssue |
0..* | Reference(DetectedIssue) | Clinical issue with action | |||||
| eventHistory |
0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.statusReason[x] | Base | example | Medication dispense status reason codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.category | Base | preferred | Medication dispense category codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | extensible |
Medication Clinical Drug
|
📦20170601 | VSAC v0.11 |
| MedicationDispense.performer.function | Base | example | Medication dispense performer function codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.type | Base | extensible | ActPharmacySupplyType | 📦3.0.0 | THO v7.4 |
| MedicationDispense.quantity | Base | preferred | Common UCUM units | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.route | Base | example | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.method | Base | example | SNOMED CT Administration Method Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.doseAndRate.dose[x] | Base | preferred | Common UCUM units | 📦4.0.1 | FHIR Std. |
| MedicationDispense.substitution.type | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationDispense.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.4 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared |
whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
|
| sqty-1 | error | MedicationDispense.daysSupply, MedicationDispense.dosageInstruction.maxDosePerAdministration, MedicationDispense.dosageInstruction.maxDosePerLifetime | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
| us-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" |
status='completed' implies whenHandedOver.exists()
|
This structure is derived from USCoreMedicationDispenseProfile
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | USCoreMedicationDispenseProfile(6.1.0) | Dispensing a medication to a named patient Constraints: mdd-1, us-core-20 | ||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | External identifier | |||||
| status |
C | 1..1 | code | (USCDI) preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. | ||||
| medication[x] |
1..1 | (USCDI) What medication was supplied Binding: Medication Clinical Drug (extensible) | ||||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(US Core Medication Profile) | |||||||
| subject |
1..1 | Reference(US Core Patient Profile) | (USCDI) Who the dispense is for | |||||
| performer |
0..* | BackboneElement | (USCDI) Who performed event | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| actor |
1..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | (USCDI) Individual who was performing | |||||
| authorizingPrescription |
0..* | Reference(US Core MedicationRequest Profile) | (USCDI) Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | (USCDI) Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | |||||
| quantity |
0..1 | Quantity | (USCDI) Amount dispensed Binding: Common UCUM units (preferred)
| |||||
| whenHandedOver |
C | 0..1 | dateTime | (USCDI) When product was given out or mailed | ||||
| dosageInstruction |
0..* | Dosage | (USCDI) How the medication is to be used by the patient or administered by the caregiver | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| text |
0..1 | string | (USCDI) Free text dosage instructions e.g. SIG | |||||
| timing |
0..1 | Timing | (USCDI) When medication should be administered | |||||
| doseAndRate |
0..* | Element | (USCDI) Amount of medication administered | |||||
| dose[x] |
0..1 | (USCDI) Amount of medication per dose Binding: Common UCUM units (preferred)
| ||||||
| doseQuantity |
Quantity | |||||||
| doseRange |
Range | |||||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | extensible |
Medication Clinical Drug
|
📦20170601 | VSAC v0.11 |
| MedicationDispense.type | Base | extensible | ActPharmacySupplyType | 📦3.0.0 | THO v7.4 |
| MedicationDispense.quantity | Base | preferred | Common UCUM units | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.doseAndRate.dose[x] | Base | preferred | Common UCUM units | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared |
whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
|
| us-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" |
status='completed' implies whenHandedOver.exists()
|
Differential View
This structure is derived from USCoreMedicationDispenseProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationDispense |
0..* | USCoreMedicationDispenseProfile(6.1.0) | Dispensing a medication to a named patient | |
| identifier |
1..* | Identifier | External identifier | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | USCoreMedicationDispenseProfile(6.1.0) | Dispensing a medication to a named patient Constraints: mdd-1, us-core-20 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | External identifier | |||||
| partOf |
0..* | Reference(Procedure) | Event that dispense is part of | |||||
| status |
C | 1..1 | code | (USCDI) preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. | ||||
| statusReason[x] |
0..1 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
| statusReasonCodeableConcept |
CodeableConcept | |||||||
| statusReasonReference |
Reference(DetectedIssue) | |||||||
| category |
0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered. | |||||
| medication[x] |
1..1 | (USCDI) What medication was supplied Binding: Medication Clinical Drug (extensible) | ||||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(US Core Medication Profile) | |||||||
| subject |
1..1 | Reference(US Core Patient Profile) | (USCDI) Who the dispense is for | |||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |||||
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||
| performer |
0..* | BackboneElement | (USCDI) Who performed event | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication. | |||||
| actor |
1..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | (USCDI) Individual who was performing | |||||
| location |
0..1 | Reference(Location) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(US Core MedicationRequest Profile) | (USCDI) Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | (USCDI) Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | |||||
| quantity |
0..1 | Quantity | (USCDI) Amount dispensed Binding: Common UCUM units (preferred)
| |||||
| daysSupply |
C | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount Constraints: sqty-1 | ||||
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |||||
| whenHandedOver |
C | 0..1 | dateTime | (USCDI) When product was given out or mailed | ||||
| destination |
0..1 | Reference(Location) | Where the medication was sent | |||||
| receiver |
0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||
| note |
0..* | Annotation | Information about the dispense | |||||
| dosageInstruction |
0..* | Dosage | (USCDI) How the medication is to be used by the patient or administered by the caregiver | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| sequence |
0..1 | integer | The order of the dosage instructions | |||||
| text |
0..1 | string | (USCDI) Free text dosage instructions e.g. SIG | |||||
| additionalInstruction |
0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | |||||
| patientInstruction |
0..1 | string | Patient or consumer oriented instructions | |||||
| timing |
0..1 | Timing | (USCDI) When medication should be administered | |||||
| asNeeded[x] |
0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A 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. | ||||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| site |
0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| method |
0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| doseAndRate |
0..* | Element | (USCDI) Amount of medication administered | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | |||||
| dose[x] |
0..1 | (USCDI) Amount of medication per dose Binding: Common UCUM units (preferred)
| ||||||
| doseQuantity |
Quantity | |||||||
| doseRange |
Range | |||||||
| rate[x] |
0..1 | Amount of medication per unit of time | ||||||
| rateRatio |
Ratio | |||||||
| rateRange |
Range | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| maxDosePerPeriod |
0..1 | Ratio | Upper limit on medication per unit of time | |||||
| maxDosePerAdministration |
C | 0..1 | SimpleQuantity | Upper limit on medication per administration Constraints: sqty-1 | ||||
| maxDosePerLifetime |
C | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient Constraints: sqty-1 | ||||
| substitution |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| wasSubstituted |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||
| type |
0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. | |||||
| reason |
0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
| responsibleParty |
0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |||||
| detectedIssue |
0..* | Reference(DetectedIssue) | Clinical issue with action | |||||
| eventHistory |
0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.statusReason[x] | Base | example | Medication dispense status reason codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.category | Base | preferred | Medication dispense category codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | extensible |
Medication Clinical Drug
|
📦20170601 | VSAC v0.11 |
| MedicationDispense.performer.function | Base | example | Medication dispense performer function codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.type | Base | extensible | ActPharmacySupplyType | 📦3.0.0 | THO v7.4 |
| MedicationDispense.quantity | Base | preferred | Common UCUM units | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.route | Base | example | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.method | Base | example | SNOMED CT Administration Method Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.doseAndRate.dose[x] | Base | preferred | Common UCUM units | 📦4.0.1 | FHIR Std. |
| MedicationDispense.substitution.type | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationDispense.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.4 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared |
whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
|
| sqty-1 | error | MedicationDispense.daysSupply, MedicationDispense.dosageInstruction.maxDosePerAdministration, MedicationDispense.dosageInstruction.maxDosePerLifetime | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
| us-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" |
status='completed' implies whenHandedOver.exists()
|
This structure is derived from USCoreMedicationDispenseProfile
Other representations of profile: CSV, Excel, Schematron