Da Vinci Payer Data Exchange
2.2.1 - STU 2.2
Da Vinci Payer Data Exchange
2.2.1 - STU 2.2
Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense | Version: 2.2.1 | |||
| Standards status: Informative | Computable Name: PdexMedicationDispense | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.8.42.30 | ||||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
Prescription Medications dispensed by a pharmacy to a health plan member and paid for in full, or in part, by the health plan
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(7.0.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 | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:refillNum |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| status |
C | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) | ||||
 category |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |||||
 Slices for medication[x] |
1..1 | CodeableConcept | What medication was supplied Slice: Unordered, Closed by type:$this Binding: MedicationClinicalDrug (20240606)  (extensible)Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |||||
 subject |
1..1 | Reference(US Core Patient Profile(7.0.0) ) | The patient who is prescribed the medication | |||||
| context |
0..1 | Reference(US Core Encounter Profile(7.0.0) | EpisodeOfCare) | Encounter associated with MedicationDispense | |||||
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||
| performer |
0..* | BackboneElement | Who performed the dispense event | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
 actor |
1..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core Organization Profile(7.0.0) ) | Individual or device performing the dispense | |||||
| location |
0..1 | Reference(US Core Location Profile(7.0.0)) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(US Core MedicationRequest Profile(7.0.0)) | Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (3.0.0) (required) | |||||
| quantity |
C | 0..1 | SimpleQuantity | Billing, service, product, or drug code Binding: Common UCUM units (preferred)
Constraints: sqty-1 | ||||
| daysSupply |
C | 0..1 | SimpleQuantity | Medication expressed as a timing amount. Constraints: sqty-1 | ||||
| whenHandedOver |
C | 0..1 | dateTime | When product was given out or mailed | ||||
| dosageInstruction |
0..* | Dosage | 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 | Free text dosage instructions e.g. SIG | |||||
| timing |
0..1 | Timing | When medication should be administered | |||||
 doseAndRate |
0..* | Element | Amount of medication administered | |||||
  dose[x] |
0..1 | Amount of medication per dose Binding: Common UCUM units (preferred)
| ||||||
| doseQuantity |
Quantity (SimpleQuantity) | |||||||
| doseRange |
Range | |||||||
| substitution |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.category | Base | required | Medication dispense category codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | extensible |
Medication Clinical Drug
|
📍20240606 | VSAC v0.24 |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | required | FDA National Drug Code (NDC) | 📦2.2.1 | This IG |
| MedicationDispense.type | Base | required | ActPharmacySupplyType | 📍3.0.0 | THO v7.2 |
| 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 |
This structure is derived from USCoreMedicationDispenseProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationDispense |
0..* | USCoreMedicationDispenseProfile(7.0.0) | Dispensing a medication to a named patient | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:refillNum |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |
 status |
