IE Medication Events Implementation Guide
0.1.0 - Nostalgic IE (draft) Ireland flag

IE Medication Events Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: IE MPD MedicationDispense (eDispensation)

Official URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-medicationdispense-edispensation Version: 0.1.0
Draft as of 2026-10-09 Computable Name: IEMpdMedicationDispenseEDispensation

An Irish electronic dispensation record (HIQA EP Section 6), derived from the HL7 Europe MPD MedicationDispense. Covers a completed dispense, a partial or instalment dispense, and a non-dispensation (declined or stopped, with a reason).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispenseEuMpd(1.0.0) Dispensing a medication to a named patient
Constraints: mdd-1, ie-md-status-1, ie-md-handover-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:renderedDosageInstruction O 0..1 markdown Full representation of the dosage instructions
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
Constraints: ext-1
ObligationsActorSource
SHOULD:able-to-populate Producer from MedicationDispense: MPD
.... extension:recorded SO 1..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
Constraints: ext-1
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
.... extension:receiverRelatedPerson 0..1 Reference(IE MPD RelatedPerson(0.1.0)) IE MPD Dispense Receiver (Related Person)
URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-dispense-receiver-related-person
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!SOΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... statusReason[x] S 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)
... Slices for medication[x] SOΣ 1..1 What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: IEMpdMedicationCodes (0.1.0) (extensible)
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationReference Σ 0..1 Reference(Medication: MPD(1.0.0)) What medication was supplied
... subject SOΣ 1..1 Reference(IE MPD Patient (ePrescription/eDispensation)(0.1.0)) Who the dispense is for
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... performer S 1..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... actor SO 1..1 Reference(IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0) | IE MPD Organization(0.1.0)) Individual who was performing
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... authorizingPrescription SO 1..1 Reference(IE MPD MedicationRequest (ePrescription)(0.1.0)) Medication order that authorizes the dispense
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... quantity SO 1..1 SimpleQuantity(4.0.1) Amount dispensed
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... whenHandedOver S 0..1 dateTime Date and time when the medication was handed over. When not present, the time of dispensation is assumed to be the time of issuing the dispense record.
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction SO 0..* IEMpdDosage(0.1.0) How the medication is to be used by the patient or administered by the caregiver
ObligationsActorSource
SHOULD:able-to-populate Producer from MedicationDispense: MPD
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... wasSubstituted S 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type S 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (3.0.0) (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
.... reason S 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (3.0.0) (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base extensible IE MPD Medication Codes 📍0.1.0 This IG
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📍3.0.0 THO v7.4
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📍3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error 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-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error MedicationDispense.implicitRules, MedicationDispense.extension, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.extension:recorded, MedicationDispense.extension:receiverRelatedPerson, MedicationDispense.modifierExtension, MedicationDispense.identifier, MedicationDispense.status, MedicationDispense.statusReason[x], MedicationDispense.medication[x], MedicationDispense.medication[x]:medicationReference, MedicationDispense.subject, MedicationDispense.performer, MedicationDispense.performer.modifierExtension, MedicationDispense.performer.actor, MedicationDispense.authorizingPrescription, MedicationDispense.quantity, MedicationDispense.whenHandedOver, MedicationDispense.receiver, MedicationDispense.note, MedicationDispense.dosageInstruction, MedicationDispense.substitution, MedicationDispense.substitution.modifierExtension, MedicationDispense.substitution.wasSubstituted, MedicationDispense.substitution.type, MedicationDispense.substitution.reason All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MedicationDispense.extension, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.extension:recorded, MedicationDispense.extension:receiverRelatedPerson, MedicationDispense.modifierExtension, MedicationDispense.performer.modifierExtension, MedicationDispense.substitution.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
ie-md-handover-1 error MedicationDispense A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) status = 'completed' implies whenHandedOver.exists()
ie-md-status-1 error MedicationDispense A non-dispensation (declined, stopped, cancelled or on-hold) SHALL state the reason (HIQA EP 6.3.2) (status = 'declined' or status = 'stopped' or status = 'cancelled' or status = 'on-hold') implies statusReason.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispenseEuMpd

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispenseEuMpd(1.0.0) Dispensing a medication to a named patient
... Slices for extension Content/Rules for all slices
.... extension:recorded S 1..1 0.1.0 R5: When the recording of the dispense started (new)
.... extension:receiverRelatedPerson 0..1 Reference(IE MPD RelatedPerson(0.1.0)) IE MPD Dispense Receiver (Related Person)
URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-dispense-receiver-related-person
... identifier S 1..* Identifier External identifier
... status S 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
... medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was supplied
Binding: IEMpdMedicationCodes (0.1.0) (extensible)
... subject S 1..1 Reference(IE MPD Patient (ePrescription/eDispensation)(0.1.0)) Who the dispense is for
... performer S 1..* BackboneElement Who performed event
.... actor S 1..1 Reference(IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0) | IE MPD Organization(0.1.0)) Individual who was performing
... authorizingPrescription S 1..1 Reference(IE MPD MedicationRequest (ePrescription)(0.1.0)) Medication order that authorizes the dispense
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed
... whenHandedOver S 0..1 dateTime Date and time when the medication was handed over. When not present, the time of dispensation is assumed to be the time of issuing the dispense record.
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction S 0..* IEMpdDosage(0.1.0) 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
.... wasSubstituted S 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type S 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
.... reason S 0..* CodeableConcept Why was substitution made

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationDispense.medication[x] Base extensible IE MPD Medication Codes 📍0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ie-md-handover-1 error MedicationDispense A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) status = 'completed' implies whenHandedOver.exists()
ie-md-status-1 error MedicationDispense A non-dispensation (declined, stopped, cancelled or on-hold) SHALL state the reason (HIQA EP 6.3.2) (status = 'declined' or status = 'stopped' or status = 'cancelled' or status = 'on-hold') implies statusReason.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispenseEuMpd(1.0.0) Dispensing a medication to a named patient
Constraints: mdd-1, ie-md-status-1, ie-md-handover-1
... 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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:renderedDosageInstruction O 0..1 markdown Full representation of the dosage instructions
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
Constraints: ext-1
ObligationsActorSource
SHOULD:able-to-populate Producer from MedicationDispense: MPD
.... extension:recorded SO 1..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
Constraints: ext-1
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
.... extension:receiverRelatedPerson 0..1 Reference(IE MPD RelatedPerson(0.1.0)) IE MPD Dispense Receiver (Related Person)
URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-dispense-receiver-related-person
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier S 1..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!SOΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... statusReason[x] S 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 medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... Slices for medication[x] SOΣ 1..1 What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: IEMpdMedicationCodes (0.1.0) (extensible)
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationReference Σ 0..1 Reference(Medication: MPD(1.0.0)) What medication was supplied
... subject SOΣ 1..1 Reference(IE MPD Patient (ePrescription/eDispensation)(0.1.0)) Who the dispense is for
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 1..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function 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.
.... actor SO 1..1 Reference(IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0) | IE MPD Organization(0.1.0)) Individual who was performing
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... location 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription SO 1..1 Reference(IE MPD MedicationRequest (ePrescription)(0.1.0)) Medication order that authorizes the dispense
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (3.0.0) (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity SO 1..1 SimpleQuantity(4.0.1) Amount dispensed
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... daysSupply 0..1 SimpleQuantity(4.0.1) Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver S 0..1 dateTime Date and time when the medication was handed over. When not present, the time of dispensation is assumed to be the time of issuing the dispense record.
... 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 SO 0..* IEMpdDosage(0.1.0) How the medication is to be used by the patient or administered by the caregiver
ObligationsActorSource
SHOULD:able-to-populate Producer from MedicationDispense: MPD
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... wasSubstituted S 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type S 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (3.0.0) (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
.... reason S 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (3.0.0) (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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base extensible IE MPD Medication Codes 📍0.1.0 This IG
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📍3.0.0 THO v7.4
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📍3.0.0 THO v7.4
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📍3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error 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-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error MedicationDispense.meta, MedicationDispense.implicitRules, MedicationDispense.language, MedicationDispense.text, MedicationDispense.extension, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.extension:recorded, MedicationDispense.extension:receiverRelatedPerson, MedicationDispense.modifierExtension, MedicationDispense.identifier, MedicationDispense.partOf, MedicationDispense.status, MedicationDispense.statusReason[x], MedicationDispense.category, MedicationDispense.medication[x], MedicationDispense.medication[x]:medicationReference, MedicationDispense.subject, MedicationDispense.context, MedicationDispense.supportingInformation, MedicationDispense.performer, MedicationDispense.performer.extension, MedicationDispense.performer.modifierExtension, MedicationDispense.performer.function, MedicationDispense.performer.actor, MedicationDispense.location, MedicationDispense.authorizingPrescription, MedicationDispense.type, MedicationDispense.quantity, MedicationDispense.daysSupply, MedicationDispense.whenPrepared, MedicationDispense.whenHandedOver, MedicationDispense.destination, MedicationDispense.receiver, MedicationDispense.note, MedicationDispense.dosageInstruction, MedicationDispense.substitution, MedicationDispense.substitution.extension, MedicationDispense.substitution.modifierExtension, MedicationDispense.substitution.wasSubstituted, MedicationDispense.substitution.type, MedicationDispense.substitution.reason, MedicationDispense.substitution.responsibleParty, MedicationDispense.detectedIssue, MedicationDispense.eventHistory All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MedicationDispense.extension, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.extension:recorded, MedicationDispense.extension:receiverRelatedPerson, MedicationDispense.modifierExtension, MedicationDispense.performer.extension, MedicationDispense.performer.modifierExtension, MedicationDispense.substitution.extension, MedicationDispense.substitution.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
ie-md-handover-1 error MedicationDispense A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) status = 'completed' implies whenHandedOver.exists()
ie-md-status-1 error MedicationDispense A non-dispensation (declined, stopped, cancelled or on-hold) SHALL state the reason (HIQA EP 6.3.2) (status = 'declined' or status = 'stopped' or status = 'cancelled' or status = 'on-hold') implies statusReason.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispenseEuMpd(1.0.0) Dispensing a medication to a named patient
Constraints: mdd-1, ie-md-status-1, ie-md-handover-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:renderedDosageInstruction O 0..1 markdown Full representation of the dosage instructions
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
Constraints: ext-1
ObligationsActorSource
SHOULD:able-to-populate Producer from MedicationDispense: MPD
.... extension:recorded SO 1..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
Constraints: ext-1
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
.... extension:receiverRelatedPerson 0..1 Reference(IE MPD RelatedPerson(0.1.0)) IE MPD Dispense Receiver (Related Person)
URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-dispense-receiver-related-person
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!SOΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... statusReason[x] S 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)
... Slices for medication[x] SOΣ 1..1 What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: IEMpdMedicationCodes (0.1.0) (extensible)
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationReference Σ 0..1 Reference(Medication: MPD(1.0.0)) What medication was supplied
... subject SOΣ 1..1 Reference(IE MPD Patient (ePrescription/eDispensation)(0.1.0)) Who the dispense is for
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... performer S 1..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... actor SO 1..1 Reference(IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0) | IE MPD Organization(0.1.0)) Individual who was performing
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... authorizingPrescription SO 1..1 Reference(IE MPD MedicationRequest (ePrescription)(0.1.0)) Medication order that authorizes the dispense
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... quantity SO 1..1 SimpleQuantity(4.0.1) Amount dispensed
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... whenHandedOver S 0..1 dateTime Date and time when the medication was handed over. When not present, the time of dispensation is assumed to be the time of issuing the dispense record.
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction SO 0..* IEMpdDosage(0.1.0) How the medication is to be used by the patient or administered by the caregiver
ObligationsActorSource
SHOULD:able-to-populate Producer from MedicationDispense: MPD
... substitution S 0..1 BackboneElement Whether a substitution was performed on the dispense
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... wasSubstituted S 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type S 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (3.0.0) (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
.... reason S 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (3.0.0) (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base extensible IE MPD Medication Codes 📍0.1.0 This IG
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📍3.0.0 THO v7.4
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📍3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error 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-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error MedicationDispense.implicitRules, MedicationDispense.extension, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.extension:recorded, MedicationDispense.extension:receiverRelatedPerson, MedicationDispense.modifierExtension, MedicationDispense.identifier, MedicationDispense.status, MedicationDispense.statusReason[x], MedicationDispense.medication[x], MedicationDispense.medication[x]:medicationReference, MedicationDispense.subject, MedicationDispense.performer, MedicationDispense.performer.modifierExtension, MedicationDispense.performer.actor, MedicationDispense.authorizingPrescription, MedicationDispense.quantity, MedicationDispense.whenHandedOver, MedicationDispense.receiver, MedicationDispense.note, MedicationDispense.dosageInstruction, MedicationDispense.substitution, MedicationDispense.substitution.modifierExtension, MedicationDispense.substitution.wasSubstituted, MedicationDispense.substitution.type, MedicationDispense.substitution.reason All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MedicationDispense.extension, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.extension:recorded, MedicationDispense.extension:receiverRelatedPerson, MedicationDispense.modifierExtension, MedicationDispense.performer.modifierExtension, MedicationDispense.substitution.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
ie-md-handover-1 error MedicationDispense A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) status = 'completed' implies whenHandedOver.exists()
ie-md-status-1 error MedicationDispense A non-dispensation (declined, stopped, cancelled or on-hold) SHALL state the reason (HIQA EP 6.3.2) (status = 'declined' or status = 'stopped' or status = 'cancelled' or status = 'on-hold') implies statusReason.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Differential View

This structure is derived from MedicationDispenseEuMpd

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispenseEuMpd(1.0.0) Dispensing a medication to a named patient
... Slices for extension Content/Rules for all slices
.... extension:recorded S 1..1 0.1.0 R5: When the recording of the dispense started (new)
.... extension:receiverRelatedPerson 0..1 Reference(IE MPD RelatedPerson(0.1.0)) IE MPD Dispense Receiver (Related Person)
URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-dispense-receiver-related-person
... identifier S 1..* Identifier External identifier
... status S 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
... medication[x] S 1..1 CodeableConcept, Reference(Medication) What medication was supplied
Binding: IEMpdMedicationCodes (0.1.0) (extensible)
... subject S 1..1 Reference(IE MPD Patient (ePrescription/eDispensation)(0.1.0)) Who the dispense is for
... performer S 1..* BackboneElement Who performed event
.... actor S 1..1 Reference(IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0) | IE MPD Organization(0.1.0)) Individual who was performing
... authorizingPrescription S 1..1 Reference(IE MPD MedicationRequest (ePrescription)(0.1.0)) Medication order that authorizes the dispense
... quantity S 1..1 SimpleQuantity(4.0.1) Amount dispensed
... whenHandedOver S 0..1 dateTime Date and time when the medication was handed over. When not present, the time of dispensation is assumed to be the time of issuing the dispense record.
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction S 0..* IEMpdDosage(0.1.0) 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
.... wasSubstituted S 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type S 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
.... reason S 0..* CodeableConcept Why was substitution made

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationDispense.medication[x] Base extensible IE MPD Medication Codes 📍0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ie-md-handover-1 error MedicationDispense A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) status = 'completed' implies whenHandedOver.exists()
ie-md-status-1 error MedicationDispense A non-dispensation (declined, stopped, cancelled or on-hold) SHALL state the reason (HIQA EP 6.3.2) (status = 'declined' or status = 'stopped' or status = 'cancelled' or status = 'on-hold') implies statusReason.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispenseEuMpd(1.0.0) Dispensing a medication to a named patient
Constraints: mdd-1, ie-md-status-1, ie-md-handover-1
... 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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:renderedDosageInstruction O 0..1 markdown Full representation of the dosage instructions
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
Constraints: ext-1
ObligationsActorSource
SHOULD:able-to-populate Producer from MedicationDispense: MPD
.... extension:recorded SO 1..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
Constraints: ext-1
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
.... extension:receiverRelatedPerson 0..1 Reference(IE MPD RelatedPerson(0.1.0)) IE MPD Dispense Receiver (Related Person)
URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-dispense-receiver-related-person
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier S 1..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!SOΣ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... statusReason[x] S 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 medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... Slices for medication[x] SOΣ 1..1 What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: IEMpdMedicationCodes (0.1.0) (extensible)
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationReference Σ 0..1 Reference(Medication: MPD(1.0.0)) What medication was supplied
... subject SOΣ 1..1 Reference(IE MPD Patient (ePrescription/eDispensation)(0.1.0)) Who the dispense is for
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 1..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function 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.
.... actor SO 1..1 Reference(IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0) | IE MPD Organization(0.1.0)) Individual who was performing
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... location 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription SO 1..1 Reference(IE MPD MedicationRequest (ePrescription)(0.1.0)) Medication order that authorizes the dispense
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (3.0.0) (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity SO 1..1 SimpleQuantity(4.0.1) Amount dispensed
ObligationsActorSource
SHALL:able-to-populate Producer from MedicationDispense: MPD
... daysSupply 0..1 SimpleQuantity(4.0.1) Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver S 0..1 dateTime Date and time when the medication was handed over. When not present, the time of dispensation is assumed to be the time of issuing the dispense record.
... 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 SO 0..* IEMpdDosage(0.1.0) How the medication is to be used by the patient or administered by the caregiver
ObligationsActorSource
SHOULD:able-to-populate Producer from MedicationDispense: MPD
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... wasSubstituted S 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type S 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (3.0.0) (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
.... reason S 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (3.0.0) (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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base extensible IE MPD Medication Codes 📍0.1.0 This IG
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📍3.0.0 THO v7.4
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📍3.0.0 THO v7.4
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📍3.0.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error 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-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error MedicationDispense.meta, MedicationDispense.implicitRules, MedicationDispense.language, MedicationDispense.text, MedicationDispense.extension, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.extension:recorded, MedicationDispense.extension:receiverRelatedPerson, MedicationDispense.modifierExtension, MedicationDispense.identifier, MedicationDispense.partOf, MedicationDispense.status, MedicationDispense.statusReason[x], MedicationDispense.category, MedicationDispense.medication[x], MedicationDispense.medication[x]:medicationReference, MedicationDispense.subject, MedicationDispense.context, MedicationDispense.supportingInformation, MedicationDispense.performer, MedicationDispense.performer.extension, MedicationDispense.performer.modifierExtension, MedicationDispense.performer.function, MedicationDispense.performer.actor, MedicationDispense.location, MedicationDispense.authorizingPrescription, MedicationDispense.type, MedicationDispense.quantity, MedicationDispense.daysSupply, MedicationDispense.whenPrepared, MedicationDispense.whenHandedOver, MedicationDispense.destination, MedicationDispense.receiver, MedicationDispense.note, MedicationDispense.dosageInstruction, MedicationDispense.substitution, MedicationDispense.substitution.extension, MedicationDispense.substitution.modifierExtension, MedicationDispense.substitution.wasSubstituted, MedicationDispense.substitution.type, MedicationDispense.substitution.reason, MedicationDispense.substitution.responsibleParty, MedicationDispense.detectedIssue, MedicationDispense.eventHistory All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MedicationDispense.extension, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.extension:recorded, MedicationDispense.extension:receiverRelatedPerson, MedicationDispense.modifierExtension, MedicationDispense.performer.extension, MedicationDispense.performer.modifierExtension, MedicationDispense.substitution.extension, MedicationDispense.substitution.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
ie-md-handover-1 error MedicationDispense A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) status = 'completed' implies whenHandedOver.exists()
ie-md-status-1 error MedicationDispense A non-dispensation (declined, stopped, cancelled or on-hold) SHALL state the reason (HIQA EP 6.3.2) (status = 'declined' or status = 'stopped' or status = 'cancelled' or status = 'on-hold') implies statusReason.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

 

Other representations of profile: CSV, Excel, Schematron