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: IEMpdMedicationDispenseEDispensation - Detailed Descriptions

Draft as of 2026-09-28

Definitions for the ie-mpd-medicationdispense-edispensation resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. MedicationDispense
Definition

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

ShortDispensing a medication to a named patient
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
mdd-1: whenHandedOver cannot be before whenPrepared (whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared)
ie-md-status-1: 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())
ie-md-handover-1: A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) (status = 'completed' implies whenHandedOver.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
mdd-1: whenHandedOver cannot be before whenPrepared (whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared)
2. MedicationDispense.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. MedicationDispense.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. MedicationDispense.extension:renderedDosageInstruction
    Slice NamerenderedDosageInstruction
    Definition

    R5: MedicationDispense.renderedDosageInstruction (new:markdown)

    ShortFull representation of the dosage instructions
    Comments

    Element MedicationDispense.renderedDosageInstruction has a context of MedicationDispense based on following the parent source element upwards and mapping to MedicationDispense. Element MedicationDispense.renderedDosageInstruction has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Full representation of the dosage instructions (new)) (Extension Type: markdown)
    Is Modifierfalse
    Obligations
      ObligationsActorSource
      SHOULD:able-to-populateProducerfrom MedicationDispense: MPD
      Summaryfalse
      Requirements

      EHDSDosage

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      8. MedicationDispense.extension:recorded
      Slice Namerecorded
      Definition

      R5: MedicationDispense.recorded (new:dateTime)

      ShortR5: When the recording of the dispense started (new)
      Comments

      HIQA EP 6.2 Date and time of issuing the dispense record (Mandatory 1..1); 1..1 inherited from HL7 Europe MPD.

      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(R5: When the recording of the dispense started (new)) (Extension Type: dateTime)
      Is Modifierfalse
      Must Supporttrue
      Obligations
        ObligationsActorSource
        SHALL:able-to-populateProducerfrom MedicationDispense: MPD
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        10. MedicationDispense.extension:receiverRelatedPerson
        Slice NamereceiverRelatedPerson
        Definition

        HIQA EP 6.4.3 Related person is the receiver (Optional): the person (e.g. carer or family member) who collected the dispensed medication on the patient's behalf. R4 MedicationDispense.receiver allows only Patient or Practitioner.

        ShortIE MPD Dispense Receiver (Related Person)
        Control0..1
        TypeExtension(IE MPD Dispense Receiver (Related Person)) (Extension Type: Reference(IE MPD RelatedPerson))
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        12. MedicationDispense.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        14. MedicationDispense.identifier
        Definition

        Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

        ShortExternal identifier
        Comments

        HIQA EP 6.1 Dispensation identifier (Required 0..*). IE Medication Events requires at least one.


        This is a business identifier, not a resource identifier.

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control10..*
        TypeIdentifier
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. MedicationDispense.status
        Definition

        A code specifying the state of the set of dispense events.

        Shortpreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
        Comments

        HIQA EP 6.3.1 Dispensation status (Mandatory). A non-dispensation uses declined or stopped with a reason (invariant ie-md-status-1).


        This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

        Control1..1
        BindingThe codes SHALL be taken from MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
        (required to http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1)

        A coded concept specifying the state of the dispense event.

        Typecode
        Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Obligations
          ObligationsActorSource
          SHALL:able-to-populateProducerfrom MedicationDispense: MPD
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          18. MedicationDispense.statusReason[x]
          Definition

          Indicates the reason why a dispense was not performed.

          ShortWhy a dispense was not performed
          Comments

          HIQA EP 6.3.2 Dispensation status reason (Optional): coded (6.3.2.1) or free text (6.3.2.2, in statusReasonCodeableConcept.text). IE Medication Events requires a reason for a non-dispensation (safety: the prescriber needs to know why).

          Control0..1
          BindingFor example codes, see MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason|4.0.1
          (example to http://hl7.org/fhir/ValueSet/medicationdispense-status-reason|4.0.1)

          A code describing why a dispense was not performed.

          TypeChoice of: CodeableConcept, Reference(DetectedIssue)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          20. MedicationDispense.medication[x]
          Definition

          Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

          ShortWhat medication was supplied
          Comments

          HIQA EP 6.6 Dispensed medication (Mandatory 1..1); see Section 4.


          If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.

          Control1..1
          BindingUnless not suitable, these codes SHALL be taken from For example codes, see IEMpdMedicationCodes (0.1.0)http://hl7.org/fhir/ValueSet/medication-codes|4.0.1
          (extensible to https://hl7-ie.github.io/medication-events/fhir/ValueSet/ie-mpd-medication-codes|0.1.0)
          TypeChoice of: CodeableConcept, Reference(Medication)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Obligations
            ObligationsActorSource
            SHALL:able-to-populateProducerfrom MedicationDispense: MPD
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on MedicationDispense.medication[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
            • type @ $this
            • 22. MedicationDispense.medication[x]:medicationReference
              Slice NamemedicationReference
              Definition

              Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

              ShortWhat medication was supplied
              Comments

              If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.

              Control01..1
              TypeReference(Medication: MPD, Medication), CodeableConcept
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              24. MedicationDispense.subject
              Definition

              A link to a resource representing the person or the group to whom the medication will be given.

              ShortWho the dispense is for
              Comments

              SubstanceAdministration->subject->Patient.

              Control10..1
              TypeReference(IE MPD Patient (ePrescription/eDispensation), Patient, Group)
              Is Modifierfalse
              Must Supporttrue
              Obligations
                ObligationsActorSource
                SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                26. MedicationDispense.performer
                Definition

                Indicates who or what performed the event.

                ShortWho performed event
                Comments

                HIQA EP Section 2 (dispenser and pharmacy). Dispensers are registered pharmacists or registered pharmaceutical assistants.

                Control10..*
                TypeBackboneElement
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                28. MedicationDispense.performer.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                30. MedicationDispense.performer.actor
                Definition

                The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

                ShortIndividual who was performing
                Control1..1
                TypeReference(IE MPD Practitioner, IE MPD PractitionerRole, IE MPD Organization, Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson)
                Is Modifierfalse
                Must Supporttrue
                Must Support TypesNo must-support rules about the choice of types/profiles
                Obligations
                  ObligationsActorSource
                  SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  32. MedicationDispense.authorizingPrescription
                  Definition

                  Indicates the medication order that is being dispensed against.

                  ShortMedication order that authorizes the dispense
                  Comments

                  HIQA EP 6.5 Prescription item identifier with related request (Required 0..1). IE Medication Events requires exactly one (stricter than HIQA, IE Core OI-012): this profile covers dispensing against an electronic prescription; emergency supply uses the base IEMpdMedicationDispense.


                  Maps to basedOn in Event logical model.

                  Control10..1*
                  TypeReference(IE MPD MedicationRequest (ePrescription), MedicationRequest)
                  Is Modifierfalse
                  Must Supporttrue
                  Obligations
                    ObligationsActorSource
                    SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    34. MedicationDispense.quantity
                    Definition

                    The amount of medication that has been dispensed. Includes unit of measure.

                    ShortAmount dispensed
                    Comments

                    HIQA EP 6.7 Dispensed quantity (Mandatory 1..1).

                    Control10..1
                    TypeQuantity(SimpleQuantity)
                    Is Modifierfalse
                    Must Supporttrue
                    Obligations
                      ObligationsActorSource
                      SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      36. MedicationDispense.whenHandedOver
                      Definition

                      The time the dispensed product was provided to the patient or their representative.

                      ShortDate 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.When product was given out
                      Comments

                      HIQA EP 6.8 Date of dispensation (Mandatory) and 6.9 Time of dispensation (Required). Required when the status is completed (invariant ie-md-handover-1).

                      Control0..1
                      TypedateTime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      38. MedicationDispense.receiver
                      Definition

                      Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

                      ShortWho collected the medication
                      Comments

                      HIQA EP 6.4 Receiver (Optional): the patient (6.4.1) or a health practitioner (6.4.2). A related person (6.4.3) goes in extension[receiverRelatedPerson].

                      Control0..*
                      TypeReference(Patient, Practitioner)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      40. MedicationDispense.note
                      Definition

                      Extra information about the dispense that could not be conveyed in the other attributes.

                      ShortInformation about the dispense
                      Comments

                      HIQA EP 6.12 Additional information (Optional).

                      Control0..*
                      TypeAnnotation
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      42. MedicationDispense.dosageInstruction
                      Definition

                      Indicates how the medication is to be used by the patient.

                      ShortHow the medication is to be used by the patient or administered by the caregiver
                      Comments

                      HIQA EP 6.11 Dosage instructions (Required); see Section 5.


                      When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

                      Control0..*
                      TypeDosage(Dosage: MPD)
                      Is Modifierfalse
                      Must Supporttrue
                      Obligations
                        ObligationsActorSource
                        SHOULD:able-to-populateProducerfrom MedicationDispense: MPD
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        44. MedicationDispense.dosageInstruction.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        46. MedicationDispense.dosageInstruction.text
                        Definition

                        Free text dosage instructions e.g. SIG.

                        ShortFree text dosage instructions e.g. SIG
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        48. MedicationDispense.dosageInstruction.asNeeded[x]
                        Definition

                        Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

                        ShortTake "as needed" (for x)
                        Comments

                        Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".

                        Control0..1
                        BindingFor example codes, see SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1
                        (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1)

                        A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.

                        TypeChoice of: boolean, CodeableConcept
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.asNeeded[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • type @ $this
                        • 50. MedicationDispense.dosageInstruction.asNeeded[x]:asNeededBoolean
                          Slice NameasNeededBoolean
                          Definition

                          Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

                          ShortTake "as needed" (for x)
                          Comments

                          Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".

                          Control0..1
                          Typeboolean, CodeableConcept
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          EHDSDosage

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          52. MedicationDispense.substitution
                          Definition

                          Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

                          ShortWhether a substitution was performed on the dispense
                          Control0..1
                          TypeBackboneElement
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          54. MedicationDispense.substitution.modifierExtension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                          Summarytrue
                          Requirements

                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                          Alternate Namesextensions, user content, modifiers
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          56. MedicationDispense.substitution.wasSubstituted
                          Definition

                          True if the dispenser dispensed a different drug or product from what was prescribed.

                          ShortWhether a substitution was or was not performed on the dispense
                          Comments

                          HIQA EP 6.10 Substitution occurred (Optional).

                          Control1..1
                          Typeboolean
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          58. MedicationDispense.substitution.type
                          Definition

                          A code signifying whether a different drug was dispensed from what was prescribed.

                          ShortCode signifying whether a different drug was dispensed from what was prescribed
                          Control0..1
                          BindingFor example codes, see ActSubstanceAdminSubstitutionCode (3.0.0)http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
                          (example to http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode|3.0.0)

                          A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          60. MedicationDispense.substitution.reason
                          Definition

                          Indicates the reason for the substitution (or lack of substitution) from what was prescribed.

                          ShortWhy was substitution made
                          Control0..*
                          BindingFor example codes, see SubstanceAdminSubstitutionReason (3.0.0)http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason
                          (example to http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason|3.0.0)

                          A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                          Guidance on how to interpret the contents of this table can be foundhere

                          0. MedicationDispense
                          Invariantsie-md-status-1: 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())
                          ie-md-handover-1: A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) (status = 'completed' implies whenHandedOver.exists())
                          2. MedicationDispense.extension:recorded
                          Slice Namerecorded
                          Comments

                          HIQA EP 6.2 Date and time of issuing the dispense record (Mandatory 1..1); 1..1 inherited from HL7 Europe MPD.

                          Must Supporttrue
                          4. MedicationDispense.extension:receiverRelatedPerson
                          Slice NamereceiverRelatedPerson
                          Control0..1
                          TypeExtension(IE MPD Dispense Receiver (Related Person)) (Extension Type: Reference(IE MPD RelatedPerson))
                          6. MedicationDispense.identifier
                          Comments

                          HIQA EP 6.1 Dispensation identifier (Required 0..*). IE Medication Events requires at least one.

                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control1..?
                          Must Supporttrue
                          8. MedicationDispense.status
                          Comments

                          HIQA EP 6.3.1 Dispensation status (Mandatory). A non-dispensation uses declined or stopped with a reason (invariant ie-md-status-1).

                          Must Supporttrue
                          10. MedicationDispense.statusReason[x]
                          Comments

                          HIQA EP 6.3.2 Dispensation status reason (Optional): coded (6.3.2.1) or free text (6.3.2.2, in statusReasonCodeableConcept.text). IE Medication Events requires a reason for a non-dispensation (safety: the prescriber needs to know why).

                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Must Supporttrue
                          12. MedicationDispense.medication[x]
                          Comments

                          HIQA EP 6.6 Dispensed medication (Mandatory 1..1); see Section 4.

                          BindingUnless not suitable, these codes SHALL be taken from IEMpdMedicationCodes (0.1.0)
                          (extensible to https://hl7-ie.github.io/medication-events/fhir/ValueSet/ie-mpd-medication-codes|0.1.0)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Must Supporttrue
                          14. MedicationDispense.subject
                          Control1..?
                          TypeReference(IE MPD Patient (ePrescription/eDispensation))
                          Must Supporttrue
                          16. MedicationDispense.performer
                          Comments

                          HIQA EP Section 2 (dispenser and pharmacy). Dispensers are registered pharmacists or registered pharmaceutical assistants.

                          Control1..?
                          Must Supporttrue
                          18. MedicationDispense.performer.actor
                          TypeReference(IE MPD Practitioner, IE MPD PractitionerRole, IE MPD Organization)
                          Must Supporttrue
                          Must Support TypesNo must-support rules about the choice of types/profiles
                          20. MedicationDispense.authorizingPrescription
                          Comments

                          HIQA EP 6.5 Prescription item identifier with related request (Required 0..1). IE Medication Events requires exactly one (stricter than HIQA, IE Core OI-012): this profile covers dispensing against an electronic prescription; emergency supply uses the base IEMpdMedicationDispense.

                          Control1..1
                          TypeReference(IE MPD MedicationRequest (ePrescription))
                          Must Supporttrue
                          22. MedicationDispense.quantity
                          Comments

                          HIQA EP 6.7 Dispensed quantity (Mandatory 1..1).

                          Must Supporttrue
                          24. MedicationDispense.whenHandedOver
                          Comments

                          HIQA EP 6.8 Date of dispensation (Mandatory) and 6.9 Time of dispensation (Required). Required when the status is completed (invariant ie-md-handover-1).

                          Must Supporttrue
                          26. MedicationDispense.receiver
                          Comments

                          HIQA EP 6.4 Receiver (Optional): the patient (6.4.1) or a health practitioner (6.4.2). A related person (6.4.3) goes in extension[receiverRelatedPerson].

                          28. MedicationDispense.note
                          Comments

                          HIQA EP 6.12 Additional information (Optional).

                          30. MedicationDispense.dosageInstruction
                          Comments

                          HIQA EP 6.11 Dosage instructions (Required); see Section 5.

                          Must Supporttrue
                          32. MedicationDispense.dosageInstruction.text
                          Must Supporttrue
                          34. MedicationDispense.substitution
                          Must Supporttrue
                          36. MedicationDispense.substitution.wasSubstituted
                          Comments

                          HIQA EP 6.10 Substitution occurred (Optional).

                          Must Supporttrue
                          38. MedicationDispense.substitution.type
                          Must Supporttrue
                          40. MedicationDispense.substitution.reason
                          Must Supporttrue

                          Guidance on how to interpret the contents of this table can be foundhere

                          0. MedicationDispense
                          Definition

                          Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

                          ShortDispensing a medication to a named patient
                          Control0..*
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                          dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                          dom-6: A resource should have narrative for robust management (text.`div`.exists())
                          mdd-1: whenHandedOver cannot be before whenPrepared (whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared)
                          ie-md-status-1: 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())
                          ie-md-handover-1: A completed dispense SHALL record when the medication was handed over (HIQA EP 6.8 Date of dispensation, Mandatory) (status = 'completed' implies whenHandedOver.exists())
                          2. MedicationDispense.id
                          Definition

                          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                          ShortLogical id of this artifact
                          Comments

                          The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                          Control0..1
                          Typeid
                          Is Modifierfalse
                          Summarytrue
                          4. MedicationDispense.meta
                          Definition

                          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                          ShortMetadata about the resource
                          Control0..1
                          TypeMeta
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          6. MedicationDispense.implicitRules
                          Definition

                          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                          ShortA set of rules under which this content was created
                          Comments

                          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                          Control0..1
                          Typeuri
                          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          8. MedicationDispense.language
                          Definition

                          The base language in which the resource is written.

                          ShortLanguage of the resource content
                          Comments

                          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                          Control0..1
                          BindingThe codes SHOULD be taken from CommonLanguages
                          (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                          A human language.

                          Additional BindingsPurpose
                          AllLanguagesMax Binding
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          10. MedicationDispense.text
                          Definition

                          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                          ShortText summary of the resource, for human interpretation
                          Comments

                          Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                          Control0..1
                          TypeNarrative
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesnarrative, html, xhtml, display
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          12. MedicationDispense.contained
                          Definition

                          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                          ShortContained, inline Resources
                          Comments

                          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                          Control0..*
                          TypeResource
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesinline resources, anonymous resources, contained resources
                          14. MedicationDispense.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control1..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on MedicationDispense.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 16. MedicationDispense.extension:renderedDosageInstruction
                            Slice NamerenderedDosageInstruction
                            Definition

                            R5: MedicationDispense.renderedDosageInstruction (new:markdown)

                            ShortFull representation of the dosage instructions
                            Comments

                            Element MedicationDispense.renderedDosageInstruction has a context of MedicationDispense based on following the parent source element upwards and mapping to MedicationDispense. Element MedicationDispense.renderedDosageInstruction has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.

                            Control0..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(R5: Full representation of the dosage instructions (new)) (Extension Type: markdown)
                            Is Modifierfalse
                            Obligations
                              ObligationsActorSource
                              SHOULD:able-to-populateProducerfrom MedicationDispense: MPD
                              Summaryfalse
                              Requirements

                              EHDSDosage

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              18. MedicationDispense.extension:recorded
                              Slice Namerecorded
                              Definition

                              R5: MedicationDispense.recorded (new:dateTime)

                              ShortR5: When the recording of the dispense started (new)
                              Comments

                              HIQA EP 6.2 Date and time of issuing the dispense record (Mandatory 1..1); 1..1 inherited from HL7 Europe MPD.

                              Control1..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(R5: When the recording of the dispense started (new)) (Extension Type: dateTime)
                              Is Modifierfalse
                              Must Supporttrue
                              Obligations
                                ObligationsActorSource
                                SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                20. MedicationDispense.extension:receiverRelatedPerson
                                Slice NamereceiverRelatedPerson
                                Definition

                                HIQA EP 6.4.3 Related person is the receiver (Optional): the person (e.g. carer or family member) who collected the dispensed medication on the patient's behalf. R4 MedicationDispense.receiver allows only Patient or Practitioner.

                                ShortIE MPD Dispense Receiver (Related Person)
                                Control0..1
                                TypeExtension(IE MPD Dispense Receiver (Related Person)) (Extension Type: Reference(IE MPD RelatedPerson))
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                22. MedicationDispense.modifierExtension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                Summaryfalse
                                Requirements

                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                24. MedicationDispense.identifier
                                Definition

                                Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

                                ShortExternal identifier
                                Comments

                                HIQA EP 6.1 Dispensation identifier (Required 0..*). IE Medication Events requires at least one.

                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control1..*
                                TypeIdentifier
                                Is Modifierfalse
                                Must Supporttrue
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                26. MedicationDispense.partOf
                                Definition

                                The procedure that trigger the dispense.

                                ShortEvent that dispense is part of
                                Control0..*
                                TypeReference(Procedure)
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                28. MedicationDispense.status
                                Definition

                                A code specifying the state of the set of dispense events.

                                Shortpreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
                                Comments

                                HIQA EP 6.3.1 Dispensation status (Mandatory). A non-dispensation uses declined or stopped with a reason (invariant ie-md-status-1).

                                Control1..1
                                BindingThe codes SHALL be taken from MedicationDispense Status Codes
                                (required to http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1)

                                A coded concept specifying the state of the dispense event.

                                Typecode
                                Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Obligations
                                  ObligationsActorSource
                                  SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  30. MedicationDispense.statusReason[x]
                                  Definition

                                  Indicates the reason why a dispense was not performed.

                                  ShortWhy a dispense was not performed
                                  Comments

                                  HIQA EP 6.3.2 Dispensation status reason (Optional): coded (6.3.2.1) or free text (6.3.2.2, in statusReasonCodeableConcept.text). IE Medication Events requires a reason for a non-dispensation (safety: the prescriber needs to know why).

                                  Control0..1
                                  BindingFor example codes, see MedicationDispense Status Reason Codes
                                  (example to http://hl7.org/fhir/ValueSet/medicationdispense-status-reason|4.0.1)

                                  A code describing why a dispense was not performed.

                                  TypeChoice of: CodeableConcept, Reference(DetectedIssue)
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  32. MedicationDispense.category
                                  Definition

                                  Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

                                  ShortType of medication dispense
                                  Comments

                                  The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

                                  Control0..1
                                  BindingThe codes SHOULD be taken from MedicationDispense Category Codes
                                  (preferred to http://hl7.org/fhir/ValueSet/medicationdispense-category|4.0.1)

                                  A code describing where the dispensed medication is expected to be consumed or administered.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  34. MedicationDispense.medication[x]
                                  Definition

                                  Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

                                  ShortWhat medication was supplied
                                  Comments

                                  HIQA EP 6.6 Dispensed medication (Mandatory 1..1); see Section 4.

                                  Control1..1
                                  BindingUnless not suitable, these codes SHALL be taken from IEMpdMedicationCodes (0.1.0)
                                  (extensible to https://hl7-ie.github.io/medication-events/fhir/ValueSet/ie-mpd-medication-codes|0.1.0)
                                  TypeChoice of: CodeableConcept, Reference(Medication)
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                  Obligations
                                    ObligationsActorSource
                                    SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    SlicingThis element introduces a set of slices on MedicationDispense.medication[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                    • type @ $this
                                    • 36. MedicationDispense.medication[x]:medicationReference
                                      Slice NamemedicationReference
                                      Definition

                                      Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

                                      ShortWhat medication was supplied
                                      Comments

                                      If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.

                                      Control0..1
                                      TypeReference(Medication: MPD)
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      38. MedicationDispense.subject
                                      Definition

                                      A link to a resource representing the person or the group to whom the medication will be given.

                                      ShortWho the dispense is for
                                      Comments

                                      SubstanceAdministration->subject->Patient.

                                      Control1..1
                                      TypeReference(IE MPD Patient (ePrescription/eDispensation))
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActorSource
                                        SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        40. MedicationDispense.context
                                        Definition

                                        The encounter or episode of care that establishes the context for this event.

                                        ShortEncounter / Episode associated with event
                                        Control0..1
                                        TypeReference(Encounter, EpisodeOfCare)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        42. MedicationDispense.supportingInformation
                                        Definition

                                        Additional information that supports the medication being dispensed.

                                        ShortInformation that supports the dispensing of the medication
                                        Control0..*
                                        TypeReference(Resource)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        44. MedicationDispense.performer
                                        Definition

                                        Indicates who or what performed the event.

                                        ShortWho performed event
                                        Comments

                                        HIQA EP Section 2 (dispenser and pharmacy). Dispensers are registered pharmacists or registered pharmaceutical assistants.

                                        Control1..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        46. MedicationDispense.performer.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        48. MedicationDispense.performer.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        50. MedicationDispense.performer.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        52. MedicationDispense.performer.function
                                        Definition

                                        Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

                                        ShortWho performed the dispense and what they did
                                        Control0..1
                                        BindingFor example codes, see MedicationDispense Performer Function Codes
                                        (example to http://hl7.org/fhir/ValueSet/medicationdispense-performer-function|4.0.1)

                                        A code describing the role an individual played in dispensing a medication.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Allows disambiguation of the types of involvement of different performers.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        54. MedicationDispense.performer.actor
                                        Definition

                                        The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

                                        ShortIndividual who was performing
                                        Control1..1
                                        TypeReference(IE MPD Practitioner, IE MPD PractitionerRole, IE MPD Organization)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Must Support TypesNo must-support rules about the choice of types/profiles
                                        Obligations
                                          ObligationsActorSource
                                          SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          56. MedicationDispense.location
                                          Definition

                                          The principal physical location where the dispense was performed.

                                          ShortWhere the dispense occurred
                                          Control0..1
                                          TypeReference(Location)
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          58. MedicationDispense.authorizingPrescription
                                          Definition

                                          Indicates the medication order that is being dispensed against.

                                          ShortMedication order that authorizes the dispense
                                          Comments

                                          HIQA EP 6.5 Prescription item identifier with related request (Required 0..1). IE Medication Events requires exactly one (stricter than HIQA, IE Core OI-012): this profile covers dispensing against an electronic prescription; emergency supply uses the base IEMpdMedicationDispense.

                                          Control1..1
                                          TypeReference(IE MPD MedicationRequest (ePrescription))
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Obligations
                                            ObligationsActorSource
                                            SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            60. MedicationDispense.type
                                            Definition

                                            Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

                                            ShortTrial fill, partial fill, emergency fill, etc.
                                            Control0..1
                                            BindingFor example codes, see ActPharmacySupplyType (3.0.0)
                                            (example to http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType|3.0.0)

                                            Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            62. MedicationDispense.quantity
                                            Definition

                                            The amount of medication that has been dispensed. Includes unit of measure.

                                            ShortAmount dispensed
                                            Comments

                                            HIQA EP 6.7 Dispensed quantity (Mandatory 1..1).

                                            Control1..1
                                            TypeQuantity(SimpleQuantity)
                                            Is Modifierfalse
                                            Must Supporttrue
                                            Obligations
                                              ObligationsActorSource
                                              SHALL:able-to-populateProducerfrom MedicationDispense: MPD
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              64. MedicationDispense.daysSupply
                                              Definition

                                              The amount of medication expressed as a timing amount.

                                              ShortAmount of medication expressed as a timing amount
                                              Control0..1
                                              TypeQuantity(SimpleQuantity)
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              66. MedicationDispense.whenPrepared
                                              Definition

                                              The time when the dispensed product was packaged and reviewed.

                                              ShortWhen product was packaged and reviewed
                                              Control0..1
                                              TypedateTime
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              68. MedicationDispense.whenHandedOver
                                              Definition

                                              The time the dispensed product was provided to the patient or their representative.

                                              ShortDate 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.
                                              Comments

                                              HIQA EP 6.8 Date of dispensation (Mandatory) and 6.9 Time of dispensation (Required). Required when the status is completed (invariant ie-md-handover-1).

                                              Control0..1
                                              TypedateTime
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              70. MedicationDispense.destination
                                              Definition

                                              Identification of the facility/location where the medication was shipped to, as part of the dispense event.

                                              ShortWhere the medication was sent
                                              Control0..1
                                              TypeReference(Location)
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              72. MedicationDispense.receiver
                                              Definition

                                              Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

                                              ShortWho collected the medication
                                              Comments

                                              HIQA EP 6.4 Receiver (Optional): the patient (6.4.1) or a health practitioner (6.4.2). A related person (6.4.3) goes in extension[receiverRelatedPerson].

                                              Control0..*
                                              TypeReference(Patient, Practitioner)
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              74. MedicationDispense.note
                                              Definition

                                              Extra information about the dispense that could not be conveyed in the other attributes.

                                              ShortInformation about the dispense
                                              Comments

                                              HIQA EP 6.12 Additional information (Optional).

                                              Control0..*
                                              TypeAnnotation
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              76. MedicationDispense.dosageInstruction
                                              Definition

                                              Indicates how the medication is to be used by the patient.

                                              ShortHow the medication is to be used by the patient or administered by the caregiver
                                              Comments

                                              HIQA EP 6.11 Dosage instructions (Required); see Section 5.

                                              Control0..*
                                              TypeDosage(Dosage: MPD)
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Obligations
                                                ObligationsActorSource
                                                SHOULD:able-to-populateProducerfrom MedicationDispense: MPD
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                78. MedicationDispense.dosageInstruction.id
                                                Definition

                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                80. MedicationDispense.dosageInstruction.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                ShortAdditional content defined by implementations
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 82. MedicationDispense.dosageInstruction.modifierExtension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                  Summarytrue
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content, modifiers
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  84. MedicationDispense.dosageInstruction.sequence
                                                  Definition

                                                  Indicates the order in which the dosage instructions should be applied or interpreted.

                                                  ShortThe order of the dosage instructions
                                                  Control0..1
                                                  Typeinteger
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  EHDSDosage

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  86. MedicationDispense.dosageInstruction.text
                                                  Definition

                                                  Free text dosage instructions e.g. SIG.

                                                  ShortFree text dosage instructions e.g. SIG
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Requirements

                                                  Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  88. MedicationDispense.dosageInstruction.additionalInstruction
                                                  Definition

                                                  Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").

                                                  ShortSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
                                                  Comments

                                                  Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text.

                                                  Control0..*
                                                  BindingFor example codes, see SNOMEDCTAdditionalDosageInstructions
                                                  (example to http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1)

                                                  A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Requirements

                                                  Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  90. MedicationDispense.dosageInstruction.patientInstruction
                                                  Definition

                                                  Instructions in terms that are understood by the patient or consumer.

                                                  ShortPatient or consumer oriented instructions
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Obligations
                                                    ObligationsActorSource
                                                    SHOULD:able-to-populateProducerfrom Dosage: MPD
                                                    Summarytrue
                                                    Requirements

                                                    EHDSDosage

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    92. MedicationDispense.dosageInstruction.timing
                                                    Definition

                                                    When medication should be administered.

                                                    ShortWhen medication should be administered
                                                    Comments

                                                    This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.

                                                    Control0..1
                                                    TypeTiming
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Requirements

                                                    The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    94. MedicationDispense.dosageInstruction.timing.id
                                                    Definition

                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    96. MedicationDispense.dosageInstruction.timing.extension
                                                    Definition

                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                    ShortAdditional content defined by implementations
                                                    Comments

                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.timing.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 98. MedicationDispense.dosageInstruction.timing.modifierExtension
                                                      Definition

                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                      Comments

                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                      Summarytrue
                                                      Requirements

                                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                      Alternate Namesextensions, user content, modifiers
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      100. MedicationDispense.dosageInstruction.timing.event
                                                      Definition

                                                      Identifies specific times when the event occurs.

                                                      ShortWhen the event occurs
                                                      Control0..*
                                                      TypedateTime
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      102. MedicationDispense.dosageInstruction.timing.repeat
                                                      Definition

                                                      A set of rules that describe when the event is scheduled.

                                                      ShortWhen the event is to occur
                                                      Control0..1
                                                      TypeElement
                                                      Is Modifierfalse
                                                      Obligations
                                                        ObligationsActorSource
                                                        SHALL:able-to-populateProducerfrom Dosage: MPD
                                                        Summarytrue
                                                        Requirements

                                                        EHDSDosage

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        tim-1: if there's a duration, there needs to be duration units (duration.empty() or durationUnit.exists())
                                                        tim-2: if there's a period, there needs to be period units (period.empty() or periodUnit.exists())
                                                        tim-4: duration SHALL be a non-negative value (duration.exists() implies duration >= 0)
                                                        tim-5: period SHALL be a non-negative value (period.exists() implies period >= 0)
                                                        tim-6: If there's a periodMax, there must be a period (periodMax.empty() or period.exists())
                                                        tim-7: If there's a durationMax, there must be a duration (durationMax.empty() or duration.exists())
                                                        tim-8: If there's a countMax, there must be a count (countMax.empty() or count.exists())
                                                        tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) (offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())))
                                                        tim-10: If there's a timeOfDay, there cannot be a when, or vice versa (timeOfDay.empty() or when.empty())
                                                        104. MedicationDispense.dosageInstruction.timing.repeat.id
                                                        Definition

                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        106. MedicationDispense.dosageInstruction.timing.repeat.extension
                                                        Definition

                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                        ShortAdditional content defined by implementations
                                                        Comments

                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                        Control0..*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Alternate Namesextensions, user content
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.timing.repeat.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 108. MedicationDispense.dosageInstruction.timing.repeat.bounds[x]
                                                          Definition

                                                          Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

                                                          ShortLength/Range of lengths, or (Start and/or end) limits
                                                          Control0..1
                                                          TypeChoice of: Duration, Range, Period
                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                          Is Modifierfalse
                                                          Obligations
                                                            ObligationsActorDocumentationSource
                                                            SHALL:able-to-populateProducer

                                                            System SHALL support at least Duration data type for the element

                                                            from Dosage: MPD
                                                            Summarytrue
                                                            Requirements

                                                            EHDSDosage

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            110. MedicationDispense.dosageInstruction.timing.repeat.count
                                                            Definition

                                                            A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.

                                                            ShortNumber of times to repeat
                                                            Comments

                                                            If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

                                                            Control0..1
                                                            TypepositiveInt
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Repetitions may be limited by end time or total occurrences.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            112. MedicationDispense.dosageInstruction.timing.repeat.countMax
                                                            Definition

                                                            If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.

                                                            ShortMaximum number of times to repeat
                                                            Control0..1
                                                            TypepositiveInt
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            114. MedicationDispense.dosageInstruction.timing.repeat.duration
                                                            Definition

                                                            How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.

                                                            ShortHow long when it happens
                                                            Comments

                                                            For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

                                                            Control0..1
                                                            Typedecimal
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            EHDSDosage

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            116. MedicationDispense.dosageInstruction.timing.repeat.durationMax
                                                            Definition

                                                            If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.

                                                            ShortHow long when it happens (Max)
                                                            Comments

                                                            For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

                                                            Control0..1
                                                            Typedecimal
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Some activities are not instantaneous and need to be maintained for a period of time.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            118. MedicationDispense.dosageInstruction.timing.repeat.durationUnit
                                                            Definition

                                                            The units of time for the duration, in UCUM units.

                                                            Shorts | min | h | d | wk | mo | a - unit of time (UCUM)
                                                            Control0..1
                                                            BindingThe codes SHALL be taken from UnitsOfTime
                                                            (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1)

                                                            A unit of time (units from UCUM).

                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            EHDSDosage

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            120. MedicationDispense.dosageInstruction.timing.repeat.frequency
                                                            Definition

                                                            The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.

                                                            ShortEvent occurs frequency times per period
                                                            Control0..1
                                                            TypepositiveInt
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Obligations
                                                              ObligationsActorSource
                                                              SHALL:able-to-populateProducerfrom Dosage: MPD
                                                              Summarytrue
                                                              Requirements

                                                              EHDSDosage

                                                              Meaning if MissingIf no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              122. MedicationDispense.dosageInstruction.timing.repeat.frequencyMax
                                                              Definition

                                                              If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

                                                              ShortEvent occurs up to frequencyMax times per period
                                                              Control0..1
                                                              TypepositiveInt
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              124. MedicationDispense.dosageInstruction.timing.repeat.period
                                                              Definition

                                                              Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.

                                                              ShortEvent occurs frequency times per period
                                                              Control0..1
                                                              Typedecimal
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Obligations
                                                                ObligationsActorSource
                                                                SHALL:able-to-populateProducerfrom Dosage: MPD
                                                                Summarytrue
                                                                Requirements

                                                                EHDSDosage

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                126. MedicationDispense.dosageInstruction.timing.repeat.periodMax
                                                                Definition

                                                                If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.

                                                                ShortUpper limit of period (3-4 hours)
                                                                Control0..1
                                                                Typedecimal
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                128. MedicationDispense.dosageInstruction.timing.repeat.periodUnit
                                                                Definition

                                                                The units of time for the period in UCUM units.

                                                                Shorts | min | h | d | wk | mo | a - unit of time (UCUM)
                                                                Control0..1
                                                                BindingThe codes SHALL be taken from UnitsOfTime
                                                                (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1)

                                                                A unit of time (units from UCUM).

                                                                Typecode
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Obligations
                                                                  ObligationsActorSource
                                                                  SHALL:able-to-populateProducerfrom Dosage: MPD
                                                                  Summarytrue
                                                                  Requirements

                                                                  EHDSDosage

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  130. MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek
                                                                  Definition

                                                                  If one or more days of week is provided, then the action happens only on the specified day(s).

                                                                  Shortmon | tue | wed | thu | fri | sat | sun
                                                                  Comments

                                                                  If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.

                                                                  Control0..*
                                                                  BindingThe codes SHALL be taken from DaysOfWeek
                                                                  (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1)
                                                                  Typecode
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

                                                                  EHDSDosage

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  132. MedicationDispense.dosageInstruction.timing.repeat.timeOfDay
                                                                  Definition

                                                                  Specified time of day for action to take place.

                                                                  ShortTime of day for action
                                                                  Comments

                                                                  When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.

                                                                  Control0..*
                                                                  Typetime
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

                                                                  EHDSDosage

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  134. MedicationDispense.dosageInstruction.timing.repeat.when
                                                                  Definition

                                                                  An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

                                                                  ShortCode for time period of occurrence
                                                                  Comments

                                                                  When more than one event is listed, the event is tied to the union of the specified events.

                                                                  Control0..*
                                                                  BindingThe codes SHALL be taken from EventTiming
                                                                  (required to http://hl7.org/fhir/ValueSet/event-timing|4.0.1)

                                                                  Real world event relating to the schedule.

                                                                  Typecode
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

                                                                  EHDSDosage

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  136. MedicationDispense.dosageInstruction.timing.repeat.offset
                                                                  Definition

                                                                  The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.

                                                                  ShortMinutes from event (before or after)
                                                                  Control0..1
                                                                  TypeunsignedInt
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  138. MedicationDispense.dosageInstruction.timing.code
                                                                  Definition

                                                                  A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

                                                                  ShortBID | TID | QID | AM | PM | QD | QOD | +
                                                                  Comments

                                                                  BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).

                                                                  Control0..1
                                                                  BindingThe codes SHOULD be taken from TimingAbbreviation
                                                                  (preferred to http://hl7.org/fhir/ValueSet/timing-abbreviation|4.0.1)

                                                                  Code for a known / defined timing pattern.

                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  140. MedicationDispense.dosageInstruction.asNeeded[x]
                                                                  Definition

                                                                  Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

                                                                  ShortTake "as needed" (for x)
                                                                  Comments

                                                                  Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".

                                                                  Control0..1
                                                                  BindingFor example codes, see SNOMEDCTMedicationAsNeededReasonCodes
                                                                  (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1)

                                                                  A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.

                                                                  TypeChoice of: boolean, CodeableConcept
                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.asNeeded[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • type @ $this
                                                                  • 142. MedicationDispense.dosageInstruction.asNeeded[x]:asNeededBoolean
                                                                    Slice NameasNeededBoolean
                                                                    Definition

                                                                    Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

                                                                    ShortTake "as needed" (for x)
                                                                    Comments

                                                                    Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".

                                                                    Control0..1
                                                                    Typeboolean
                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Requirements

                                                                    EHDSDosage

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    144. MedicationDispense.dosageInstruction.site
                                                                    Definition

                                                                    Body site to administer to.

                                                                    ShortBody site to administer to
                                                                    Comments

                                                                    If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.

                                                                    Control0..1
                                                                    BindingFor example codes, see SNOMEDCTAnatomicalStructureForAdministrationSiteCodes
                                                                    (example to http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1)

                                                                    A coded concept describing the site location the medicine enters into or onto the body.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    EHDSDosage

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    146. MedicationDispense.dosageInstruction.route
                                                                    Definition

                                                                    How drug should enter body.

                                                                    ShortHow drug should enter body
                                                                    Control0..1
                                                                    BindingFor example codes, see SNOMEDCTRouteCodes
                                                                    (example to http://hl7.org/fhir/ValueSet/route-codes|4.0.1)

                                                                    A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Obligations
                                                                      ObligationsActorSource
                                                                      SHOULD:able-to-populateProducerfrom Dosage: MPD
                                                                      Summarytrue
                                                                      Requirements

                                                                      EHDSDosage

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      148. MedicationDispense.dosageInstruction.method
                                                                      Definition

                                                                      Technique for administering medication.

                                                                      ShortTechnique for administering medication
                                                                      Comments

                                                                      Terminologies used often pre-coordinate this term with the route and or form of administration.

                                                                      Control0..1
                                                                      BindingFor example codes, see SNOMEDCTAdministrationMethodCodes
                                                                      (example to http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1)

                                                                      A coded concept describing the technique by which the medicine is administered.

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      150. MedicationDispense.dosageInstruction.doseAndRate
                                                                      Definition

                                                                      The amount of medication administered.

                                                                      ShortAmount of medication administered
                                                                      Control0..*
                                                                      TypeElement
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      EHDSDosage

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      152. MedicationDispense.dosageInstruction.doseAndRate.id
                                                                      Definition

                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      154. MedicationDispense.dosageInstruction.doseAndRate.extension
                                                                      Definition

                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                      ShortAdditional content defined by implementations
                                                                      Comments

                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesextensions, user content
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction.doseAndRate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 156. MedicationDispense.dosageInstruction.doseAndRate.type
                                                                        Definition

                                                                        The kind of dose or rate specified, for example, ordered or calculated.

                                                                        ShortThe kind of dose or rate specified
                                                                        Control0..1
                                                                        BindingFor example codes, see DoseAndRateType
                                                                        (example to http://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1)

                                                                        The kind of dose or rate specified.

                                                                        TypeCodeableConcept
                                                                        Is Modifierfalse
                                                                        Summarytrue
                                                                        Requirements

                                                                        If the type is not populated, assume to be "ordered".

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        158. MedicationDispense.dosageInstruction.doseAndRate.dose[x]
                                                                        Definition

                                                                        Amount of medication per dose.

                                                                        ShortAmount of medication per dose
                                                                        Comments

                                                                        Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

                                                                        Control0..1
                                                                        TypeChoice of: Range, Quantity(SimpleQuantity)
                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                        Is Modifierfalse
                                                                        Obligations
                                                                          ObligationsActorDocumentationSource
                                                                          SHALL:able-to-populateProducer

                                                                          System SHALL support at least Quantity data type for the element

                                                                          from Dosage: MPD
                                                                          Summarytrue
                                                                          Requirements

                                                                          EHDSDosage

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          160. MedicationDispense.dosageInstruction.doseAndRate.rate[x]
                                                                          Definition

                                                                          Amount of medication per unit of time.

                                                                          ShortAmount of medication per unit of time
                                                                          Comments

                                                                          It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate.

                                                                          It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.

                                                                          Control0..1
                                                                          TypeChoice of: Ratio, Range, Quantity(SimpleQuantity)
                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          EHDSDosage

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          162. MedicationDispense.dosageInstruction.maxDosePerPeriod
                                                                          Definition

                                                                          Upper limit on medication per unit of time.

                                                                          ShortUpper limit on medication per unit of time
                                                                          Comments

                                                                          This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".

                                                                          Control0..1
                                                                          TypeRatio
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          164. MedicationDispense.dosageInstruction.maxDosePerAdministration
                                                                          Definition

                                                                          Upper limit on medication per administration.

                                                                          ShortUpper limit on medication per administration
                                                                          Comments

                                                                          This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.

                                                                          Control0..1
                                                                          TypeQuantity(SimpleQuantity)
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          166. MedicationDispense.dosageInstruction.maxDosePerLifetime
                                                                          Definition

                                                                          Upper limit on medication per lifetime of the patient.

                                                                          ShortUpper limit on medication per lifetime of the patient
                                                                          Control0..1
                                                                          TypeQuantity(SimpleQuantity)
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          168. MedicationDispense.substitution
                                                                          Definition

                                                                          Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

                                                                          ShortWhether a substitution was performed on the dispense
                                                                          Control0..1
                                                                          TypeBackboneElement
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          170. MedicationDispense.substitution.id
                                                                          Definition

                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          172. MedicationDispense.substitution.extension
                                                                          Definition

                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                          ShortAdditional content defined by implementations
                                                                          Comments

                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                          Control0..*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          174. MedicationDispense.substitution.modifierExtension
                                                                          Definition

                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                          Comments

                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                          Control0..*
                                                                          TypeExtension
                                                                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                          Summarytrue
                                                                          Requirements

                                                                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                          Alternate Namesextensions, user content, modifiers
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          176. MedicationDispense.substitution.wasSubstituted
                                                                          Definition

                                                                          True if the dispenser dispensed a different drug or product from what was prescribed.

                                                                          ShortWhether a substitution was or was not performed on the dispense
                                                                          Comments

                                                                          HIQA EP 6.10 Substitution occurred (Optional).

                                                                          Control1..1
                                                                          Typeboolean
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          178. MedicationDispense.substitution.type
                                                                          Definition

                                                                          A code signifying whether a different drug was dispensed from what was prescribed.

                                                                          ShortCode signifying whether a different drug was dispensed from what was prescribed
                                                                          Control0..1
                                                                          BindingFor example codes, see ActSubstanceAdminSubstitutionCode (3.0.0)
                                                                          (example to http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode|3.0.0)

                                                                          A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

                                                                          TypeCodeableConcept
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          180. MedicationDispense.substitution.reason
                                                                          Definition

                                                                          Indicates the reason for the substitution (or lack of substitution) from what was prescribed.

                                                                          ShortWhy was substitution made
                                                                          Control0..*
                                                                          BindingFor example codes, see SubstanceAdminSubstitutionReason (3.0.0)
                                                                          (example to http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason|3.0.0)

                                                                          A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

                                                                          TypeCodeableConcept
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          182. MedicationDispense.substitution.responsibleParty
                                                                          Definition

                                                                          The person or organization that has primary responsibility for the substitution.

                                                                          ShortWho is responsible for the substitution
                                                                          Control0..*
                                                                          TypeReference(Practitioner, PractitionerRole)
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          184. MedicationDispense.detectedIssue
                                                                          Definition

                                                                          Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.

                                                                          ShortClinical issue with action
                                                                          Comments

                                                                          This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.

                                                                          Control0..*
                                                                          TypeReference(DetectedIssue)
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate NamesContraindication, Drug Utilization Review (DUR), Alert
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          186. MedicationDispense.eventHistory
                                                                          Definition

                                                                          A summary of the events of interest that have occurred, such as when the dispense was verified.

                                                                          ShortA list of relevant lifecycle events
                                                                          Comments

                                                                          This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

                                                                          Control0..*
                                                                          TypeReference(Provenance)
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))