1..1 | code | completed Binding: MedicationDispense Status Codes (required) | |
| category |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |
| Slices for medication[x] |
1..1 | CodeableConcept | What medication was supplied Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |
| subject |
1..1 | Reference(US Core Patient Profile(7.0.0)) | The patient who is prescribed the medication | |
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |
| performer |
0..* | BackboneElement | Who performed the dispense event | |
| actor |
1..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core Organization Profile(7.0.0)) | Individual or device performing the dispense | |
| location |
0..1 | Reference(US Core Location Profile(7.0.0)) | Where the dispense occurred | |
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (3.0.0) (required) | |
| quantity |
0..1 | SimpleQuantity | Billing, service, product, or drug code | |
| daysSupply |
0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
| substitution |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |
| wasSubstituted |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.category | Base | required | Medication dispense category codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | required | FDA National Drug Code (NDC) | 📦2.2.1 | This IG |
| MedicationDispense.type | Base | required | ActPharmacySupplyType | 📍3.0.0 | THO v7.2 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | USCoreMedicationDispenseProfile(7.0.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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:refillNum |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External identifier | |||||
| partOf |
0..* | Reference(Procedure) | Event that dispense is part of | |||||
| status |
C | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) | ||||
| 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 dispense action Binding: MedicationDispense Category Codes (required) | |||||
| Slices for medication[x] |
1..1 | CodeableConcept | What medication was supplied Slice: Unordered, Closed by type:$this Binding: MedicationClinicalDrug (20240606) (extensible)Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |||||
| subject |
1..1 | Reference(US Core Patient Profile(7.0.0) ) | The patient who is prescribed the medication | |||||
| context |
0..1 | Reference(US Core Encounter Profile(7.0.0) | EpisodeOfCare) | Encounter associated with MedicationDispense | |||||
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||
| performer |
0..* | BackboneElement | Who performed the dispense 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(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core Organization Profile(7.0.0) ) | Individual or device performing the dispense | |||||
| location |
0..1 | Reference(US Core Location Profile(7.0.0)) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(US Core MedicationRequest Profile(7.0.0)) | Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (3.0.0) (required) | |||||
| quantity |
C | 0..1 | SimpleQuantity | Billing, service, product, or drug code Binding: Common UCUM units (preferred)
Constraints: sqty-1 | ||||
| daysSupply |
C | 0..1 | SimpleQuantity | Medication expressed as a timing amount. Constraints: sqty-1 | ||||
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |||||
| whenHandedOver |
C | 0..1 | dateTime | 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 | 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 | 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 | 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 | 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 | Amount of medication per dose Binding: Common UCUM units (preferred)
| ||||||
| doseQuantity |
Quantity (SimpleQuantity) | |||||||
| 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 (3.0.0) (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 (3.0.0) (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 | required | Medication dispense category codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | extensible |
Medication Clinical Drug
|
📍20240606 | VSAC v0.24 |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | required | FDA National Drug Code (NDC) | 📦2.2.1 | This IG |
| MedicationDispense.performer.function | Base | example | Medication dispense performer function codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.type | Base | required | ActPharmacySupplyType | 📍3.0.0 | THO v7.2 |
| 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.2 |
| MedicationDispense.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📍3.0.0 | THO v7.2 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from USCoreMedicationDispenseProfile
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | USCoreMedicationDispenseProfile(7.0.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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:refillNum |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| status |
C | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) | ||||
| category |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |||||
| Slices for medication[x] |
1..1 | CodeableConcept | What medication was supplied Slice: Unordered, Closed by type:$this Binding: MedicationClinicalDrug (20240606) (extensible)Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |||||
| subject |
1..1 | Reference(US Core Patient Profile(7.0.0) ) | The patient who is prescribed the medication | |||||
| context |
0..1 | Reference(US Core Encounter Profile(7.0.0) | EpisodeOfCare) | Encounter associated with MedicationDispense | |||||
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||
| performer |
0..* | BackboneElement | Who performed the dispense event | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| actor |
1..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core Organization Profile(7.0.0) ) | Individual or device performing the dispense | |||||
| location |
0..1 | Reference(US Core Location Profile(7.0.0)) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(US Core MedicationRequest Profile(7.0.0)) | Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (3.0.0) (required) | |||||
| quantity |
C | 0..1 | SimpleQuantity | Billing, service, product, or drug code Binding: Common UCUM units (preferred)
Constraints: sqty-1 | ||||
| daysSupply |
C | 0..1 | SimpleQuantity | Medication expressed as a timing amount. Constraints: sqty-1 | ||||
| whenHandedOver |
C | 0..1 | dateTime | When product was given out or mailed | ||||
| dosageInstruction |
0..* | Dosage | 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 | Free text dosage instructions e.g. SIG | |||||
| timing |
0..1 | Timing | When medication should be administered | |||||
| doseAndRate |
0..* | Element | Amount of medication administered | |||||
| dose[x] |
0..1 | Amount of medication per dose Binding: Common UCUM units (preferred)
| ||||||
| doseQuantity |
Quantity (SimpleQuantity) | |||||||
| doseRange |
Range | |||||||
| substitution |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.category | Base | required | Medication dispense category codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | extensible |
Medication Clinical Drug
|
📍20240606 | VSAC v0.24 |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | required | FDA National Drug Code (NDC) | 📦2.2.1 | This IG |
| MedicationDispense.type | Base | required | ActPharmacySupplyType | 📍3.0.0 | THO v7.2 |
| 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 |
Differential View
This structure is derived from USCoreMedicationDispenseProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationDispense |
0..* | USCoreMedicationDispenseProfile(7.0.0) | Dispensing a medication to a named patient | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:refillNum |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |
| status |
1..1 | code | completed Binding: MedicationDispense Status Codes (required) | |
| category |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |
| Slices for medication[x] |
1..1 | CodeableConcept | What medication was supplied Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |
| subject |
1..1 | Reference(US Core Patient Profile(7.0.0)) | The patient who is prescribed the medication | |
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |
| performer |
0..* | BackboneElement | Who performed the dispense event | |
| actor |
1..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core Organization Profile(7.0.0)) | Individual or device performing the dispense | |
| location |
0..1 | Reference(US Core Location Profile(7.0.0)) | Where the dispense occurred | |
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (3.0.0) (required) | |
| quantity |
0..1 | SimpleQuantity | Billing, service, product, or drug code | |
| daysSupply |
0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
| substitution |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |
| wasSubstituted |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.category | Base | required | Medication dispense category codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | required | FDA National Drug Code (NDC) | 📦2.2.1 | This IG |
| MedicationDispense.type | Base | required | ActPharmacySupplyType | 📍3.0.0 | THO v7.2 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | USCoreMedicationDispenseProfile(7.0.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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:refillNum |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External identifier | |||||
| partOf |
0..* | Reference(Procedure) | Event that dispense is part of | |||||
| status |
C | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) | ||||
| 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 dispense action Binding: MedicationDispense Category Codes (required) | |||||
| Slices for medication[x] |
1..1 | CodeableConcept | What medication was supplied Slice: Unordered, Closed by type:$this Binding: MedicationClinicalDrug (20240606) (extensible)Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| medication[x]:medicationCodeableConcept |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |||||
| subject |
1..1 | Reference(US Core Patient Profile(7.0.0) ) | The patient who is prescribed the medication | |||||
| context |
0..1 | Reference(US Core Encounter Profile(7.0.0) | EpisodeOfCare) | Encounter associated with MedicationDispense | |||||
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||
| performer |
0..* | BackboneElement | Who performed the dispense 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(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core Organization Profile(7.0.0) ) | Individual or device performing the dispense | |||||
| location |
0..1 | Reference(US Core Location Profile(7.0.0)) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(US Core MedicationRequest Profile(7.0.0)) | Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (3.0.0) (required) | |||||
| quantity |
C | 0..1 | SimpleQuantity | Billing, service, product, or drug code Binding: Common UCUM units (preferred)
Constraints: sqty-1 | ||||
| daysSupply |
C | 0..1 | SimpleQuantity | Medication expressed as a timing amount. Constraints: sqty-1 | ||||
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |||||
| whenHandedOver |
C | 0..1 | dateTime | 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 | 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 | 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 | 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 | 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 | Amount of medication per dose Binding: Common UCUM units (preferred)
| ||||||
| doseQuantity |
Quantity (SimpleQuantity) | |||||||
| 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 (3.0.0) (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 (3.0.0) (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 | required | Medication dispense category codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | extensible |
Medication Clinical Drug
|
📍20240606 | VSAC v0.24 |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | required | FDA National Drug Code (NDC) | 📦2.2.1 | This IG |
| MedicationDispense.performer.function | Base | example | Medication dispense performer function codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.type | Base | required | ActPharmacySupplyType | 📍3.0.0 | THO v7.2 |
| 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.2 |
| MedicationDispense.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📍3.0.0 | THO v7.2 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from USCoreMedicationDispenseProfile
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pdex#2.2.1 based on FHIR 4.0.1. Generated 2026-11-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change