This page is part of the Quality Improvement Core Framework (v3.2.0: STU 3) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions
Penicillin MedicationDispense Example |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medicationdispense
Profile of MedicationDispense for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
This profile builds on MedicationDispense.
This profile was published on Wed Aug 22 00:00:00 AEST 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | I | 0..* | Dispensing a medication to a named patient | |
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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
medicationdispense-validityPeriod | I | 0..1 | Period | Time interval for medication administration URL: http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod |
pharmacy-core-refillsRemaining | SI | 0..1 | integer | Number of refills allowed URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-refillsRemaining |
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Σ | 0..1 | code | preparation | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) |
category | 0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispenseCategory (preferred) | |
medication[x] | SΣ | 1..1 | CodeableConcept, Reference(Medication) | What medication was supplied Binding: Medication Clinical Drug (RxNorm) (preferred) |
subject | SΣ | 0..1 | Reference(QICore-Patient) | Who the dispense is for |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |
supportingInformation | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |
performer | I | 0..* | BackboneElement | Who performed event |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
actor | 1..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) | Individual who was performing | |
onBehalfOf | 0..1 | Reference(Organization) | Organization organization was acting for | |
authorizingPrescription | 0..* | Reference(QICore-MedicationRequest) | Medication order that authorizes the dispense | |
type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
quantity | S | 0..1 | SimpleQuantity | Amount dispensed |
daysSupply | S | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount |
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed |
whenHandedOver | S | 0..1 | dateTime | When product was given out |
destination | 0..1 | Reference(QICore-Location) | Where the medication was sent | |
receiver | 0..* | Reference(QICore-Patient | QICore-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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
pharmacy-core-doseType | 0..1 | CodeableConcept | The type of dose, e.g., loading. URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType" | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
pharmacy-core-infuseOver | 0..1 | Duration | The length of the infusion URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver" | |
valueDuration | 0..1 | Duration | Value of extension | |
pharmacy-core-rateIncrement | 0..1 | Ratio | Change in dosing rate per interval URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement" | |
valueRatio | 0..1 | Ratio | Value of extension | |
pharmacy-core-rateIncrementInterval | 0..1 | Duration | The period of time between rate increments URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval" | |
valueDuration | 0..1 | Duration | Value of extension | |
pharmacy-core-rateGoal | 0..1 | Ratio | The target rate for the infusion URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal" | |
valueRatio | 0..1 | Ratio | Value of extension | |
pharmacy-core-minDosePerPeriod | 0..1 | Ratio | The minimum quantity of substance per period URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod" | |
valueRatio | 0..1 | Ratio | Value of extension | |
pharmacy-core-maxDeliveryRate | 0..1 | Ratio | The maximum rate of substance administration URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate" | |
valueRatio | 0..1 | Ratio | Value of extension | |
pharmacy-core-maxDeliveryVolume | 0..1 | Quantity | The maximum amount of fluid to infuse URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume" | |
valueQuantity | 0..1 | Quantity | Value of extension | |
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 - e.g. "with meals" Binding: SNOMED CT Additional Dosage Instructions (example) |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | SΣ | 0..1 | Timing | When medication should be administered |
asNeeded[x] | Σ | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: SNOMED CT Medication As Needed Reason Codes (example) |
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example) |
route | SΣ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMED CT Route Codes (example) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMED CT Administration Method Codes (example) |
dose[x] | SΣ | 0..1 | Range, SimpleQuantity | Amount of medication per dose |
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
rate[x] | Σ | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time |
substitution | I | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
wasSubstituted | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | |
type | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example) | |
reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example) | |
responsibleParty | 0..* | Reference(QICore-Practitioner) | Who is responsible for the substitution | |
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
notDone | 0..1 | boolean | Whether the dispense was or was not performed | |
notDoneReason[x] | 0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed | |
eventHistory | 0..* | Reference(Provenance) | A list of releveant lifecycle events | |
Documentation for this format |
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | I | 0..* | Dispensing a medication to a named patient | |
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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
medicationdispense-validityPeriod | I | 0..1 | Period | Time interval for medication administration URL: http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod |
pharmacy-core-refillsRemaining | SI | 0..1 | integer | Number of refills allowed URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-refillsRemaining |
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Σ | 0..1 | code | preparation | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) |
category | 0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispenseCategory (preferred) | |
medication[x] | SΣ | 1..1 | CodeableConcept, Reference(Medication) | What medication was supplied Binding: Medication Clinical Drug (RxNorm) (preferred) |
subject | SΣ | 0..1 | Reference(QICore-Patient) | Who the dispense is for |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |
supportingInformation | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |
performer | I | 0..* | BackboneElement | Who performed event |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
actor | 1..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) | Individual who was performing | |
onBehalfOf | 0..1 | Reference(Organization) | Organization organization was acting for | |
authorizingPrescription | 0..* | Reference(QICore-MedicationRequest) | Medication order that authorizes the dispense | |
type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
quantity | S | 0..1 | SimpleQuantity | Amount dispensed |
daysSupply | S | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount |
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed |
whenHandedOver | S | 0..1 | dateTime | When product was given out |
destination | 0..1 | Reference(QICore-Location) | Where the medication was sent | |
receiver | 0..* | Reference(QICore-Patient | QICore-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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
pharmacy-core-doseType | 0..1 | CodeableConcept | The type of dose, e.g., loading. URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType" | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
pharmacy-core-infuseOver | 0..1 | Duration | The length of the infusion URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver" | |
valueDuration | 0..1 | Duration | Value of extension | |
pharmacy-core-rateIncrement | 0..1 | Ratio | Change in dosing rate per interval URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement" | |
valueRatio | 0..1 | Ratio | Value of extension | |
pharmacy-core-rateIncrementInterval | 0..1 | Duration | The period of time between rate increments URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval" | |
valueDuration | 0..1 | Duration | Value of extension | |
pharmacy-core-rateGoal | 0..1 | Ratio | The target rate for the infusion URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal" | |
valueRatio | 0..1 | Ratio | Value of extension | |
pharmacy-core-minDosePerPeriod | 0..1 | Ratio | The minimum quantity of substance per period URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod" | |
valueRatio | 0..1 | Ratio | Value of extension | |
pharmacy-core-maxDeliveryRate | 0..1 | Ratio | The maximum rate of substance administration URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate" | |
valueRatio | 0..1 | Ratio | Value of extension | |
pharmacy-core-maxDeliveryVolume | 0..1 | Quantity | The maximum amount of fluid to infuse URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume" | |
valueQuantity | 0..1 | Quantity | Value of extension | |
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 - e.g. "with meals" Binding: SNOMED CT Additional Dosage Instructions (example) |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | SΣ | 0..1 | Timing | When medication should be administered |
asNeeded[x] | Σ | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: SNOMED CT Medication As Needed Reason Codes (example) |
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example) |
route | SΣ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMED CT Route Codes (example) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMED CT Administration Method Codes (example) |
dose[x] | SΣ | 0..1 | Range, SimpleQuantity | Amount of medication per dose |
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
rate[x] | Σ | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time |
substitution | I | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
wasSubstituted | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | |
type | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example) | |
reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example) | |
responsibleParty | 0..* | Reference(QICore-Practitioner) | Who is responsible for the substitution | |
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
notDone | 0..1 | boolean | Whether the dispense was or was not performed | |
notDoneReason[x] | 0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed | |
eventHistory | 0..* | Reference(Provenance) | A list of releveant lifecycle events | |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationDispense.status | required | MedicationDispenseStatus |
MedicationDispense.medication[x] | preferred | Medication Clinical Drug (RxNorm) |
MedicationDispense.dosageInstruction.route | example | SNOMED CT Route Codes |
Id | Path | Details | Requirements |
dom-2 | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
mdd-1 | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared | |
ele-1 | MedicationDispense.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | MedicationDispense.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationDispense.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | MedicationDispense.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationDispense.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | MedicationDispense.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationDispense.performer | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | MedicationDispense.substitution | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |