This page is part of the Da Vinci Payer Data Exchange (v1.0.0: STU1) 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
Defining URL: | http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense |
Version: | 1.0.0 |
Name: | PdexMedicationDispense |
Title: | PDex MedicationDispense |
Status: | Draft as of 2020-12-22T14:17:18+00:00 |
Definition: | Prescription Medications dispensed by a pharmacy to a health plan member and paid for in full, or in part, by the health plan |
Publisher: | HL7 International |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationDispense
Summary
Mandatory: 2 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | MedicationDispense | 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 | |
![]() ![]() ![]() ![]() | 0..1 | Quantity | Refill number of this prescription | |
![]() ![]() ![]() | S | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) |
![]() ![]() ![]() | 0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |
![]() ![]() ![]() | S | 1..1 | Reference(US Core Patient Profile) | 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 | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: MedicationDispense Performer Function Codes (example) | |
![]() ![]() ![]() ![]() | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense | |
![]() ![]() ![]() | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |
![]() ![]() ![]() | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
![]() ![]() ![]() | 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 |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | MedicationDispense | Dispensing a medication to a named patient |
![]() ![]() ![]() | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill" | |
![]() ![]() ![]() ![]() | 0..1 | (Slice Definition) | Refill number of this prescription Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Quantity | Refill number of this prescription | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | 0..* | Identifier | External identifier | |
![]() ![]() ![]() | 0..* | Reference(Procedure) | Event that dispense is part of | |
![]() ![]() ![]() | ?!SΣ | 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) | |
![]() ![]() ![]() | Σ | 1..1 | (Slice Definition) | What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) |
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | 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. | |
![]() ![]() ![]() | 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 | Trial fill, partial fill, emergency fill, etc. Binding: MedicationDispense Performer Function Codes (example) | |
![]() ![]() ![]() ![]() | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense | |
![]() ![]() ![]() | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |
![]() ![]() ![]() | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Billing, service, product, or drug code | |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
![]() ![]() ![]() | Σ | 0..1 | dateTime | When product was packaged and reviewed |
![]() ![]() ![]() | 0..1 | dateTime | When product was given out | |
![]() ![]() ![]() | 0..1 | Reference(Location) | Where the medication was sent | |
![]() ![]() ![]() | 0..* | Reference(Patient | Practitioner) | Who collected the medication | |
![]() ![]() ![]() | 0..* | Annotation | Information about the dispense | |
![]() ![]() ![]() | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
![]() ![]() ![]() | 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 | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | MedicationDispense | Dispensing a medication to a named patient |
![]() ![]() ![]() | ?!Σ | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) |
![]() ![]() ![]() | Σ | 1..1 | Reference(US Core Patient Profile) | The patient who is prescribed the medication |
![]() ![]() ![]() | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | |
![]() ![]() ![]() ![]() | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | |
![]() |
This structure is derived from MedicationDispense
Summary
Mandatory: 2 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | MedicationDispense | 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 | |
![]() ![]() ![]() ![]() | 0..1 | Quantity | Refill number of this prescription | |
![]() ![]() ![]() | S | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) |
![]() ![]() ![]() | 0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |
![]() ![]() ![]() | S | 1..1 | Reference(US Core Patient Profile) | 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 | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: MedicationDispense Performer Function Codes (example) | |
![]() ![]() ![]() ![]() | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense | |
![]() ![]() ![]() | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |
![]() ![]() ![]() | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
![]() ![]() ![]() | 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 |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | MedicationDispense | Dispensing a medication to a named patient |
![]() ![]() ![]() | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill" | |
![]() ![]() ![]() ![]() | 0..1 | (Slice Definition) | Refill number of this prescription Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Quantity | Refill number of this prescription | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | 0..* | Identifier | External identifier | |
![]() ![]() ![]() | 0..* | Reference(Procedure) | Event that dispense is part of | |
![]() ![]() ![]() | ?!SΣ | 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) | |
![]() ![]() ![]() | Σ | 1..1 | (Slice Definition) | What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) |
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | 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. | |
![]() ![]() ![]() | 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 | Trial fill, partial fill, emergency fill, etc. Binding: MedicationDispense Performer Function Codes (example) | |
![]() ![]() ![]() ![]() | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense | |
![]() ![]() ![]() | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |
![]() ![]() ![]() | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Billing, service, product, or drug code | |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
![]() ![]() ![]() | Σ | 0..1 | dateTime | When product was packaged and reviewed |
![]() ![]() ![]() | 0..1 | dateTime | When product was given out | |
![]() ![]() ![]() | 0..1 | Reference(Location) | Where the medication was sent | |
![]() ![]() ![]() | 0..* | Reference(Patient | Practitioner) | Who collected the medication | |
![]() ![]() ![]() | 0..* | Annotation | Information about the dispense | |
![]() ![]() ![]() | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
![]() ![]() ![]() | 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 | |
![]() |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
MedicationDispense.language | preferred | CommonLanguages Max Binding: AllLanguages |
MedicationDispense.status | required | MedicationDispense Status Codes |
MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codes |
MedicationDispense.category | required | MedicationDispense Category Codes |
MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodes |
MedicationDispense.medication[x]:medicationCodeableConcept | required | FDANationalDrugCode |
MedicationDispense.performer.function | example | MedicationDispense Performer Function Codes |
MedicationDispense.type | example | ActPharmacySupplyType |
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCode |
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReason |