This page is part of the Da Vinci Payer Data Exchange (v2.0.0-ballot: STU2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.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.0.0-ballot | |||
Draft as of 2022-02-18 | Computable Name: PdexMedicationDispense |
Prescription Medications dispensed by a pharmacy to a health plan member and paid for in full, or in part, by the health plan
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 |
---|---|---|---|---|
MedicationDispense | 0..* | MedicationDispense | Dispensing a medication to a named patient | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
DispenseRefill | 0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |
valueQuantity | 0..1 | Quantity | Refill number of this prescription | |
status | S | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) |
category | 0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |
medicationCodeableConcept | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |
subject | S | 1..1 | Reference(US Core Patient Profile) | 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 | |
function | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: MedicationDispense Performer Function Codes (example) | |
actor | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense | |
location | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |
authorizingPrescription | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
quantity | 0..1 | SimpleQuantity | Billing, service, product, or drug code | |
daysSupply | 0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
substitution | S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
wasSubstituted | S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | I | 0..* | MedicationDispense | Dispensing a medication to a named patient |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
DispenseRefill | 0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill" | |
Slices for value[x] | 0..1 | Quantity | Refill number of this prescription Slice: Unordered, Closed by type:$this | |
value[x]:valueQuantity | 0..1 | Quantity | Refill number of this prescription | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | External identifier | |
partOf | 0..* | Reference(Procedure) | Event that dispense is part of | |
status | ?!SΣ | 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: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
medication[x]:medicationCodeableConcept | Σ | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | The patient who is prescribed the medication |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |
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 | Trial fill, partial fill, emergency fill, etc. Binding: MedicationDispense Performer Function Codes (example) | |
actor | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense | |
location | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |
authorizingPrescription | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
quantity | 0..1 | SimpleQuantity | Billing, service, product, or drug code | |
daysSupply | 0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed |
whenHandedOver | 0..1 | dateTime | When product was given out | |
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 | |
substitution | S | 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 | S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense |
type | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. | |
reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |
responsibleParty | 0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | I | 0..* | MedicationDispense | Dispensing a medication to a named patient |
status | ?!Σ | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) |
subject | Σ | 1..1 | Reference(US Core Patient Profile) | The patient who is prescribed the medication |
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 |
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 |
---|---|---|---|---|
MedicationDispense | 0..* | MedicationDispense | Dispensing a medication to a named patient | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
DispenseRefill | 0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |
valueQuantity | 0..1 | Quantity | Refill number of this prescription | |
status | S | 1..1 | code | completed Binding: MedicationDispense Status Codes (required) |
category | 0..1 | CodeableConcept | Type of dispense action Binding: MedicationDispense Category Codes (required) | |
medicationCodeableConcept | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) | |
subject | S | 1..1 | Reference(US Core Patient Profile) | 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 | |
function | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: MedicationDispense Performer Function Codes (example) | |
actor | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense | |
location | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |
authorizingPrescription | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
quantity | 0..1 | SimpleQuantity | Billing, service, product, or drug code | |
daysSupply | 0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
substitution | S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
wasSubstituted | S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | I | 0..* | MedicationDispense | Dispensing a medication to a named patient |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
DispenseRefill | 0..1 | Quantity | Refill number of this prescription URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill" | |
Slices for value[x] | 0..1 | Quantity | Refill number of this prescription Slice: Unordered, Closed by type:$this | |
value[x]:valueQuantity | 0..1 | Quantity | Refill number of this prescription | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | External identifier | |
partOf | 0..* | Reference(Procedure) | Event that dispense is part of | |
status | ?!SΣ | 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: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
medication[x]:medicationCodeableConcept | Σ | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: FDA National Drug Code (NDC) (required) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | The patient who is prescribed the medication |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |
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 | Trial fill, partial fill, emergency fill, etc. Binding: MedicationDispense Performer Function Codes (example) | |
actor | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense | |
location | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |
authorizingPrescription | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
quantity | 0..1 | SimpleQuantity | Billing, service, product, or drug code | |
daysSupply | 0..1 | SimpleQuantity | Medication expressed as a timing amount. | |
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed |
whenHandedOver | 0..1 | dateTime | When product was given out | |
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 | |
substitution | S | 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 | S | 1..1 | boolean | Whether a substitution was or was not performed on the dispense |
type | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. | |
reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |
responsibleParty | 0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |
Documentation for this format |
Other representations of profile: CSV, Excel, 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 |