Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build International flag

Integrated Campaign Registry (ICR) 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: ICRSupplyDistribution - Detailed Descriptions

Draft as of 2026-10-29

Definitions for the ICRSupplyDistribution resource profile.

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

0. SupplyDelivery
Definition

Record of delivery of what is supplied.

ShortDelivery of bulk Supplies
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. SupplyDelivery.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. SupplyDelivery.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())
SlicingThis element introduces a set of slices on SupplyDelivery.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. SupplyDelivery.extension:campaign
    Slice Namecampaign
    Definition

    The campaign round — the ICRCampaign CarePlan — this record belongs to. The uniform record→campaign join: delivery events (Immunization, MedicationAdministration, SupplyDelivery) and coverage reports (MeasureReport) all point AT their campaign, in the same direction as Task.basedOn — the CarePlan itself is never rewritten as records accumulate. Replaces the core event-basedOn extension previously used on the delivery profiles: its R4 context is Condition-only, so every use on a delivery resource was context-invalid, and MeasureReport needs the same link (a coverage report otherwise has no computable path back to its campaign).

    ShortThe campaign (round) this distribution belongs to; per-round queries stay independent of Task wiring
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Campaign) (Extension Type: Reference(ICR Campaign))
    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. SupplyDelivery.extension:campaignActivity
    Slice NamecampaignActivity
    Definition

    The activity of an integrated campaign that this record belongs to: the ICRCampaignActivity a CarePlan.activity.detail of the campaign instantiates. On a coverage report, the report's denominator is then that activity's planning denominator and its numerator counts only that activity's doses or treatments; absent on a report for a single-intervention campaign, or for a campaign as a whole. On a delivery event (Immunization, MedicationAdministration, SupplyDelivery), the activity the dose, treatment or handover was for: per-activity results count events by this link, not by product code. An event must carry it whenever its visit Task has no instantiatesCanonical and its campaign lists more than one activity (a conformance rule stated in the IG text, since an event cannot see its Task). On a Task output, the activity a per-activity tally (treated-count) is for, on a visit that delivers several activities.

    ShortThe campaign activity this handover was for. A commodity not handed over creates no distribution: the reason is recorded on the visit Task
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Campaign Activity) (Extension Type: canonical(ICR Campaign Activity))
    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. SupplyDelivery.extension:recordOrigin
    Slice NamerecordOrigin
    Definition

    Whether this delivery event was recorded during a campaign or a routine facility visit. REQUIRED on all ICR delivery-event profiles — without it, SIA doses contaminate routine coverage analytics (working doc §4.4). Also valid on AdverseEvent so a campaign-context AEFI/side-effect stays separable from routine pharmacovigilance (v0.19.0).

    ShortRecord Origin
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Record Origin) (Extension Type: code)
    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. SupplyDelivery.extension:recipient
    Slice Namerecipient
    Definition

    Who received a distributed commodity — the delivery-unit Group (household, community, school cohort) or a registered person. R4 SupplyDelivery.patient targets only Patient, but ICR's usual recipient is the household; this extension supplies the Group join that per-capita coverage (e.g. 1 net per 2 household members: quantity ÷ Group.quantity) computes against (supply-split round).

    ShortWho received it — the delivery-unit Group (household, community, school cohort) or a registered person. The direct join per-capita coverage computes against
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Distribution Recipient) (Extension Type: Reference(ICR Delivery Unit (Household / Community / School Cohort), ICR Patient (Beneficiary / Registered Individual)))
    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. SupplyDelivery.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. SupplyDelivery.identifier
    Definition

    Identifier for the supply delivery event that is used to identify it across multiple disparate systems.

    ShortExternal identifier
    Comments

    This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    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 SupplyDelivery.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • pattern @ type
    • 18. SupplyDelivery.identifier:voucher
      Slice Namevoucher
      Definition

      Identifier for the supply delivery event that is used to identify it across multiple disparate systems.

      ShortThe registration voucher this handover redeems: the same system and value as the register Task's voucher output, so issued vs redeemed is a match on (system, value). A partial redemption gives two distributions with the same voucherExternal identifier
      Comments

      This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.

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

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. SupplyDelivery.identifier:voucher.type
      Definition

      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

      ShortDescription of identifier
      Comments

      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

      Control10..1
      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
      (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

      A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows users to make use of identifiers when the identifier system is not known.

      Pattern Value{
        "coding" : [{
          "system" : "https://icr.healthcampaigns.org/CodeSystem/icr-identifier-type-cs",
          "code" : "voucher"
        }]
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. SupplyDelivery.identifier:voucher.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. SupplyDelivery.identifier:voucher.value
      Definition

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      ShortThe value that is unique
      Comments

      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      ExampleGeneral: 123456
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. SupplyDelivery.status
      Definition

      A code specifying the state of the dispense event.

      Shortin-progress | completed | abandoned | entered-in-error
      Comments

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

      Control0..1
      BindingThe codes SHALL be taken from SupplyDeliveryStatushttp://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1
      (required to http://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1)

      Status of the supply delivery.

      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()))
      30. SupplyDelivery.patient
      Definition

      A link to a resource representing the person whom the delivered item is for.

      ShortThe registered person receiving it, where person-level registration exists. The usual ICR recipient is a household/community Group — that join rides extension[recipient] (R4 SupplyDelivery.patient cannot target a Group)Patient for whom the item is supplied
      Control0..1
      TypeReference(Patient)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. SupplyDelivery.suppliedItem
      Definition

      The item that is being delivered or has been supplied.

      ShortThe item that is delivered or supplied
      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()))
      34. SupplyDelivery.suppliedItem.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())
      36. SupplyDelivery.suppliedItem.quantity
      Definition

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

      ShortAmount dispensed
      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()))
      38. SupplyDelivery.suppliedItem.item[x]
      Definition

      Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

      ShortDrug commodity → WHO ATC; physical commodity → ICR commodity-class code (llin, rdt, …), optionally alongside a GS1 GTIN coding for the specific product; text as fallbackMedication, Substance, or Device supplied
      Control0..1
      BindingFor example codes, see SNOMEDCTSupplyItemhttp://hl7.org/fhir/ValueSet/supply-item|4.0.1
      (example to http://hl7.org/fhir/ValueSet/supply-item|4.0.1)

      The item that was delivered.

      TypeChoice of: CodeableConcept, Reference(Medication, Substance, Device)
      [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()))
      SlicingThis element introduces a set of slices on SupplyDelivery.suppliedItem.item[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • type @ $this
      • 40. SupplyDelivery.suppliedItem.item[x]:itemCodeableConcept
        Slice NameitemCodeableConcept
        Definition

        Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

        ShortMedication, Substance, or Device supplied
        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from For example codes, see ICR Supplied Itemhttp://hl7.org/fhir/ValueSet/supply-item|4.0.1
        (extensible to https://icr.healthcampaigns.org/ValueSet/icr-supplied-item)
        TypeCodeableConcept, Reference(Medication, Substance, Device)
        [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()))
        42. SupplyDelivery.destination
        Definition

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

        ShortThe place of the handover (dwelling, distribution post, school)Where the Supply was sent
        Control0..1
        TypeReference(Location)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        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. SupplyDelivery
        2. SupplyDelivery.extension
        Control1..?
        SlicingThis element introduces a set of slices on SupplyDelivery.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 4. SupplyDelivery.extension:campaign
          Slice Namecampaign
          ShortThe campaign (round) this distribution belongs to; per-round queries stay independent of Task wiring
          Control0..1
          TypeExtension(Campaign) (Extension Type: Reference(ICR Campaign))
          Must Supporttrue
          6. SupplyDelivery.extension:campaignActivity
          Slice NamecampaignActivity
          ShortThe campaign activity this handover was for. A commodity not handed over creates no distribution: the reason is recorded on the visit Task
          Control0..1
          TypeExtension(Campaign Activity) (Extension Type: canonical(ICR Campaign Activity))
          Must Supporttrue
          8. SupplyDelivery.extension:recordOrigin
          Slice NamerecordOrigin
          Control1..1
          TypeExtension(Record Origin) (Extension Type: code)
          Must Supporttrue
          10. SupplyDelivery.extension:recipient
          Slice Namerecipient
          ShortWho received it — the delivery-unit Group (household, community, school cohort) or a registered person. The direct join per-capita coverage computes against
          Control0..1
          TypeExtension(Distribution Recipient) (Extension Type: Reference(ICR Delivery Unit (Household / Community / School Cohort), ICR Patient (Beneficiary / Registered Individual)))
          Must Supporttrue
          12. SupplyDelivery.identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Must Supporttrue
          SlicingThis element introduces a set of slices on SupplyDelivery.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • pattern @ type
          • 14. SupplyDelivery.identifier:voucher
            Slice Namevoucher
            ShortThe registration voucher this handover redeems: the same system and value as the register Task's voucher output, so issued vs redeemed is a match on (system, value). A partial redemption gives two distributions with the same voucher
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            Must Supporttrue
            16. SupplyDelivery.identifier:voucher.type
            Control1..?
            Pattern Value{
              "coding" : [{
                "system" : "https://icr.healthcampaigns.org/CodeSystem/icr-identifier-type-cs",
                "code" : "voucher"
              }]
            }
            18. SupplyDelivery.identifier:voucher.system
            Control1..?
            Must Supporttrue
            20. SupplyDelivery.identifier:voucher.value
            Control1..?
            Must Supporttrue
            22. SupplyDelivery.status
            Must Supporttrue
            24. SupplyDelivery.patient
            ShortThe registered person receiving it, where person-level registration exists. The usual ICR recipient is a household/community Group — that join rides extension[recipient] (R4 SupplyDelivery.patient cannot target a Group)
            Must Supporttrue
            26. SupplyDelivery.suppliedItem
            Must Supporttrue
            28. SupplyDelivery.suppliedItem.quantity
            Must Supporttrue
            30. SupplyDelivery.suppliedItem.item[x]
            ShortDrug commodity → WHO ATC; physical commodity → ICR commodity-class code (llin, rdt, …), optionally alongside a GS1 GTIN coding for the specific product; text as fallback
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Must Supporttrue
            SlicingThis element introduces a set of slices on SupplyDelivery.suppliedItem.item[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • type @ $this
            • 32. SupplyDelivery.suppliedItem.item[x]:itemCodeableConcept
              Slice NameitemCodeableConcept
              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from ICR Supplied Item
              (extensible to https://icr.healthcampaigns.org/ValueSet/icr-supplied-item)
              TypeCodeableConcept
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              34. SupplyDelivery.destination
              ShortThe place of the handover (dwelling, distribution post, school)
              Must Supporttrue

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

              0. SupplyDelivery
              Definition

              Record of delivery of what is supplied.

              ShortDelivery of bulk Supplies
              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. SupplyDelivery.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. SupplyDelivery.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. SupplyDelivery.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. SupplyDelivery.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. SupplyDelivery.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. SupplyDelivery.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. SupplyDelivery.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 SupplyDelivery.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. SupplyDelivery.extension:campaign
                Slice Namecampaign
                Definition

                The campaign round — the ICRCampaign CarePlan — this record belongs to. The uniform record→campaign join: delivery events (Immunization, MedicationAdministration, SupplyDelivery) and coverage reports (MeasureReport) all point AT their campaign, in the same direction as Task.basedOn — the CarePlan itself is never rewritten as records accumulate. Replaces the core event-basedOn extension previously used on the delivery profiles: its R4 context is Condition-only, so every use on a delivery resource was context-invalid, and MeasureReport needs the same link (a coverage report otherwise has no computable path back to its campaign).

                ShortThe campaign (round) this distribution belongs to; per-round queries stay independent of Task wiring
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Campaign) (Extension Type: Reference(ICR Campaign))
                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. SupplyDelivery.extension:campaignActivity
                Slice NamecampaignActivity
                Definition

                The activity of an integrated campaign that this record belongs to: the ICRCampaignActivity a CarePlan.activity.detail of the campaign instantiates. On a coverage report, the report's denominator is then that activity's planning denominator and its numerator counts only that activity's doses or treatments; absent on a report for a single-intervention campaign, or for a campaign as a whole. On a delivery event (Immunization, MedicationAdministration, SupplyDelivery), the activity the dose, treatment or handover was for: per-activity results count events by this link, not by product code. An event must carry it whenever its visit Task has no instantiatesCanonical and its campaign lists more than one activity (a conformance rule stated in the IG text, since an event cannot see its Task). On a Task output, the activity a per-activity tally (treated-count) is for, on a visit that delivers several activities.

                ShortThe campaign activity this handover was for. A commodity not handed over creates no distribution: the reason is recorded on the visit Task
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Campaign Activity) (Extension Type: canonical(ICR Campaign Activity))
                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. SupplyDelivery.extension:recordOrigin
                Slice NamerecordOrigin
                Definition

                Whether this delivery event was recorded during a campaign or a routine facility visit. REQUIRED on all ICR delivery-event profiles — without it, SIA doses contaminate routine coverage analytics (working doc §4.4). Also valid on AdverseEvent so a campaign-context AEFI/side-effect stays separable from routine pharmacovigilance (v0.19.0).

                ShortRecord Origin
                Control1..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Record Origin) (Extension Type: code)
                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. SupplyDelivery.extension:recipient
                Slice Namerecipient
                Definition

                Who received a distributed commodity — the delivery-unit Group (household, community, school cohort) or a registered person. R4 SupplyDelivery.patient targets only Patient, but ICR's usual recipient is the household; this extension supplies the Group join that per-capita coverage (e.g. 1 net per 2 household members: quantity ÷ Group.quantity) computes against (supply-split round).

                ShortWho received it — the delivery-unit Group (household, community, school cohort) or a registered person. The direct join per-capita coverage computes against
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Distribution Recipient) (Extension Type: Reference(ICR Delivery Unit (Household / Community / School Cohort), ICR Patient (Beneficiary / Registered Individual)))
                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. SupplyDelivery.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. SupplyDelivery.identifier
                Definition

                Identifier for the supply delivery event that is used to identify it across multiple disparate systems.

                ShortExternal identifier
                Comments

                This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                TypeIdentifier
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                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 SupplyDelivery.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • pattern @ type
                • 28. SupplyDelivery.identifier:voucher
                  Slice Namevoucher
                  Definition

                  Identifier for the supply delivery event that is used to identify it across multiple disparate systems.

                  ShortThe registration voucher this handover redeems: the same system and value as the register Task's voucher output, so issued vs redeemed is a match on (system, value). A partial redemption gives two distributions with the same voucher
                  Comments

                  This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.

                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..1
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  30. SupplyDelivery.identifier:voucher.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
                  32. SupplyDelivery.identifier:voucher.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 SupplyDelivery.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 34. SupplyDelivery.identifier:voucher.use
                    Definition

                    The purpose of this identifier.

                    Shortusual | official | temp | secondary | old (If known)
                    Comments

                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUse
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                    Identifies the purpose for this identifier, if known .

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    36. SupplyDelivery.identifier:voucher.type
                    Definition

                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                    ShortDescription of identifier
                    Comments

                    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                    Control1..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows users to make use of identifiers when the identifier system is not known.

                    Pattern Value{
                      "coding" : [{
                        "system" : "https://icr.healthcampaigns.org/CodeSystem/icr-identifier-type-cs",
                        "code" : "voucher"
                      }]
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    38. SupplyDelivery.identifier:voucher.system
                    Definition

                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                    ExampleGeneral: http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    40. SupplyDelivery.identifier:voucher.value
                    Definition

                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                    ShortThe value that is unique
                    Comments

                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control1..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    ExampleGeneral: 123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    42. SupplyDelivery.identifier:voucher.period
                    Definition

                    Time period during which identifier is/was valid for use.

                    ShortTime period when id is/was valid for use
                    Control0..1
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    44. SupplyDelivery.identifier:voucher.assigner
                    Definition

                    Organization that issued/manages the identifier.

                    ShortOrganization that issued id (may be just text)
                    Comments

                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                    Control0..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    46. SupplyDelivery.basedOn
                    Definition

                    A plan, proposal or order that is fulfilled in whole or in part by this event.

                    ShortFulfills plan, proposal or order
                    Control0..*
                    TypeReference(SupplyRequest)
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    48. SupplyDelivery.partOf
                    Definition

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

                    ShortPart of referenced event
                    Comments

                    Not to be used to link an event to an Encounter - use Event.context for that.

                    [The allowed reference resources may be adjusted as appropriate for the event resource].

                    Control0..*
                    TypeReference(SupplyDelivery, Contract)
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    50. SupplyDelivery.status
                    Definition

                    A code specifying the state of the dispense event.

                    Shortin-progress | completed | abandoned | entered-in-error
                    Comments

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

                    Control0..1
                    BindingThe codes SHALL be taken from SupplyDeliveryStatus
                    (required to http://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1)

                    Status of the supply delivery.

                    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()))
                    52. SupplyDelivery.patient
                    Definition

                    A link to a resource representing the person whom the delivered item is for.

                    ShortThe registered person receiving it, where person-level registration exists. The usual ICR recipient is a household/community Group — that join rides extension[recipient] (R4 SupplyDelivery.patient cannot target a Group)
                    Control0..1
                    TypeReference(Patient)
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    54. SupplyDelivery.type
                    Definition

                    Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

                    ShortCategory of dispense event
                    Control0..1
                    BindingThe codes SHALL be taken from SupplyItemType
                    (required to http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.1)

                    The type of supply dispense.

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

                    The item that is being delivered or has been supplied.

                    ShortThe item that is delivered or supplied
                    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()))
                    58. SupplyDelivery.suppliedItem.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
                    60. SupplyDelivery.suppliedItem.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())
                    62. SupplyDelivery.suppliedItem.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())
                    64. SupplyDelivery.suppliedItem.quantity
                    Definition

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

                    ShortAmount dispensed
                    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()))
                    66. SupplyDelivery.suppliedItem.item[x]
                    Definition

                    Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

                    ShortDrug commodity → WHO ATC; physical commodity → ICR commodity-class code (llin, rdt, …), optionally alongside a GS1 GTIN coding for the specific product; text as fallback
                    Control0..1
                    BindingFor example codes, see SNOMEDCTSupplyItem
                    (example to http://hl7.org/fhir/ValueSet/supply-item|4.0.1)

                    The item that was delivered.

                    TypeChoice of: CodeableConcept, Reference(Medication, Substance, Device)
                    [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()))
                    SlicingThis element introduces a set of slices on SupplyDelivery.suppliedItem.item[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • type @ $this
                    • 68. SupplyDelivery.suppliedItem.item[x]:itemCodeableConcept
                      Slice NameitemCodeableConcept
                      Definition

                      Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

                      ShortMedication, Substance, or Device supplied
                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from ICR Supplied Item
                      (extensible to https://icr.healthcampaigns.org/ValueSet/icr-supplied-item)
                      TypeCodeableConcept
                      [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()))
                      70. SupplyDelivery.occurrence[x]
                      Definition

                      The date or time(s) the activity occurred.

                      ShortWhen event occurred
                      Comments

                      [The list of types may be constrained as appropriate for the type of event].

                      Control0..1
                      TypeChoice of: dateTime, Period, Timing
                      [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()))
                      72. SupplyDelivery.supplier
                      Definition

                      The individual responsible for dispensing the medication, supplier or device.

                      ShortDispenser
                      Control0..1
                      TypeReference(Practitioner, PractitionerRole, Organization)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      74. SupplyDelivery.destination
                      Definition

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

                      ShortThe place of the handover (dwelling, distribution post, school)
                      Control0..1
                      TypeReference(Location)
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      76. SupplyDelivery.receiver
                      Definition

                      Identifies the person who picked up the Supply.

                      ShortWho collected the Supply
                      Control0..*
                      TypeReference(Practitioner, PractitionerRole)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))