WHO Immunization Implementation Guide
0.2.0 - ci-build

WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations/ and changes regularly. See the Directory of published versions

Resource Profile: IMMZImmunization - Detailed Descriptions

Draft as of 2025-01-16

Definitions for the IMMZ.Immunization resource profile.

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

0. Immunization
Definition

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

ShortImmunization event information
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. Immunization.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. Immunization.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 Immunization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Immunization.extension:typeOfPolio
    Slice NametypeOfPolio
    Definition

    The type of dose in a series that the client received

    ShortImmunization Type of Dose
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Immunization.extension:typeOfPolio.extension
    Definition

    An Extension


    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.

    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.

    Control0..0*
    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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 10. Immunization.extension:typeOfPolio.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
      12. Immunization.extension:typeOfPolio.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control0..1
      BindingThe codes SHALL be taken from For codes, see IMMZ.D.DE212 ValueSet for Type of poliovirus dose
      (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212)
      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [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()))
      14. Immunization.extension:typeOfJe
      Slice NametypeOfJe
      Definition

      The type of dose in a series that the client received

      ShortImmunization Type of Dose
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      16. Immunization.extension:typeOfJe.extension
      Definition

      An Extension


      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.

      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.

      Control0..0*
      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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 18. Immunization.extension:typeOfJe.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
        20. Immunization.extension:typeOfJe.value[x]
        Definition

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortValue of extension
        Control0..1
        BindingThe codes SHALL be taken from For codes, see IMMZ.D.DE216 ValueSet for Type of JE dose
        (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216)
        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
        [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()))
        22. Immunization.extension:typeOfTbe
        Slice NametypeOfTbe
        Definition

        The type of dose in a series that the client received

        ShortImmunization Type of Dose
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
        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())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. Immunization.extension:typeOfTbe.extension
        Definition

        An Extension


        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.

        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.

        Control0..0*
        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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 26. Immunization.extension:typeOfTbe.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
          28. Immunization.extension:typeOfTbe.value[x]
          Definition

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          ShortValue of extension
          Control0..1
          BindingThe codes SHALL be taken from For codes, see IMMZ.D.DE220 ValueSet for Type of TBE dose
          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220)
          TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
          [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()))
          30. Immunization.extension:typeOfTyphoid
          Slice NametypeOfTyphoid
          Definition

          The type of dose in a series that the client received

          ShortImmunization Type of Dose
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          32. Immunization.extension:typeOfTyphoid.extension
          Definition

          An Extension


          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.

          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.

          Control0..0*
          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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 34. Immunization.extension:typeOfTyphoid.url
            Definition

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies the meaning of the extension
            Comments

            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
            36. Immunization.extension:typeOfTyphoid.value[x]
            Definition

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            ShortValue of extension
            Control0..1
            BindingThe codes SHALL be taken from For codes, see IMMZ.D.DE225 ValueSet for Type of typhoid dose
            (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225)
            TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
            [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()))
            38. Immunization.extension:typeOfCholera
            Slice NametypeOfCholera
            Definition

            The type of dose in a series that the client received

            ShortImmunization Type of Dose
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
            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())
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            40. Immunization.extension:typeOfCholera.extension
            Definition

            An Extension


            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.

            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.

            Control0..0*
            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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 42. Immunization.extension:typeOfCholera.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
              44. Immunization.extension:typeOfCholera.value[x]
              Definition

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              ShortValue of extension
              Control0..1
              BindingThe codes SHALL be taken from For codes, see IMMZ.D.DE229 ValueSet for Type of cholera dose
              (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229)
              TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
              [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()))
              46. Immunization.extension:typeOfMeningococcal
              Slice NametypeOfMeningococcal
              Definition

              The type of dose in a series that the client received

              ShortImmunization Type of Dose
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
              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())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              48. Immunization.extension:typeOfMeningococcal.extension
              Definition

              An Extension


              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.

              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.

              Control0..0*
              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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 50. Immunization.extension:typeOfMeningococcal.url
                Definition

                Source of the definition for the extension code - a logical name or a URL.

                Shortidentifies the meaning of the extension
                Comments

                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                52. Immunization.extension:typeOfMeningococcal.value[x]
                Definition

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                ShortValue of extension
                Control0..1
                BindingThe codes SHALL be taken from For codes, see IMMZ.D.DE229 ValueSet for Type of cholera dose
                (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229)
                TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                [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()))
                54. Immunization.extension:typeOfHepatitisA
                Slice NametypeOfHepatitisA
                Definition

                The type of dose in a series that the client received

                ShortImmunization Type of Dose
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                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())
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                56. Immunization.extension:typeOfHepatitisA.extension
                Definition

                An Extension


                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.

                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.

                Control0..0*
                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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 58. Immunization.extension:typeOfHepatitisA.url
                  Definition

                  Source of the definition for the extension code - a logical name or a URL.

                  Shortidentifies the meaning of the extension
                  Comments

                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                  60. Immunization.extension:typeOfHepatitisA.value[x]
                  Definition

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                  ShortValue of extension
                  Control0..1
                  BindingThe codes SHALL be taken from For codes, see IMMZ.D.DE237 ValueSet for Type of hepatitis A dose
                  (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237)
                  TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                  [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()))
                  62. Immunization.extension:typeOfHepatitisB
                  Slice NametypeOfHepatitisB
                  Definition

                  The type of dose in a series that the client received

                  ShortImmunization Type of Dose
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                  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())
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  64. Immunization.extension:typeOfHepatitisB.extension
                  Definition

                  An Extension


                  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.

                  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.

                  Control0..0*
                  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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 66. Immunization.extension:typeOfHepatitisB.url
                    Definition

                    Source of the definition for the extension code - a logical name or a URL.

                    Shortidentifies the meaning of the extension
                    Comments

                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                    68. Immunization.extension:typeOfHepatitisB.value[x]
                    Definition

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                    ShortValue of extension
                    Control0..1
                    BindingThe codes SHALL be taken from For codes, see IMMZ.D.DE254 ValueSet for Type of hepatitis B dose
                    (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254)
                    TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                    [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. Immunization.extension:vaccineBrand
                    Slice NamevaccineBrand
                    Definition

                    The brand or trade name used to refer to the vaccine received

                    ShortImmunization Vaccine Brand
                    Control1..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(Immunization Vaccine Brand) (Extension Type: CodeableConcept)
                    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())
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    72. Immunization.extension:liveVaccine
                    Slice NameliveVaccine
                    Definition

                    Uses a living but weakened version of the virus or one that is very similar

                    ShortImmunization Live Vaccine
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(Immunization Live Vaccine) (Extension Type: boolean)
                    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())
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    74. Immunization.extension:marketAuthorizationHolder
                    Slice NamemarketAuthorizationHolder
                    Definition

                    Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED

                    ShortImmunization Market Authorization Holder
                    Control1..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(Immunization Market Authorization Holder) (Extension Type: CodeableConcept)
                    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())
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    76. Immunization.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())
                    78. Immunization.status
                    Definition

                    Indicates the current status of the immunization event.

                    Shortcompleted | entered-in-error | not-done
                    Comments

                    Will generally be set to show that the immunization has been completed or not done. 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 ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1
                    (required to http://hl7.org/fhir/ValueSet/immunization-status|4.0.1)

                    A set of codes indicating the current status of an Immunization.

                    Typecode
                    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done 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
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    80. Immunization.statusReason
                    Definition

                    Indicates the reason the immunization event was not performed.

                    ShortReason not done
                    Comments

                    This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

                    Control0..1
                    BindingThe codes SHALL be taken from For example codes, see IMMZ.D.DE5 ValueSet for Reason vaccine was not administeredhttp://hl7.org/fhir/ValueSet/immunization-status-reason
                    (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. Immunization.vaccineCode
                    Definition

                    Vaccine that was administered or was to be administered.

                    ShortVaccine product administered
                    Control1..1
                    BindingThe codes SHALL be taken from For example codes, see IMMZ.Z.VS ValueSet for vaccine typeshttp://hl7.org/fhir/ValueSet/vaccine-code
                    (required to http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. Immunization.patient
                    Definition

                    The patient who either received or did not receive the immunization.

                    ShortWho was immunized
                    Control1..1
                    TypeReference(Patient)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. Immunization.occurrence[x]
                    Definition

                    Date vaccine administered or was to be administered.

                    ShortVaccine administration date
                    Comments

                    When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

                    Control1..1
                    TypedateTime, string
                    [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()))
                    88. Immunization.isSubpotent
                    Definition

                    Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

                    ShortDose potency
                    Comments

                    Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.

                    Control0..1
                    Typeboolean
                    Is Modifiertrue because This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Meaning if MissingBy default, a dose should be considered to be potent.
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. Immunization.protocolApplied
                    Definition

                    The protocol (set of recommendations) being followed by the provider who administered the dose.

                    ShortProtocol followed by the provider
                    Control10..*
                    TypeBackboneElement
                    Is Modifierfalse
                    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 Immunization.protocolApplied. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • exists @ series
                    • exists @ doseNumber
                    • 92. Immunization.protocolApplied.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())
                      94. Immunization.protocolApplied.doseNumber[x]
                      Definition

                      Nominal position in a series.

                      ShortDose number within series
                      Comments

                      The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

                      Control1..1
                      TypeChoice of: positiveInt, string
                      [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
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      96. Immunization.protocolApplied:immzProtocol
                      Slice NameimmzProtocol
                      Definition

                      The protocol (set of recommendations) being followed by the provider who administered the dose.

                      ShortProtocol followed by the provider
                      Control10..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. Immunization.protocolApplied:immzProtocol.extension
                      Definition

                      An Extension


                      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.

                      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.

                      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 Immunization.protocolApplied.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 100. Immunization.protocolApplied:immzProtocol.extension:dueDateOfNextDose
                        Slice NamedueDateOfNextDose
                        Definition

                        The service delivery location (location name, city, municipality, town or village) where the vaccine administration occurred

                        ShortImmunization Due Date of Next Dose
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Immunization Due Date of Next Dose) (Extension Type: date)
                        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())
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        102. Immunization.protocolApplied:immzProtocol.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())
                        104. Immunization.protocolApplied:immzProtocol.series
                        Definition

                        One possible path to achieve presumed immunity against a disease - within the context of an authority.

                        ShortName of vaccine series
                        Control10..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()))
                        106. Immunization.protocolApplied:immzProtocol.doseNumber[x]
                        Definition

                        Nominal position in a series.

                        ShortDose number within series
                        Comments

                        The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

                        Control1..1
                        Typestring, positiveInt
                        [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
                        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. Immunization
                        2. Immunization.extension
                        Control2..?
                        SlicingThis element introduces a set of slices on Immunization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 4. Immunization.extension:typeOfPolio
                          Slice NametypeOfPolio
                          Control0..1
                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                          6. Immunization.extension:typeOfPolio.value[x]
                          BindingThe codes SHALL be taken from IMMZ.D.DE212 ValueSet for Type of poliovirus dose
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          8. Immunization.extension:typeOfJe
                          Slice NametypeOfJe
                          Control0..1
                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                          10. Immunization.extension:typeOfJe.value[x]
                          BindingThe codes SHALL be taken from IMMZ.D.DE216 ValueSet for Type of JE dose
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          12. Immunization.extension:typeOfTbe
                          Slice NametypeOfTbe
                          Control0..1
                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                          14. Immunization.extension:typeOfTbe.value[x]
                          BindingThe codes SHALL be taken from IMMZ.D.DE220 ValueSet for Type of TBE dose
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          16. Immunization.extension:typeOfTyphoid
                          Slice NametypeOfTyphoid
                          Control0..1
                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                          18. Immunization.extension:typeOfTyphoid.value[x]
                          BindingThe codes SHALL be taken from IMMZ.D.DE225 ValueSet for Type of typhoid dose
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          20. Immunization.extension:typeOfCholera
                          Slice NametypeOfCholera
                          Control0..1
                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                          22. Immunization.extension:typeOfCholera.value[x]
                          BindingThe codes SHALL be taken from IMMZ.D.DE229 ValueSet for Type of cholera dose
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          24. Immunization.extension:typeOfMeningococcal
                          Slice NametypeOfMeningococcal
                          Control0..1
                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                          26. Immunization.extension:typeOfMeningococcal.value[x]
                          BindingThe codes SHALL be taken from IMMZ.D.DE229 ValueSet for Type of cholera dose
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          28. Immunization.extension:typeOfHepatitisA
                          Slice NametypeOfHepatitisA
                          Control0..1
                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                          30. Immunization.extension:typeOfHepatitisA.value[x]
                          BindingThe codes SHALL be taken from IMMZ.D.DE237 ValueSet for Type of hepatitis A dose
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          32. Immunization.extension:typeOfHepatitisB
                          Slice NametypeOfHepatitisB
                          Control0..1
                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                          34. Immunization.extension:typeOfHepatitisB.value[x]
                          BindingThe codes SHALL be taken from IMMZ.D.DE254 ValueSet for Type of hepatitis B dose
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          36. Immunization.extension:vaccineBrand
                          Slice NamevaccineBrand
                          Control1..1
                          TypeExtension(Immunization Vaccine Brand) (Extension Type: CodeableConcept)
                          38. Immunization.extension:liveVaccine
                          Slice NameliveVaccine
                          Control0..1
                          TypeExtension(Immunization Live Vaccine) (Extension Type: boolean)
                          40. Immunization.extension:marketAuthorizationHolder
                          Slice NamemarketAuthorizationHolder
                          Control1..1
                          TypeExtension(Immunization Market Authorization Holder) (Extension Type: CodeableConcept)
                          42. Immunization.statusReason
                          BindingThe codes SHALL be taken from IMMZ.D.DE5 ValueSet for Reason vaccine was not administered
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5)
                          44. Immunization.vaccineCode
                          BindingThe codes SHALL be taken from IMMZ.Z.VS ValueSet for vaccine types
                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS)
                          46. Immunization.occurrence[x]
                          TypedateTime, string
                          [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
                          48. Immunization.location
                          50. Immunization.location.extension
                          Control1..?
                          52. Immunization.location.extension:countryOfVaccination
                          Slice NamecountryOfVaccination
                          Control1..1
                          TypeExtension(Immunization Country of Vaccination) (Extension Type: CodeableConcept)
                          54. Immunization.location.extension:administrativeArea
                          Slice NameadministrativeArea
                          Control0..1
                          TypeExtension(Immunization Administrative Area) (Extension Type: CodeableConcept)
                          56. Immunization.protocolApplied
                          Control1..?
                          SlicingThis element introduces a set of slices on Immunization.protocolApplied. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • exists @ series
                          • exists @ doseNumber
                          • 58. Immunization.protocolApplied:immzProtocol
                            Slice NameimmzProtocol
                            Control1..*
                            60. Immunization.protocolApplied:immzProtocol.extension
                            SlicingThis element introduces a set of slices on Immunization.protocolApplied.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 62. Immunization.protocolApplied:immzProtocol.extension:dueDateOfNextDose
                              Slice NamedueDateOfNextDose
                              Control0..1
                              TypeExtension(Immunization Due Date of Next Dose) (Extension Type: date)
                              64. Immunization.protocolApplied:immzProtocol.series
                              Control1..?
                              66. Immunization.protocolApplied:immzProtocol.doseNumber[x]
                              Typestring
                              [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

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

                              0. Immunization
                              Definition

                              Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

                              ShortImmunization event information
                              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. Immunization.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. Immunization.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. Immunization.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. Immunization.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)

                              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. Immunization.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. Immunization.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. Immunization.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 Immunization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 16. Immunization.extension:typeOfPolio
                                Slice NametypeOfPolio
                                Definition

                                The type of dose in a series that the client received

                                ShortImmunization Type of Dose
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                                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())
                                18. Immunization.extension:typeOfPolio.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
                                20. Immunization.extension:typeOfPolio.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..0
                                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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 22. Immunization.extension:typeOfPolio.url
                                  Definition

                                  Source of the definition for the extension code - a logical name or a URL.

                                  Shortidentifies the meaning of the extension
                                  Comments

                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                  Control1..1
                                  Typeuri
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                                  24. Immunization.extension:typeOfPolio.value[x]
                                  Definition

                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                  ShortValue of extension
                                  Control0..1
                                  BindingThe codes SHALL be taken from IMMZ.D.DE212 ValueSet for Type of poliovirus dose
                                  (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212)
                                  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()))
                                  26. Immunization.extension:typeOfJe
                                  Slice NametypeOfJe
                                  Definition

                                  The type of dose in a series that the client received

                                  ShortImmunization Type of Dose
                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                                  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())
                                  28. Immunization.extension:typeOfJe.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
                                  30. Immunization.extension:typeOfJe.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..0
                                  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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 32. Immunization.extension:typeOfJe.url
                                    Definition

                                    Source of the definition for the extension code - a logical name or a URL.

                                    Shortidentifies the meaning of the extension
                                    Comments

                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                                    34. Immunization.extension:typeOfJe.value[x]
                                    Definition

                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                    ShortValue of extension
                                    Control0..1
                                    BindingThe codes SHALL be taken from IMMZ.D.DE216 ValueSet for Type of JE dose
                                    (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216)
                                    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()))
                                    36. Immunization.extension:typeOfTbe
                                    Slice NametypeOfTbe
                                    Definition

                                    The type of dose in a series that the client received

                                    ShortImmunization Type of Dose
                                    Control0..1
                                    This element is affected by the following invariants: ele-1
                                    TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                                    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())
                                    38. Immunization.extension:typeOfTbe.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
                                    40. Immunization.extension:typeOfTbe.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..0
                                    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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 42. Immunization.extension:typeOfTbe.url
                                      Definition

                                      Source of the definition for the extension code - a logical name or a URL.

                                      Shortidentifies the meaning of the extension
                                      Comments

                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                      Control1..1
                                      Typeuri
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                                      44. Immunization.extension:typeOfTbe.value[x]
                                      Definition

                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                      ShortValue of extension
                                      Control0..1
                                      BindingThe codes SHALL be taken from IMMZ.D.DE220 ValueSet for Type of TBE dose
                                      (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220)
                                      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()))
                                      46. Immunization.extension:typeOfTyphoid
                                      Slice NametypeOfTyphoid
                                      Definition

                                      The type of dose in a series that the client received

                                      ShortImmunization Type of Dose
                                      Control0..1
                                      This element is affected by the following invariants: ele-1
                                      TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                                      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())
                                      48. Immunization.extension:typeOfTyphoid.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
                                      50. Immunization.extension:typeOfTyphoid.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..0
                                      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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 52. Immunization.extension:typeOfTyphoid.url
                                        Definition

                                        Source of the definition for the extension code - a logical name or a URL.

                                        Shortidentifies the meaning of the extension
                                        Comments

                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                        Control1..1
                                        Typeuri
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                                        54. Immunization.extension:typeOfTyphoid.value[x]
                                        Definition

                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                        ShortValue of extension
                                        Control0..1
                                        BindingThe codes SHALL be taken from IMMZ.D.DE225 ValueSet for Type of typhoid dose
                                        (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225)
                                        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()))
                                        56. Immunization.extension:typeOfCholera
                                        Slice NametypeOfCholera
                                        Definition

                                        The type of dose in a series that the client received

                                        ShortImmunization Type of Dose
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                                        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())
                                        58. Immunization.extension:typeOfCholera.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. Immunization.extension:typeOfCholera.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..0
                                        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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 62. Immunization.extension:typeOfCholera.url
                                          Definition

                                          Source of the definition for the extension code - a logical name or a URL.

                                          Shortidentifies the meaning of the extension
                                          Comments

                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                          Control1..1
                                          Typeuri
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                                          64. Immunization.extension:typeOfCholera.value[x]
                                          Definition

                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                          ShortValue of extension
                                          Control0..1
                                          BindingThe codes SHALL be taken from IMMZ.D.DE229 ValueSet for Type of cholera dose
                                          (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229)
                                          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()))
                                          66. Immunization.extension:typeOfMeningococcal
                                          Slice NametypeOfMeningococcal
                                          Definition

                                          The type of dose in a series that the client received

                                          ShortImmunization Type of Dose
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                                          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())
                                          68. Immunization.extension:typeOfMeningococcal.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
                                          70. Immunization.extension:typeOfMeningococcal.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..0
                                          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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 72. Immunization.extension:typeOfMeningococcal.url
                                            Definition

                                            Source of the definition for the extension code - a logical name or a URL.

                                            Shortidentifies the meaning of the extension
                                            Comments

                                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                                            74. Immunization.extension:typeOfMeningococcal.value[x]
                                            Definition

                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                            ShortValue of extension
                                            Control0..1
                                            BindingThe codes SHALL be taken from IMMZ.D.DE229 ValueSet for Type of cholera dose
                                            (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229)
                                            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()))
                                            76. Immunization.extension:typeOfHepatitisA
                                            Slice NametypeOfHepatitisA
                                            Definition

                                            The type of dose in a series that the client received

                                            ShortImmunization Type of Dose
                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                                            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())
                                            78. Immunization.extension:typeOfHepatitisA.id
                                            Definition

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

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

                                            An Extension

                                            ShortExtension
                                            Control0..0
                                            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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 82. Immunization.extension:typeOfHepatitisA.url
                                              Definition

                                              Source of the definition for the extension code - a logical name or a URL.

                                              Shortidentifies the meaning of the extension
                                              Comments

                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                              Control1..1
                                              Typeuri
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                                              84. Immunization.extension:typeOfHepatitisA.value[x]
                                              Definition

                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                              ShortValue of extension
                                              Control0..1
                                              BindingThe codes SHALL be taken from IMMZ.D.DE237 ValueSet for Type of hepatitis A dose
                                              (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237)
                                              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()))
                                              86. Immunization.extension:typeOfHepatitisB
                                              Slice NametypeOfHepatitisB
                                              Definition

                                              The type of dose in a series that the client received

                                              ShortImmunization Type of Dose
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(Immunization Type of Dose) (Extension Type: CodeableConcept)
                                              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())
                                              88. Immunization.extension:typeOfHepatitisB.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
                                              90. Immunization.extension:typeOfHepatitisB.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..0
                                              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 Immunization.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 92. Immunization.extension:typeOfHepatitisB.url
                                                Definition

                                                Source of the definition for the extension code - a logical name or a URL.

                                                Shortidentifies the meaning of the extension
                                                Comments

                                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                Control1..1
                                                Typeuri
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                Fixed Valuehttp://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
                                                94. Immunization.extension:typeOfHepatitisB.value[x]
                                                Definition

                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                ShortValue of extension
                                                Control0..1
                                                BindingThe codes SHALL be taken from IMMZ.D.DE254 ValueSet for Type of hepatitis B dose
                                                (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254)
                                                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()))
                                                96. Immunization.extension:vaccineBrand
                                                Slice NamevaccineBrand
                                                Definition

                                                The brand or trade name used to refer to the vaccine received

                                                ShortImmunization Vaccine Brand
                                                Control1..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Immunization Vaccine Brand) (Extension Type: CodeableConcept)
                                                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())
                                                98. Immunization.extension:liveVaccine
                                                Slice NameliveVaccine
                                                Definition

                                                Uses a living but weakened version of the virus or one that is very similar

                                                ShortImmunization Live Vaccine
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Immunization Live Vaccine) (Extension Type: boolean)
                                                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())
                                                100. Immunization.extension:marketAuthorizationHolder
                                                Slice NamemarketAuthorizationHolder
                                                Definition

                                                Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED

                                                ShortImmunization Market Authorization Holder
                                                Control1..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(Immunization Market Authorization Holder) (Extension Type: CodeableConcept)
                                                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())
                                                102. Immunization.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())
                                                104. Immunization.identifier
                                                Definition

                                                A unique identifier assigned to this immunization record.

                                                ShortBusiness 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()))
                                                106. Immunization.status
                                                Definition

                                                Indicates the current status of the immunization event.

                                                Shortcompleted | entered-in-error | not-done
                                                Comments

                                                Will generally be set to show that the immunization has been completed or not done. 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 ImmunizationStatusCodes
                                                (required to http://hl7.org/fhir/ValueSet/immunization-status|4.0.1)

                                                A set of codes indicating the current status of an Immunization.

                                                Typecode
                                                Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done 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
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                108. Immunization.statusReason
                                                Definition

                                                Indicates the reason the immunization event was not performed.

                                                ShortReason not done
                                                Comments

                                                This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

                                                Control0..1
                                                BindingThe codes SHALL be taken from IMMZ.D.DE5 ValueSet for Reason vaccine was not administered
                                                (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5)
                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                110. Immunization.vaccineCode
                                                Definition

                                                Vaccine that was administered or was to be administered.

                                                ShortVaccine product administered
                                                Control1..1
                                                BindingThe codes SHALL be taken from IMMZ.Z.VS ValueSet for vaccine types
                                                (required to http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS)
                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                112. Immunization.patient
                                                Definition

                                                The patient who either received or did not receive the immunization.

                                                ShortWho was immunized
                                                Control1..1
                                                TypeReference(Patient)
                                                Is Modifierfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                114. Immunization.encounter
                                                Definition

                                                The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

                                                ShortEncounter immunization was part of
                                                Control0..1
                                                TypeReference(Encounter)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                116. Immunization.occurrence[x]
                                                Definition

                                                Date vaccine administered or was to be administered.

                                                ShortVaccine administration date
                                                Comments

                                                When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

                                                Control1..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
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                118. Immunization.recorded
                                                Definition

                                                The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

                                                ShortWhen the immunization was first captured in the subject's record
                                                Control0..1
                                                TypedateTime
                                                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()))
                                                120. Immunization.primarySource
                                                Definition

                                                An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

                                                ShortIndicates context the data was recorded in
                                                Comments

                                                Reflects the “reliability” of the content.

                                                Control0..1
                                                Typeboolean
                                                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()))
                                                122. Immunization.reportOrigin
                                                Definition

                                                The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

                                                ShortIndicates the source of a secondarily reported record
                                                Comments

                                                Should not be populated if primarySource = True, not required even if primarySource = False.

                                                Control0..1
                                                BindingFor example codes, see ImmunizationOriginCodes
                                                (example to http://hl7.org/fhir/ValueSet/immunization-origin)

                                                The source of the data for a record which is not from a primary source.

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

                                                The service delivery location where the vaccine administration occurred.

                                                ShortWhere immunization occurred
                                                Control0..1
                                                TypeReference(Location)
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                126. Immunization.location.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
                                                128. Immunization.location.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 Immunization.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 130. Immunization.location.extension:countryOfVaccination
                                                  Slice NamecountryOfVaccination
                                                  Definition

                                                  The service delivery country where the vaccine administration occurred

                                                  ShortImmunization Country of Vaccination
                                                  Control1..1
                                                  TypeExtension(Immunization Country of Vaccination) (Extension Type: CodeableConcept)
                                                  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())
                                                  132. Immunization.location.extension:administrativeArea
                                                  Slice NameadministrativeArea
                                                  Definition

                                                  The service delivery location (location name, city, municipality, town or village) where the vaccine administration occurred

                                                  ShortImmunization Administrative Area
                                                  Control0..1
                                                  TypeExtension(Immunization Administrative Area) (Extension Type: CodeableConcept)
                                                  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())
                                                  134. Immunization.location.reference
                                                  Definition

                                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                  ShortLiteral reference, Relative, internal or absolute URL
                                                  Comments

                                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                  Control0..1
                                                  This element is affected by the following invariants: ref-1
                                                  Typestring
                                                  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()))
                                                  136. Immunization.location.type
                                                  Definition

                                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                  ShortType the reference refers to (e.g. "Patient")
                                                  Comments

                                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                  Control0..1
                                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                  Aa resource (or, for logical models, the URI of the logical model).

                                                  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()))
                                                  138. Immunization.location.identifier
                                                  Definition

                                                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                  ShortLogical reference, when literal reference is not known
                                                  Comments

                                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                  Control0..1
                                                  TypeIdentifier
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  140. Immunization.location.display
                                                  Definition

                                                  Plain text narrative that identifies the resource in addition to the resource reference.

                                                  ShortText alternative for the resource
                                                  Comments

                                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                  Control0..1
                                                  Typestring
                                                  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()))
                                                  142. Immunization.manufacturer
                                                  Definition

                                                  Name of vaccine manufacturer.

                                                  ShortVaccine manufacturer
                                                  Control0..1
                                                  TypeReference(Organization)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  144. Immunization.lotNumber
                                                  Definition

                                                  Lot number of the vaccine product.

                                                  ShortVaccine lot number
                                                  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()))
                                                  146. Immunization.expirationDate
                                                  Definition

                                                  Date vaccine batch expires.

                                                  ShortVaccine expiration date
                                                  Control0..1
                                                  Typedate
                                                  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()))
                                                  148. Immunization.site
                                                  Definition

                                                  Body site where vaccine was administered.

                                                  ShortBody site vaccine was administered
                                                  Control0..1
                                                  BindingFor example codes, see CodesForImmunizationSiteOfAdministration
                                                  (example to http://hl7.org/fhir/ValueSet/immunization-site)

                                                  The site at which the vaccine was administered.

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

                                                  The path by which the vaccine product is taken into the body.

                                                  ShortHow vaccine entered body
                                                  Control0..1
                                                  BindingFor example codes, see ImmunizationRouteCodes
                                                  (example to http://hl7.org/fhir/ValueSet/immunization-route)

                                                  The route by which the vaccine was administered.

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

                                                  The quantity of vaccine product that was administered.

                                                  ShortAmount of vaccine administered
                                                  Control0..1
                                                  TypeQuantity(SimpleQuantity)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  154. Immunization.performer
                                                  Definition

                                                  Indicates who performed the immunization event.

                                                  ShortWho performed event
                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  156. Immunization.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
                                                  158. Immunization.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())
                                                  160. Immunization.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())
                                                  162. Immunization.performer.function
                                                  Definition

                                                  Describes the type of performance (e.g. ordering provider, administering provider, etc.).

                                                  ShortWhat type of performance was done
                                                  Control0..1
                                                  BindingUnless not suitable, these codes SHALL be taken from ImmunizationFunctionCodes
                                                  (extensible to http://hl7.org/fhir/ValueSet/immunization-function)

                                                  The role a practitioner or organization plays in the immunization event.

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

                                                  The practitioner or organization who performed the action.

                                                  ShortIndividual or organization who was performing
                                                  Comments

                                                  When the individual practitioner who performed the action is known, it is best to send.

                                                  Control1..1
                                                  TypeReference(Practitioner, PractitionerRole, Organization)
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  166. Immunization.note
                                                  Definition

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

                                                  ShortAdditional immunization notes
                                                  Control0..*
                                                  TypeAnnotation
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  168. Immunization.reasonCode
                                                  Definition

                                                  Reasons why the vaccine was administered.

                                                  ShortWhy immunization occurred
                                                  Control0..*
                                                  BindingFor example codes, see ImmunizationReasonCodes
                                                  (example to http://hl7.org/fhir/ValueSet/immunization-reason)

                                                  The reason why a vaccine was administered.

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

                                                  Condition, Observation or DiagnosticReport that supports why the immunization was administered.

                                                  ShortWhy immunization occurred
                                                  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()))
                                                  172. Immunization.isSubpotent
                                                  Definition

                                                  Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

                                                  ShortDose potency
                                                  Comments

                                                  Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.

                                                  Control0..1
                                                  Typeboolean
                                                  Is Modifiertrue because This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Meaning if MissingBy default, a dose should be considered to be potent.
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  174. Immunization.subpotentReason
                                                  Definition

                                                  Reason why a dose is considered to be subpotent.

                                                  ShortReason for being subpotent
                                                  Control0..*
                                                  BindingFor example codes, see ImmunizationSubpotentReason
                                                  (example to http://hl7.org/fhir/ValueSet/immunization-subpotent-reason)

                                                  The reason why a dose is considered to be subpotent.

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

                                                  Educational material presented to the patient (or guardian) at the time of vaccine administration.

                                                  ShortEducational material presented to patient
                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  imm-1: One of documentType or reference SHALL be present (documentType.exists() or reference.exists())
                                                  178. Immunization.education.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
                                                  180. Immunization.education.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())
                                                  182. Immunization.education.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())
                                                  184. Immunization.education.documentType
                                                  Definition

                                                  Identifier of the material presented to the patient.

                                                  ShortEducational material document identifier
                                                  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()))
                                                  186. Immunization.education.reference
                                                  Definition

                                                  Reference pointer to the educational material given to the patient if the information was on line.

                                                  ShortEducational material reference pointer
                                                  Control0..1
                                                  Typeuri
                                                  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()))
                                                  188. Immunization.education.publicationDate
                                                  Definition

                                                  Date the educational material was published.

                                                  ShortEducational material publication date
                                                  Control0..1
                                                  TypedateTime
                                                  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()))
                                                  190. Immunization.education.presentationDate
                                                  Definition

                                                  Date the educational material was given to the patient.

                                                  ShortEducational material presentation date
                                                  Control0..1
                                                  TypedateTime
                                                  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()))
                                                  192. Immunization.programEligibility
                                                  Definition

                                                  Indicates a patient's eligibility for a funding program.

                                                  ShortPatient eligibility for a vaccination program
                                                  Control0..*
                                                  BindingFor example codes, see ImmunizationProgramEligibility
                                                  (example to http://hl7.org/fhir/ValueSet/immunization-program-eligibility)

                                                  The patient's eligibility for a vaccation program.

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

                                                  Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

                                                  ShortFunding source for the vaccine
                                                  Control0..1
                                                  BindingFor example codes, see ImmunizationFundingSource
                                                  (example to http://hl7.org/fhir/ValueSet/immunization-funding-source)

                                                  The source of funding used to purchase the vaccine administered.

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

                                                  Categorical data indicating that an adverse event is associated in time to an immunization.

                                                  ShortDetails of a reaction that follows immunization
                                                  Comments

                                                  A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.

                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  198. Immunization.reaction.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
                                                  200. Immunization.reaction.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())
                                                  202. Immunization.reaction.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())
                                                  204. Immunization.reaction.date
                                                  Definition

                                                  Date of reaction to the immunization.

                                                  ShortWhen reaction started
                                                  Control0..1
                                                  TypedateTime
                                                  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()))
                                                  206. Immunization.reaction.detail
                                                  Definition

                                                  Details of the reaction.

                                                  ShortAdditional information on reaction
                                                  Control0..1
                                                  TypeReference(Observation)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  208. Immunization.reaction.reported
                                                  Definition

                                                  Self-reported indicator.

                                                  ShortIndicates self-reported reaction
                                                  Control0..1
                                                  Typeboolean
                                                  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()))
                                                  210. Immunization.protocolApplied
                                                  Definition

                                                  The protocol (set of recommendations) being followed by the provider who administered the dose.

                                                  ShortProtocol followed by the provider
                                                  Control1..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  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 Immunization.protocolApplied. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • exists @ series
                                                  • exists @ doseNumber
                                                  • 212. Immunization.protocolApplied.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
                                                    214. Immunization.protocolApplied.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())
                                                    216. Immunization.protocolApplied.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())
                                                    218. Immunization.protocolApplied.series
                                                    Definition

                                                    One possible path to achieve presumed immunity against a disease - within the context of an authority.

                                                    ShortName of vaccine series
                                                    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()))
                                                    220. Immunization.protocolApplied.authority
                                                    Definition

                                                    Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

                                                    ShortWho is responsible for publishing the recommendations
                                                    Control0..1
                                                    TypeReference(Organization)
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    222. Immunization.protocolApplied.targetDisease
                                                    Definition

                                                    The vaccine preventable disease the dose is being administered against.

                                                    ShortVaccine preventatable disease being targetted
                                                    Control0..*
                                                    BindingFor example codes, see ImmunizationTargetDiseaseCodes
                                                    (example to http://hl7.org/fhir/ValueSet/immunization-target-disease)

                                                    The vaccine preventable disease the dose is being administered for.

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

                                                    Nominal position in a series.

                                                    ShortDose number within series
                                                    Comments

                                                    The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

                                                    Control1..1
                                                    TypeChoice of: positiveInt, string
                                                    [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
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    226. Immunization.protocolApplied.seriesDoses[x]
                                                    Definition

                                                    The recommended number of doses to achieve immunity.

                                                    ShortRecommended number of doses for immunity
                                                    Comments

                                                    The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

                                                    Control0..1
                                                    TypeChoice of: positiveInt, string
                                                    [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
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    228. Immunization.protocolApplied:immzProtocol
                                                    Slice NameimmzProtocol
                                                    Definition

                                                    The protocol (set of recommendations) being followed by the provider who administered the dose.

                                                    ShortProtocol followed by the provider
                                                    Control1..*
                                                    TypeBackboneElement
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    230. Immunization.protocolApplied:immzProtocol.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
                                                    232. Immunization.protocolApplied:immzProtocol.extension
                                                    Definition

                                                    An Extension

                                                    ShortExtension
                                                    Control0..*
                                                    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 Immunization.protocolApplied.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 234. Immunization.protocolApplied:immzProtocol.extension:dueDateOfNextDose
                                                      Slice NamedueDateOfNextDose
                                                      Definition

                                                      The service delivery location (location name, city, municipality, town or village) where the vaccine administration occurred

                                                      ShortImmunization Due Date of Next Dose
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(Immunization Due Date of Next Dose) (Extension Type: date)
                                                      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())
                                                      236. Immunization.protocolApplied:immzProtocol.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())
                                                      238. Immunization.protocolApplied:immzProtocol.series
                                                      Definition

                                                      One possible path to achieve presumed immunity against a disease - within the context of an authority.

                                                      ShortName of vaccine series
                                                      Control1..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()))
                                                      240. Immunization.protocolApplied:immzProtocol.authority
                                                      Definition

                                                      Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

                                                      ShortWho is responsible for publishing the recommendations
                                                      Control0..1
                                                      TypeReference(Organization)
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      242. Immunization.protocolApplied:immzProtocol.targetDisease
                                                      Definition

                                                      The vaccine preventable disease the dose is being administered against.

                                                      ShortVaccine preventatable disease being targetted
                                                      Control0..*
                                                      BindingFor example codes, see ImmunizationTargetDiseaseCodes
                                                      (example to http://hl7.org/fhir/ValueSet/immunization-target-disease)

                                                      The vaccine preventable disease the dose is being administered for.

                                                      TypeCodeableConcept
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      244. Immunization.protocolApplied:immzProtocol.doseNumber[x]
                                                      Definition

                                                      Nominal position in a series.

                                                      ShortDose number within series
                                                      Comments

                                                      The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

                                                      Control1..1
                                                      Typestring
                                                      [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
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      246. Immunization.protocolApplied:immzProtocol.seriesDoses[x]
                                                      Definition

                                                      The recommended number of doses to achieve immunity.

                                                      ShortRecommended number of doses for immunity
                                                      Comments

                                                      The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

                                                      Control0..1
                                                      TypeChoice of: positiveInt, string
                                                      [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
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))