This page is part of the Da Vinci Payer Data Exchange (v2.1.0-ballot: STU2.1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense | Version: 2.1.0-ballot | |||
Standards status: Trial-use | Computable Name: PdexMedicationDispense | |||
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
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreMedicationDispenseProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreMedicationDispenseProfile | Dispensing a medication to a named patient | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |
![]() ![]() ![]() |
1..1 | code | completed Binding: MedicationDispense Status Codes (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |
![]() ![]() ![]() |
1..1 | CodeableConcept | (USCDI) What medication was supplied Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |
![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile(6.1.0)) | The patient who is prescribed the medication | |
![]() ![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |
![]() ![]() ![]() |
0..* | BackboneElement | Who performed the dispense event | |
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Practitioner Profile(6.1.0) | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Individual or device performing the dispense | |
![]() ![]() ![]() |
0..1 | Reference(US Core Location Profile(6.1.0)) | Where the dispense occurred | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (required) | |
![]() ![]() ![]() |
0..1 | SimpleQuantity | Billing, service, product, or drug code | |
![]() ![]() ![]() |
0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense |
![]() |
Path | Conformance | ValueSet | URI |
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status from the FHIR Standard | |
MedicationDispense.category | required | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category from the FHIR Standard | |
MedicationDispense.medication[x]:medicationCodeableConcept | required | FDANationalDrugCodehttp://hl7.org/fhir/us/davinci-pdex/ValueSet/FDANationalDrugCode from this IG | |
MedicationDispense.type | required | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreMedicationDispenseProfile | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared us-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
?!SΣC | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) What medication was supplied Slice: Unordered, Closed by type:$this Binding: Medication Clinical Drug ![]() | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | The patient who is prescribed the medication | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who performed the dispense event | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Individual or device performing the dispense | ||||
![]() ![]() ![]() |
0..1 | Reference(US Core Location Profile(6.1.0)) | Where the dispense occurred | |||||
![]() ![]() ![]() |
S | 0..* | Reference(US Core MedicationRequest Profile(6.1.0)) | (USCDI) Medication order that authorizes the dispense | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (required) | ||||
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | Billing, service, product, or drug code Binding: Common UCUM units (preferred)
qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
0..1 | SimpleQuantity | Medication expressed as a timing amount. | |||||
![]() ![]() ![]() |
SC | 0..1 | dateTime | (USCDI) When product was given out or mailed | ||||
![]() ![]() ![]() |
S | 0..* | Dosage | (USCDI) How the medication is to be used by the patient or administered by the caregiver | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Free text dosage instructions e.g. SIG | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Timing | (USCDI) When medication should be administered | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Element | (USCDI) Amount of medication administered | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | (USCDI) Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status from the FHIR Standard | ||||
MedicationDispense.category | required | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category from the FHIR Standard | ||||
MedicationDispense.medication[x] | extensible | MedicationClinicalDrug ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | ||||
MedicationDispense.medication[x]:medicationCodeableConcept | required | FDANationalDrugCodehttp://hl7.org/fhir/us/davinci-pdex/ValueSet/FDANationalDrugCode from this IG | ||||
MedicationDispense.type | required | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreMedicationDispenseProfile | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared us-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | External identifier | |||||
![]() ![]() ![]() |
0..* | Reference(Procedure) | Event that dispense is part of | |||||
![]() ![]() ![]() |
?!SΣC | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) | ||||
![]() ![]() ![]() |
0..1 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(DetectedIssue) | |||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) What medication was supplied Slice: Unordered, Closed by type:$this Binding: Medication Clinical Drug ![]() | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | The patient who is prescribed the medication | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who performed the dispense event | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0) S) | Individual or device performing the dispense | ||||
![]() ![]() ![]() |
0..1 | Reference(US Core Location Profile(6.1.0)) | Where the dispense occurred | |||||
![]() ![]() ![]() |
S | 0..* | Reference(US Core MedicationRequest Profile(6.1.0)) | (USCDI) Medication order that authorizes the dispense | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (required) | ||||
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | Billing, service, product, or drug code Binding: Common UCUM units (preferred)
qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
0..1 | SimpleQuantity | Medication expressed as a timing amount. | |||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When product was packaged and reviewed | ||||
![]() ![]() ![]() |
SC | 0..1 | dateTime | (USCDI) When product was given out or mailed | ||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where the medication was sent | |||||
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||
![]() ![]() ![]() |
0..* | Annotation | Information about the dispense | |||||
![]() ![]() ![]() |
S | 0..* | Dosage | (USCDI) How the medication is to be used by the patient or administered by the caregiver | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Free text dosage instructions e.g. SIG | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Timing | (USCDI) When medication should be administered | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | |||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Element | (USCDI) Amount of medication administered | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | (USCDI) Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity S | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |||||
![]() ![]() ![]() |
0..* | Reference(DetectedIssue) | Clinical issue with action | |||||
![]() ![]() ![]() |
0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status from the FHIR Standard | ||||
MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason from the FHIR Standard | ||||
MedicationDispense.category | required | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category from the FHIR Standard | ||||
MedicationDispense.medication[x] | extensible | MedicationClinicalDrug ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | ||||
MedicationDispense.medication[x]:medicationCodeableConcept | required | FDANationalDrugCodehttp://hl7.org/fhir/us/davinci-pdex/ValueSet/FDANationalDrugCode from this IG | ||||
MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-function from the FHIR Standard | ||||
MedicationDispense.type | required | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
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:
Differential View
This structure is derived from USCoreMedicationDispenseProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreMedicationDispenseProfile | Dispensing a medication to a named patient | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |
![]() ![]() ![]() |
1..1 | code | completed Binding: MedicationDispense Status Codes (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |
![]() ![]() ![]() |
1..1 | CodeableConcept | (USCDI) What medication was supplied Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |
![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile(6.1.0)) | The patient who is prescribed the medication | |
![]() ![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |
![]() ![]() ![]() |
0..* | BackboneElement | Who performed the dispense event | |
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Practitioner Profile(6.1.0) | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Individual or device performing the dispense | |
![]() ![]() ![]() |
0..1 | Reference(US Core Location Profile(6.1.0)) | Where the dispense occurred | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (required) | |
![]() ![]() ![]() |
0..1 | SimpleQuantity | Billing, service, product, or drug code | |
![]() ![]() ![]() |
0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense |
![]() |
Path | Conformance | ValueSet | URI |
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status from the FHIR Standard | |
MedicationDispense.category | required | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category from the FHIR Standard | |
MedicationDispense.medication[x]:medicationCodeableConcept | required | FDANationalDrugCodehttp://hl7.org/fhir/us/davinci-pdex/ValueSet/FDANationalDrugCode from this IG | |
MedicationDispense.type | required | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreMedicationDispenseProfile | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared us-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
?!SΣC | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) What medication was supplied Slice: Unordered, Closed by type:$this Binding: Medication Clinical Drug ![]() | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | The patient who is prescribed the medication | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who performed the dispense event | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0)) | Individual or device performing the dispense | ||||
![]() ![]() ![]() |
0..1 | Reference(US Core Location Profile(6.1.0)) | Where the dispense occurred | |||||
![]() ![]() ![]() |
S | 0..* | Reference(US Core MedicationRequest Profile(6.1.0)) | (USCDI) Medication order that authorizes the dispense | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (required) | ||||
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | Billing, service, product, or drug code Binding: Common UCUM units (preferred)
qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
0..1 | SimpleQuantity | Medication expressed as a timing amount. | |||||
![]() ![]() ![]() |
SC | 0..1 | dateTime | (USCDI) When product was given out or mailed | ||||
![]() ![]() ![]() |
S | 0..* | Dosage | (USCDI) How the medication is to be used by the patient or administered by the caregiver | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Free text dosage instructions e.g. SIG | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Timing | (USCDI) When medication should be administered | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Element | (USCDI) Amount of medication administered | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | (USCDI) Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status from the FHIR Standard | ||||
MedicationDispense.category | required | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category from the FHIR Standard | ||||
MedicationDispense.medication[x] | extensible | MedicationClinicalDrug ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | ||||
MedicationDispense.medication[x]:medicationCodeableConcept | required | FDANationalDrugCodehttp://hl7.org/fhir/us/davinci-pdex/ValueSet/FDANationalDrugCode from this IG | ||||
MedicationDispense.type | required | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreMedicationDispenseProfile | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared us-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | External identifier | |||||
![]() ![]() ![]() |
0..* | Reference(Procedure) | Event that dispense is part of | |||||
![]() ![]() ![]() |
?!SΣC | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) | ||||
![]() ![]() ![]() |
0..1 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(DetectedIssue) | |||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) What medication was supplied Slice: Unordered, Closed by type:$this Binding: Medication Clinical Drug ![]() | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | The patient who is prescribed the medication | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who performed the dispense event | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core Organization Profile(6.1.0) S) | Individual or device performing the dispense | ||||
![]() ![]() ![]() |
0..1 | Reference(US Core Location Profile(6.1.0)) | Where the dispense occurred | |||||
![]() ![]() ![]() |
S | 0..* | Reference(US Core MedicationRequest Profile(6.1.0)) | (USCDI) Medication order that authorizes the dispense | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (required) | ||||
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | Billing, service, product, or drug code Binding: Common UCUM units (preferred)
qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() |
0..1 | SimpleQuantity | Medication expressed as a timing amount. | |||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When product was packaged and reviewed | ||||
![]() ![]() ![]() |
SC | 0..1 | dateTime | (USCDI) When product was given out or mailed | ||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where the medication was sent | |||||
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||
![]() ![]() ![]() |
0..* | Annotation | Information about the dispense | |||||
![]() ![]() ![]() |
S | 0..* | Dosage | (USCDI) How the medication is to be used by the patient or administered by the caregiver | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Free text dosage instructions e.g. SIG | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Timing | (USCDI) When medication should be administered | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | |||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Element | (USCDI) Amount of medication administered | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | (USCDI) Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity S | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |||||
![]() ![]() ![]() |
0..* | Reference(DetectedIssue) | Clinical issue with action | |||||
![]() ![]() ![]() |
0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status from the FHIR Standard | ||||
MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason from the FHIR Standard | ||||
MedicationDispense.category | required | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category from the FHIR Standard | ||||
MedicationDispense.medication[x] | extensible | MedicationClinicalDrug ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | ||||
MedicationDispense.medication[x]:medicationCodeableConcept | required | FDANationalDrugCodehttp://hl7.org/fhir/us/davinci-pdex/ValueSet/FDANationalDrugCode from this IG | ||||
MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-function from the FHIR Standard | ||||
MedicationDispense.type | required | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
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