This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/qicore/StructureDefinition/qicore-medicationdispense
This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from MedicationDispense
Summary
Must-Support: 10 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 | I | 0..* | Dispensing a medication to a named patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource mdd-1: whenHandedOver cannot be before whenPrepared | |
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) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
medicationdispense-validityPeriod | I | 0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-refillsRemaining | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-refillsRemaining ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..1 | Identifier | External identifier | |
status | ?!S | 0..1 | code | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) |
medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | What medication was supplied Binding: 7.org/fhir/daf/ValueSet/daf-medication-codes (preferred) |
patient | S | 0..1 | Reference(Profile qicore-patient) | Who the dispense is for |
dispenser | 0..1 | Reference(Profile qicore-practitioner) | Practitioner responsible for dispensing medication | |
dispensingOrganization | 0..1 | Reference(Organization) | Organization responsible for the dispense of the medication | |
authorizingPrescription | 0..* | Reference(Profile qicore-medicationorder) | 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(Profile qicore-location) | Details and position information for a physical place | |
receiver | 0..* | Reference(Profile qicore-patient | Profile qicore-practitioner) | Who collected the medication | |
note | 0..* | Annotation | Information about the dispense | |
dosageInstruction | 0..* | BackboneElement | Medicine administration instructions to the patient/caregiver | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
pharmacy-core-doseType | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType Binding: SNOMED CT Dosages Codes (preferred) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-infuseOver | I | 0..1 | Duration | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-rateIncrement | I | 0..1 | Ratio | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-rateIncrementInterval | I | 0..1 | Duration | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-rateGoal | I | 0..1 | Ratio | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-minDosePerPeriod | I | 0..1 | Ratio | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-maxDeliveryRate | I | 0..1 | Ratio | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-maxDeliveryVolume | I | 0..1 | Quantity | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
text | 0..1 | string | Free text dosage instructions e.g. SIG | |
additionalInstructions | 0..* | CodeableConcept | E.g. "Take with food" Binding: SNOMED CT Additional Dosage Instructions (example) | |
timing | S | 0..1 | Timing | When medication should be administered |
asNeeded[x] | 0..1 | boolean, CodeableConcept | Take "as needed" f(or x) Binding: SNOMED CT Medication As Needed Reason Codes (example) | |
site[x] | 0..1 | CodeableConcept, Reference(BodySite) | Body site to administer to Binding: 7.org/fhir/daf/ValueSet/daf-bodysite (preferred) | |
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 |
rate[x] | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time | |
maxDosePerPeriod | 0..1 | Ratio | Upper limit on medication per unit of time | |
substitution | 0..1 | BackboneElement | Deals with substitution of one medicine for another | |
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 |
type | 1..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(Profile qicore-practitioner) | Who is responsible for the substitution | |
eventHistory | 0..* | BackboneElement | A list of events of interest in the lifecycle | |
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 |
status | 1..1 | code | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) | |
action | 0..1 | CodeableConcept | Action taken (e.g. verify) Binding: (unbound) (example) | |
dateTime | 1..1 | dateTime | The date at which the event happened | |
actor | 0..1 | Reference(Practitioner) | Who took the action | |
reason | 0..1 | CodeableConcept | Reason the action was taken Binding: (unbound) (example) | |
Documentation for this format |
yet to be done: Xml template
yet to be done: Json template
This structure is derived from StructureDefinition.
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from StructureDefinition.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | I | 0..* | Dispensing a medication to a named patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource mdd-1: whenHandedOver cannot be before whenPrepared | |
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) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
medicationdispense-validityPeriod | I | 0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-refillsRemaining | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-refillsRemaining ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..1 | Identifier | External identifier | |
status | ?!S | 0..1 | code | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) |
medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | What medication was supplied Binding: 7.org/fhir/daf/ValueSet/daf-medication-codes (preferred) |
patient | S | 0..1 | Reference(Profile qicore-patient) | Who the dispense is for |
dispenser | 0..1 | Reference(Profile qicore-practitioner) | Practitioner responsible for dispensing medication | |
dispensingOrganization | 0..1 | Reference(Organization) | Organization responsible for the dispense of the medication | |
authorizingPrescription | 0..* | Reference(Profile qicore-medicationorder) | 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(Profile qicore-location) | Details and position information for a physical place | |
receiver | 0..* | Reference(Profile qicore-patient | Profile qicore-practitioner) | Who collected the medication | |
note | 0..* | Annotation | Information about the dispense | |
dosageInstruction | 0..* | BackboneElement | Medicine administration instructions to the patient/caregiver | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
pharmacy-core-doseType | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType Binding: SNOMED CT Dosages Codes (preferred) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-infuseOver | I | 0..1 | Duration | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-rateIncrement | I | 0..1 | Ratio | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-rateIncrementInterval | I | 0..1 | Duration | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-rateGoal | I | 0..1 | Ratio | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-minDosePerPeriod | I | 0..1 | Ratio | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-maxDeliveryRate | I | 0..1 | Ratio | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pharmacy-core-maxDeliveryVolume | I | 0..1 | Quantity | Extension URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
text | 0..1 | string | Free text dosage instructions e.g. SIG | |
additionalInstructions | 0..* | CodeableConcept | E.g. "Take with food" Binding: SNOMED CT Additional Dosage Instructions (example) | |
timing | S | 0..1 | Timing | When medication should be administered |
asNeeded[x] | 0..1 | boolean, CodeableConcept | Take "as needed" f(or x) Binding: SNOMED CT Medication As Needed Reason Codes (example) | |
site[x] | 0..1 | CodeableConcept, Reference(BodySite) | Body site to administer to Binding: 7.org/fhir/daf/ValueSet/daf-bodysite (preferred) | |
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 |
rate[x] | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time | |
maxDosePerPeriod | 0..1 | Ratio | Upper limit on medication per unit of time | |
substitution | 0..1 | BackboneElement | Deals with substitution of one medicine for another | |
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 |
type | 1..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(Profile qicore-practitioner) | Who is responsible for the substitution | |
eventHistory | 0..* | BackboneElement | A list of events of interest in the lifecycle | |
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 |
status | 1..1 | code | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) | |
action | 0..1 | CodeableConcept | Action taken (e.g. verify) Binding: (unbound) (example) | |
dateTime | 1..1 | dateTime | The date at which the event happened | |
actor | 0..1 | Reference(Practitioner) | Who took the action | |
reason | 0..1 | CodeableConcept | Reason the action was taken Binding: (unbound) (example) | |
Documentation for this format |
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
Path | Name | Conformance | ValueSet |
MedicationDispense.language | Common Languages | extensible | Common Languages |
MedicationDispense.status | MedicationDispenseStatus | required | MedicationDispenseStatus |
MedicationDispense.medication[x] | ?ext | preferred | http://hl7.org/fhir/daf/ValueSet/daf-medication-codes |
MedicationDispense.type | ActPharmacySupplyType | example | ActPharmacySupplyType |
MedicationDispense.dosageInstruction.extension http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType | SNOMED CT Dosages Codes | preferred | SNOMED CT Dosages Codes |
MedicationDispense.dosageInstruction.additionalInstructions | SNOMED CT Additional Dosage Instructions | example | SNOMED CT Additional Dosage Instructions |
MedicationDispense.dosageInstruction.asNeeded[x] | SNOMED CT Medication As Needed Reason Codes | example | SNOMED CT Medication As Needed Reason Codes |
MedicationDispense.dosageInstruction.site[x] | ?ext | preferred | http://hl7.org/fhir/daf/ValueSet/daf-bodysite |
MedicationDispense.dosageInstruction.route | SNOMED CT Route Codes | example | SNOMED CT Route Codes |
MedicationDispense.dosageInstruction.method | SNOMED CT Administration Method Codes | example | SNOMED CT Administration Method Codes |
MedicationDispense.substitution.type | ActSubstanceAdminSubstitutionCode | example | ActSubstanceAdminSubstitutionCode |
MedicationDispense.substitution.reason | SubstanceAdminSubstitutionReason | example | SubstanceAdminSubstitutionReason |
MedicationDispense.eventHistory.status | MedicationDispenseStatus | required | MedicationDispenseStatus |
MedicationDispense.eventHistory.action | ?ext | example | |
MedicationDispense.eventHistory.reason | ?ext | example |
Id | Path | Details | Requirements |
dom-2 | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
dom-3 | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) | |
mdd-1 | MedicationDispense | whenHandedOver cannot be before whenPrepared XPath: not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value) | |
ele-1 | MedicationDispense.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | MedicationDispense.dosageInstruction.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | MedicationDispense.dosageInstruction.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) |