IPTp-SP Digital Support System Implementation Guide
0.1.0 - ci-build Kenya flag

IPTp-SP Digital Support System Implementation Guide, published by IPTp-SP Digital Support System Implementation Team. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/daviemukungi/IPTp-FHIR-implementationIG/ and changes regularly. See the Directory of published versions

Resource Profile: IPTpDoseAdministration - Detailed Descriptions

Draft as of 2026-06-30

Definitions for the iptp-dose-administration resource profile.

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

0. MedicationAdministration
Definition

Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

ShortAdministration of medication to a 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())
2. MedicationAdministration.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()))
4. MedicationAdministration.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.

Control20..*
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 MedicationAdministration.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. MedicationAdministration.extension:doseNumber
    Slice NamedoseNumber
    Definition

    Sequential dose number in the IPTp schedule (1–4+)

    ShortIPTp Dose Number
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(IPTp Dose Number) (Extension Type: positiveInt)
    Is Modifierfalse
    Must Supporttrue
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. MedicationAdministration.extension:administrationMethod
    Slice NameadministrationMethod
    Definition

    Whether the dose was DOT (clinic) or self-administered (home)

    ShortIPTp Administration Method
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(IPTp Administration Method) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. MedicationAdministration.extension:confirmationStatus
    Slice NameconfirmationStatus
    Definition

    Tracks the T-0 / 24h / 72h confirmation engine outcome for a self-administered dose (confirmed / pending / missed)

    ShortSet for self-admin doses only: confirmation-pending on T-0, confirmation-confirmed on Reply 1, confirmation-missed after 72h with no reply
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(IPTp Dose Confirmation Status) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. MedicationAdministration.extension:spacingValidFlag
    Slice NamespacingValidFlag
    Definition

    TRUE if the confirmed dose date respects the minimum 28-day spacing from the previous dose; computed when confirmation_status = confirmation-confirmed

    ShortComputed when confirmationStatus = confirmation-confirmed; TRUE if ≥28 days since previous dose
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(IPTp Dose Spacing Valid Flag) (Extension Type: boolean)
    Is Modifierfalse
    Must Supporttrue
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. MedicationAdministration.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())
    16. MedicationAdministration.status
    Definition

    Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.

    Shortcompleted | not-done | in-progressin-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
    Comments

    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 MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/medication-admin-status)
    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
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. MedicationAdministration.medication[x]
    Definition

    Identifies the medication that was 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 was administered
    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.

    Control1..1
    BindingFor example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes|4.0.1
    (example to http://hl7.org/fhir/ValueSet/medication-codes|4.0.1)

    Codes identifying substance or product that can be administered.

    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
    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 MedicationAdministration.medication[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 20. MedicationAdministration.medication[x]:medicationReference
      Slice NamemedicationReference
      Definition

      Identifies the medication that was 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 was administered
      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(IPTp SP Medication, 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()))
      22. MedicationAdministration.subject
      Definition

      The person or animal or group receiving the medication.

      ShortWho received medication
      Control1..1
      TypeReference(IPTp Enrolled Patient, Patient, Group)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. MedicationAdministration.effective[x]
      Definition

      A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

      ShortStart and end time of administration
      Control1..1
      TypeChoice of: dateTime, Period
      [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
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      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 MedicationAdministration.effective[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • type @ $this
      • 26. MedicationAdministration.effective[x]:effectiveDateTime
        Slice NameeffectiveDateTime
        Definition

        A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

        ShortActual or planned date of dose administrationStart and end time of administration
        Control01..1
        TypedateTime, Period
        [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
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. MedicationAdministration.performer
        Definition

        Indicates who or what performed the medication administration and how they were involved.

        ShortWho performed the medication administration and what they did
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. MedicationAdministration.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())
        32. MedicationAdministration.performer.actor
        Definition

        Indicates who or what performed the medication administration.

        ShortRequired only for DOT doses; omit for self-adminWho performed the medication administration
        Control1..1
        TypeReference(IPTp ANC Provider, Practitioner, PractitionerRole, Patient, RelatedPerson, Device)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. MedicationAdministration.note
        Definition

        Extra information about the medication administration that is not conveyed by the other attributes.

        ShortAdditional notes (e.g. confirmed via SMS reply 1)Information about the administration
        Control0..*
        TypeAnnotation
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. MedicationAdministration.dosage
        Definition

        Describes the medication dosage information details e.g. dose, rate, site, route, etc.

        ShortDetails of how medication was taken
        Control10..1
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] (dose.exists() or rate.exists())
        mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] (dose.exists() or rate.exists())
        38. MedicationAdministration.dosage.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())
        40. MedicationAdministration.dosage.text
        Definition

        Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.

        The dosage instructions should reflect the dosage of the medication that was administered.

        ShortSwallow whole. With or without food.Free 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
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. MedicationAdministration.dosage.route
        Definition

        A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

        ShortPath of substance into body
        Control0..1
        BindingFor example codes, see SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes|4.0.1
        (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
        Must Supporttrue
        Summaryfalse
        Pattern Value{
          "coding" : [{
            "system" : "http://snomed.info/sct",
            "code" : "26643006",
            "display" : "Oral route"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. MedicationAdministration.dosage.dose
        Definition

        The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.

        Short3 SP tablets taken togetherAmount of medication per dose
        Comments

        If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.

        Control0..1
        TypeQuantity(SimpleQuantity)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. MedicationAdministration.dosage.dose.value
        Definition

        The value of the measured amount. The value includes an implicit precision in the presentation of the value.

        ShortNumerical value (with implicit precision)
        Comments

        The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

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

        Precision is handled implicitly in almost all cases of measurement.

        Pattern Value3
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. MedicationAdministration.dosage.dose.comparator
        Definition

        Not allowed to be used in this context


        How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

        Short< | <= | >= | > - how to understand the value
        Control0..01
        BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
        (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

        How the Quantity should be understood and represented.

        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

        Meaning if MissingIf there is no comparator, then there is no modification of the value
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. MedicationAdministration.dosage.dose.unit
        Definition

        A human-readable form of the unit.

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

        There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

        Pattern Valuetablet
        Invariantsele-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. MedicationAdministration
        2. MedicationAdministration.extension
        Control2..?
        SlicingThis element introduces a set of slices on MedicationAdministration.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 4. MedicationAdministration.extension:doseNumber
          Slice NamedoseNumber
          Control1..1
          TypeExtension(IPTp Dose Number) (Extension Type: positiveInt)
          Must Supporttrue
          6. MedicationAdministration.extension:administrationMethod
          Slice NameadministrationMethod
          Control1..1
          TypeExtension(IPTp Administration Method) (Extension Type: CodeableConcept)
          Must Supporttrue
          8. MedicationAdministration.extension:confirmationStatus
          Slice NameconfirmationStatus
          ShortSet for self-admin doses only: confirmation-pending on T-0, confirmation-confirmed on Reply 1, confirmation-missed after 72h with no reply
          Control0..1
          TypeExtension(IPTp Dose Confirmation Status) (Extension Type: CodeableConcept)
          Must Supporttrue
          10. MedicationAdministration.extension:spacingValidFlag
          Slice NamespacingValidFlag
          ShortComputed when confirmationStatus = confirmation-confirmed; TRUE if ≥28 days since previous dose
          Control0..1
          TypeExtension(IPTp Dose Spacing Valid Flag) (Extension Type: boolean)
          Must Supporttrue
          12. MedicationAdministration.status
          Shortcompleted | not-done | in-progress
          BindingThe codes SHALL be taken from MedicationAdministration Status Codes
          (required to http://hl7.org/fhir/ValueSet/medication-admin-status)
          Must Supporttrue
          14. MedicationAdministration.medication[x]
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Must Supporttrue
          SlicingThis element introduces a set of slices on MedicationAdministration.medication[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • type @ $this
          • 16. MedicationAdministration.medication[x]:medicationReference
            Slice NamemedicationReference
            Control0..1
            TypeReference(IPTp SP Medication)
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            18. MedicationAdministration.subject
            TypeReference(IPTp Enrolled Patient)
            Must Supporttrue
            20. MedicationAdministration.effective[x]
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Must Supporttrue
            SlicingThis element introduces a set of slices on MedicationAdministration.effective[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • type @ $this
            • 22. MedicationAdministration.effective[x]:effectiveDateTime
              Slice NameeffectiveDateTime
              ShortActual or planned date of dose administration
              Control0..1
              TypedateTime
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              24. MedicationAdministration.performer
              Must Supporttrue
              26. MedicationAdministration.performer.actor
              ShortRequired only for DOT doses; omit for self-admin
              TypeReference(IPTp ANC Provider)
              Must Supporttrue
              28. MedicationAdministration.note
              ShortAdditional notes (e.g. confirmed via SMS reply 1)
              Must Supporttrue
              30. MedicationAdministration.dosage
              Control1..?
              Must Supporttrue
              32. MedicationAdministration.dosage.text
              ShortSwallow whole. With or without food.
              34. MedicationAdministration.dosage.route
              Must Supporttrue
              Pattern Value{
                "coding" : [{
                  "system" : "http://snomed.info/sct",
                  "code" : "26643006",
                  "display" : "Oral route"
                }]
              }
              36. MedicationAdministration.dosage.dose
              Short3 SP tablets taken together
              Must Supporttrue
              38. MedicationAdministration.dosage.dose.value
              Pattern Value3
              40. MedicationAdministration.dosage.dose.unit
              Pattern Valuetablet

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

              0. MedicationAdministration
              Definition

              Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

              ShortAdministration of medication to a 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())
              2. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.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. MedicationAdministration.extension
              Definition

              An Extension

              ShortExtension
              Control2..*
              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 MedicationAdministration.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. MedicationAdministration.extension:doseNumber
                Slice NamedoseNumber
                Definition

                Sequential dose number in the IPTp schedule (1–4+)

                ShortIPTp Dose Number
                Control1..1
                This element is affected by the following invariants: ele-1
                TypeExtension(IPTp Dose Number) (Extension Type: positiveInt)
                Is Modifierfalse
                Must Supporttrue
                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())
                18. MedicationAdministration.extension:administrationMethod
                Slice NameadministrationMethod
                Definition

                Whether the dose was DOT (clinic) or self-administered (home)

                ShortIPTp Administration Method
                Control1..1
                This element is affected by the following invariants: ele-1
                TypeExtension(IPTp Administration Method) (Extension Type: CodeableConcept)
                Is Modifierfalse
                Must Supporttrue
                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. MedicationAdministration.extension:confirmationStatus
                Slice NameconfirmationStatus
                Definition

                Tracks the T-0 / 24h / 72h confirmation engine outcome for a self-administered dose (confirmed / pending / missed)

                ShortSet for self-admin doses only: confirmation-pending on T-0, confirmation-confirmed on Reply 1, confirmation-missed after 72h with no reply
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(IPTp Dose Confirmation Status) (Extension Type: CodeableConcept)
                Is Modifierfalse
                Must Supporttrue
                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. MedicationAdministration.extension:spacingValidFlag
                Slice NamespacingValidFlag
                Definition

                TRUE if the confirmed dose date respects the minimum 28-day spacing from the previous dose; computed when confirmation_status = confirmation-confirmed

                ShortComputed when confirmationStatus = confirmation-confirmed; TRUE if ≥28 days since previous dose
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(IPTp Dose Spacing Valid Flag) (Extension Type: boolean)
                Is Modifierfalse
                Must Supporttrue
                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())
                24. MedicationAdministration.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())
                26. MedicationAdministration.identifier
                Definition

                Identifiers associated with this Medication Administration 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

                This is a business identifier, not a resource identifier.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                TypeIdentifier
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                28. MedicationAdministration.instantiates
                Definition

                A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.

                ShortInstantiates protocol or definition
                Control0..*
                Typeuri
                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()))
                30. MedicationAdministration.partOf
                Definition

                A larger event of which this particular event is a component or step.

                ShortPart of referenced event
                Control0..*
                TypeReference(MedicationAdministration, Procedure)
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                32. MedicationAdministration.status
                Definition

                Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.

                Shortcompleted | not-done | in-progress
                Comments

                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 MedicationAdministration Status Codes
                (required to http://hl7.org/fhir/ValueSet/medication-admin-status)
                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
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. MedicationAdministration.statusReason
                Definition

                A code indicating why the administration was not performed.

                ShortReason administration not performed
                Control0..*
                BindingFor example codes, see SNOMEDCTReasonMedicationNotGivenCodes
                (example to http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes|4.0.1)

                A set of codes indicating the reason why the MedicationAdministration is negated.

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

                Indicates where the medication is expected to be consumed or administered.

                ShortType of medication usage
                Control0..1
                BindingThe codes SHOULD be taken from MedicationAdministration Category Codes
                (preferred to http://hl7.org/fhir/ValueSet/medication-admin-category|4.0.1)

                A coded concept describing where the medication administered is expected to occur.

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

                Identifies the medication that was 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 was administered
                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.

                Control1..1
                BindingFor example codes, see SNOMEDCTMedicationCodes
                (example to http://hl7.org/fhir/ValueSet/medication-codes|4.0.1)

                Codes identifying substance or product that can be administered.

                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
                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 MedicationAdministration.medication[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • type @ $this
                • 40. MedicationAdministration.medication[x]:medicationReference
                  Slice NamemedicationReference
                  Definition

                  Identifies the medication that was 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 was administered
                  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(IPTp SP Medication)
                  [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()))
                  42. MedicationAdministration.subject
                  Definition

                  The person or animal or group receiving the medication.

                  ShortWho received medication
                  Control1..1
                  TypeReference(IPTp Enrolled Patient)
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  44. MedicationAdministration.context
                  Definition

                  The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.

                  ShortEncounter or Episode of Care administered as part of
                  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()))
                  46. MedicationAdministration.supportingInformation
                  Definition

                  Additional information (for example, patient height and weight) that supports the administration of the medication.

                  ShortAdditional information to support administration
                  Control0..*
                  TypeReference(Resource)
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  48. MedicationAdministration.effective[x]
                  Definition

                  A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

                  ShortStart and end time of administration
                  Control1..1
                  TypeChoice of: dateTime, Period
                  [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
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  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 MedicationAdministration.effective[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • type @ $this
                  • 50. MedicationAdministration.effective[x]:effectiveDateTime
                    Slice NameeffectiveDateTime
                    Definition

                    A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

                    ShortActual or planned date of dose administration
                    Control0..1
                    TypedateTime
                    [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
                    Must Supporttrue
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    52. MedicationAdministration.performer
                    Definition

                    Indicates who or what performed the medication administration and how they were involved.

                    ShortWho performed the medication administration and what they did
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    54. MedicationAdministration.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
                    56. MedicationAdministration.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())
                    58. MedicationAdministration.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())
                    60. MedicationAdministration.performer.function
                    Definition

                    Distinguishes the type of involvement of the performer in the medication administration.

                    ShortType of performance
                    Control0..1
                    BindingFor example codes, see MedicationAdministration Performer Function Codes
                    (example to http://hl7.org/fhir/ValueSet/med-admin-perform-function|4.0.1)

                    A code describing the role an individual played in administering the medication.

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

                    Indicates who or what performed the medication administration.

                    ShortRequired only for DOT doses; omit for self-admin
                    Control1..1
                    TypeReference(IPTp ANC Provider)
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    64. MedicationAdministration.reasonCode
                    Definition

                    A code indicating why the medication was given.

                    ShortReason administration performed
                    Control0..*
                    BindingFor example codes, see ReasonMedicationGivenCodes
                    (example to http://hl7.org/fhir/ValueSet/reason-medication-given-codes|4.0.1)

                    A set of codes indicating the reason why the MedicationAdministration was made.

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

                    Condition or observation that supports why the medication was administered.

                    ShortCondition or observation that supports why the medication was administered
                    Comments

                    This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode.

                    Control0..*
                    TypeReference(Condition, Observation, DiagnosticReport)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    68. MedicationAdministration.request
                    Definition

                    The original request, instruction or authority to perform the administration.

                    ShortRequest administration performed against
                    Comments

                    This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value.

                    Control0..1
                    TypeReference(MedicationRequest)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    70. MedicationAdministration.device
                    Definition

                    The device used in administering the medication to the patient. For example, a particular infusion pump.

                    ShortDevice used to administer
                    Control0..*
                    TypeReference(Device)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    72. MedicationAdministration.note
                    Definition

                    Extra information about the medication administration that is not conveyed by the other attributes.

                    ShortAdditional notes (e.g. confirmed via SMS reply 1)
                    Control0..*
                    TypeAnnotation
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    74. MedicationAdministration.dosage
                    Definition

                    Describes the medication dosage information details e.g. dose, rate, site, route, etc.

                    ShortDetails of how medication was taken
                    Control1..1
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] (dose.exists() or rate.exists())
                    76. MedicationAdministration.dosage.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
                    78. MedicationAdministration.dosage.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())
                    80. MedicationAdministration.dosage.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())
                    82. MedicationAdministration.dosage.text
                    Definition

                    Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.

                    The dosage instructions should reflect the dosage of the medication that was administered.

                    ShortSwallow whole. With or without food.
                    Control0..1
                    Typestring
                    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()))
                    84. MedicationAdministration.dosage.site
                    Definition

                    A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".

                    ShortBody site administered 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
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. MedicationAdministration.dosage.route
                    Definition

                    A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

                    ShortPath of substance into 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
                    Must Supporttrue
                    Summaryfalse
                    Pattern Value{
                      "coding" : [{
                        "system" : "http://snomed.info/sct",
                        "code" : "26643006",
                        "display" : "Oral route"
                      }]
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. MedicationAdministration.dosage.method
                    Definition

                    A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.

                    ShortHow drug was administered
                    Comments

                    One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.

                    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
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. MedicationAdministration.dosage.dose
                    Definition

                    The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.

                    Short3 SP tablets taken together
                    Comments

                    If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.

                    Control0..1
                    TypeQuantity(SimpleQuantity)
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    92. MedicationAdministration.dosage.dose.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
                    94. MedicationAdministration.dosage.dose.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 MedicationAdministration.dosage.dose.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 96. MedicationAdministration.dosage.dose.value
                      Definition

                      The value of the measured amount. The value includes an implicit precision in the presentation of the value.

                      ShortNumerical value (with implicit precision)
                      Comments

                      The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

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

                      Precision is handled implicitly in almost all cases of measurement.

                      Pattern Value3
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. MedicationAdministration.dosage.dose.comparator
                      Definition

                      Not allowed to be used in this context

                      Short< | <= | >= | > - how to understand the value
                      Control0..0
                      BindingThe codes SHALL be taken from QuantityComparator
                      (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

                      How the Quantity should be understood and represented.

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                      Meaning if MissingIf there is no comparator, then there is no modification of the value
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      100. MedicationAdministration.dosage.dose.unit
                      Definition

                      A human-readable form of the unit.

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

                      There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

                      Pattern Valuetablet
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      102. MedicationAdministration.dosage.dose.system
                      Definition

                      The identification of the system that provides the coded form of the unit.

                      ShortSystem that defines coded unit form
                      Control0..1
                      This element is affected by the following invariants: qty-3
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to know the system that defines the coded form of the unit.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      104. MedicationAdministration.dosage.dose.code
                      Definition

                      A computer processable form of the unit in some unit representation system.

                      ShortCoded form of the unit
                      Comments

                      The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

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

                      Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      106. MedicationAdministration.dosage.rate[x]
                      Definition

                      Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.

                      ShortDose quantity per unit of time
                      Comments

                      If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.

                      Control0..1
                      TypeChoice of: Ratio, Quantity(SimpleQuantity)
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      108. MedicationAdministration.eventHistory
                      Definition

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

                      ShortA list of events of interest in the lifecycle
                      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()))