Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
1.31.0 - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v1.31.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: AIRImmunizationRecommendation - XML Profile

Active as of 2026-07-23

XML representation of the air-immunization-recommendation resource profile.

Raw xml | Download

    <StructureDefinition xmlns="http://hl7.org/fhir">
      <id value="air-immunization-recommendation"/>
      <text>
        <status value="additional"/>
        <div xmlns="http://www.w3.org/1999/xhtml">Individual Immunisation Plan</div>
      </text>
      <url
           value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation"/>
      <version value="1.31.0"/>
      <name value="AIRImmunizationRecommendation"/>
      <title value="AIR Immunization Recommendation"/>
      <status value="active"/>
      <date value="2026-07-23T00:14:26+00:00"/>
      <publisher value="Te Whatu Ora"/>
      <contact>
        <name value="Te Whatu Ora"/>
        <telecom>
          <system value="url"/>
          <value value="https://tewhatuora.govt.nz"/>
        </telecom>
      </contact>
      <description
                   value="AIR uses this immunizationRecommendation profile to communicate the details of scheduled events. The specification for this profile is available at https://mohits.atlassian.net/wiki/spaces/NIS/pages/3507781730/AIRImmunizationRecommendation+FHIR+API+into+ImmSOT."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
          <display value="New Zealand"/>
        </coding>
      </jurisdiction>
      <purpose
               value="To communicate. the details of a planned immunisation event. Planned events may be generated algorithmically based on a patient's characteristics and a published schedule or created by a health provider."/>
      <fhirVersion value="4.0.1"/>
      <mapping>
        <identity value="workflow"/>
        <uri value="http://hl7.org/fhir/workflow"/>
        <name value="Workflow Pattern"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <uri value="http://hl7.org/v2"/>
        <name value="HL7 v2 Mapping"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <uri value="http://hl7.org/v3"/>
        <name value="RIM Mapping"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <uri value="http://hl7.org/fhir/fivews"/>
        <name value="FiveWs Pattern Mapping"/>
      </mapping>
      <kind value="resource"/>
      <abstract value="false"/>
      <type value="ImmunizationRecommendation"/>
      <baseDefinition
                      value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"/>
      <derivation value="constraint"/>
      <snapshot>
        <extension
                   url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
          <valueString value="4.0.1"/>
        </extension>
        <element id="ImmunizationRecommendation">
          <path value="ImmunizationRecommendation"/>
          <short value="Guidance or advice relating to an immunization"/>
          <definition
                      value="A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="ImmunizationRecommendation"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <constraint>
            <key value="dom-2"/>
            <severity value="error"/>
            <human
                   value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/>
            <expression value="contained.contained.empty()"/>
            <xpath value="not(parent::f:contained and f:contained)"/>
            <source
                    value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
          </constraint>
          <constraint>
            <key value="dom-3"/>
            <severity value="error"/>
            <human
                   value="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"/>
            <expression
                        value="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()"/>
            <xpath
                   value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"/>
            <source
                    value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
          </constraint>
          <constraint>
            <key value="dom-4"/>
            <severity value="error"/>
            <human
                   value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/>
            <expression
                        value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/>
            <xpath
                   value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/>
            <source
                    value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
          </constraint>
          <constraint>
            <key value="dom-5"/>
            <severity value="error"/>
            <human
                   value="If a resource is contained in another resource, it SHALL NOT have a security label"/>
            <expression value="contained.meta.security.empty()"/>
            <xpath value="not(exists(f:contained/*/f:meta/f:security))"/>
            <source
                    value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
          </constraint>
          <constraint>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
              <valueBoolean value="true"/>
            </extension>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
              <valueMarkdown
                             value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."/>
            </extension>
            <key value="dom-6"/>
            <severity value="warning"/>
            <human
                   value="A resource should have narrative for robust management"/>
            <expression value="text.`div`.exists()"/>
            <xpath value="exists(f:text/h:div)"/>
            <source
                    value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="Entity. Role, or Act"/>
          </mapping>
          <mapping>
            <identity value="workflow"/>
            <map value="Request"/>
          </mapping>
          <mapping>
            <identity value="v2"/>
            <map value="VXU_V04"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value="SubstanceAdministration[moodCode=RMD]"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.id">
          <path value="ImmunizationRecommendation.id"/>
          <short value="Logical id of this artifact"/>
          <definition
                      value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/>
          <comment
                   value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Resource.id"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
              <valueUrl value="id"/>
            </extension>
            <code value="http://hl7.org/fhirpath/System.String"/>
          </type>
          <isModifier value="false"/>
          <isSummary value="true"/>
        </element>
        <element id="ImmunizationRecommendation.meta">
          <path value="ImmunizationRecommendation.meta"/>
          <short value="Metadata about the resource"/>
          <definition
                      value="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."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Resource.meta"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="Meta"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
        </element>
        <element id="ImmunizationRecommendation.implicitRules">
          <path value="ImmunizationRecommendation.implicitRules"/>
          <short value="A set of rules under which this content was created"/>
          <definition
                      value="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."/>
          <comment
                   value="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."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Resource.implicitRules"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="uri"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="true"/>
          <isModifierReason
                            value="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"/>
          <isSummary value="true"/>
        </element>
        <element id="ImmunizationRecommendation.language">
          <path value="ImmunizationRecommendation.language"/>
          <short value="Language of the resource content"/>
          <definition
                      value="The base language in which the resource is written."/>
          <comment
                   value="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)."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Resource.language"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="code"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <binding>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
              <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/>
            </extension>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
              <valueString value="Language"/>
            </extension>
            <strength value="preferred"/>
            <description value="A human language."/>
            <valueSet value="http://hl7.org/fhir/ValueSet/languages|4.0.1"/>
          </binding>
        </element>
        <element id="ImmunizationRecommendation.text">
          <path value="ImmunizationRecommendation.text"/>
          <short value="Text summary of the resource, for human interpretation"/>
          <definition
                      value="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 &quot;clinically safe&quot; for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/>
          <comment
                   value="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 &quot;text blob&quot; or where text is additionally entered raw or narrated and encoded information is added later."/>
          <alias value="narrative"/>
          <alias value="html"/>
          <alias value="xhtml"/>
          <alias value="display"/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="DomainResource.text"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="Narrative"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="Act.text?"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.contained">
          <path value="ImmunizationRecommendation.contained"/>
          <short value="Contained, inline Resources"/>
          <definition
                      value="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."/>
          <comment
                   value="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."/>
          <alias value="inline resources"/>
          <alias value="anonymous resources"/>
          <alias value="contained resources"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="DomainResource.contained"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Resource"/>
          </type>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="N/A"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.extension">
          <path value="ImmunizationRecommendation.extension"/>
          <short value="Additional content defined by implementations"/>
          <definition
                      value="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."/>
          <comment
                   value="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."/>
          <alias value="extensions"/>
          <alias value="user content"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="DomainResource.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="N/A"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.modifierExtension">
          <path value="ImmunizationRecommendation.modifierExtension"/>
          <short value="Extensions that cannot be ignored"/>
          <definition
                      value="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)."/>
          <comment
                   value="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."/>
          <requirements
                        value="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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
          <alias value="extensions"/>
          <alias value="user content"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="DomainResource.modifierExtension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="true"/>
          <isModifierReason
                            value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="N/A"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.identifier">
          <path value="ImmunizationRecommendation.identifier"/>
          <short value="Business identifier"/>
          <definition
                      value="A unique identifier assigned to this particular recommendation record."/>
          <min value="0"/>
          <max value="0"/>
          <base>
            <path value="ImmunizationRecommendation.identifier"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Identifier"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="workflow"/>
            <map value="Request.identifier"/>
          </mapping>
          <mapping>
            <identity value="w5"/>
            <map value="FiveWs.identifier"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".id"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.patient">
          <path value="ImmunizationRecommendation.patient"/>
          <short value="Who this profile is for"/>
          <definition value="The patient the recommendation(s) are for."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="ImmunizationRecommendation.patient"/>
            <min value="1"/>
            <max value="1"/>
          </base>
          <type>
            <code value="Reference"/>
            <targetProfile
                           value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="workflow"/>
            <map value="Request.subject"/>
          </mapping>
          <mapping>
            <identity value="w5"/>
            <map value="FiveWs.subject[x]"/>
          </mapping>
          <mapping>
            <identity value="v2"/>
            <map value="PID-3"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".partipication[typeCode=SUBJ].role"/>
          </mapping>
          <mapping>
            <identity value="w5"/>
            <map value="FiveWs.subject"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.date">
          <path value="ImmunizationRecommendation.date"/>
          <short value="Date recommendation(s) created"/>
          <definition
                      value="The date the immunization recommendation(s) were created."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="ImmunizationRecommendation.date"/>
            <min value="1"/>
            <max value="1"/>
          </base>
          <type>
            <code value="dateTime"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="workflow"/>
            <map value="Request.authoredOn"/>
          </mapping>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-15"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".partipication[typeCode=AUTH].time"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.authority">
          <path value="ImmunizationRecommendation.authority"/>
          <short value="Who is responsible for protocol"/>
          <definition
                      value="Indicates the authority who published the protocol (e.g. ACIP)."/>
          <min value="0"/>
          <max value="0"/>
          <base>
            <path value="ImmunizationRecommendation.authority"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="Reference"/>
            <targetProfile
                           value="http://hl7.org/fhir/StructureDefinition/Organization|4.0.1"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5 : OBX-3 = 59779-9"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".participation[typeCode=AUT]"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation">
          <path value="ImmunizationRecommendation.recommendation"/>
          <short value="Vaccine administration recommendations"/>
          <definition value="Vaccine administration recommendations."/>
          <min value="1"/>
          <max value="*"/>
          <base>
            <path value="ImmunizationRecommendation.recommendation"/>
            <min value="1"/>
            <max value="*"/>
          </base>
          <type>
            <code value="BackboneElement"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="imr-1"/>
            <severity value="error"/>
            <human value="One of vaccineCode or targetDisease SHALL be present"/>
            <expression value="vaccineCode.exists() or targetDisease.exists()"/>
            <xpath value="exists(f:vaccineCode) or exists(f:targetDisease)"/>
            <source
                    value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="rim"/>
            <map
                 value=".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.id">
          <path value="ImmunizationRecommendation.recommendation.id"/>
          <representation value="xmlAttr"/>
          <short value="Unique id for inter-element referencing"/>
          <definition
                      value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="Element.id"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
              <valueUrl value="string"/>
            </extension>
            <code value="http://hl7.org/fhirpath/System.String"/>
          </type>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.extension">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <slicing>
            <discriminator>
              <type value="value"/>
              <path value="url"/>
            </discriminator>
            <ordered value="false"/>
            <rules value="open"/>
          </slicing>
          <short value="Extension"/>
          <definition value="An Extension"/>
          <min value="4"/>
          <max value="*"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
        </element>
        <element id="ImmunizationRecommendation.recommendation.extension:id">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <sliceName value="id"/>
          <short value="AIR Consumer State"/>
          <definition
                      value="This extension is used in AIR to communicate the current state of an AIR Patient (AKA Consumer)."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state"/>
          </type>
          <condition value="ele-1"/>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.extension:disease-covered">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <sliceName value="disease-covered"/>
          <short value="AIR Disease Covered"/>
          <definition
                      value="The disease which a vaccine covers. Needed in ImmunizationRecommendation as the cardinality there is only single."/>
          <min value="1"/>
          <max value="*"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered"/>
          </type>
          <condition value="ele-1"/>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.extension:antigen-group">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <sliceName value="antigen-group"/>
          <short value="AIR Antigen Group Vaccination Schedule"/>
          <definition
                      value="This extension to the AIR ImmunizationRecommendation profile is used to convey information about the antigen group vaccination schedule associated with a Scheduled Event, including the schedule type, the series type, the antigen group, and the version."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs"/>
          </type>
          <condition value="ele-1"/>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.extension:air-scheduled-event">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <sliceName value="air-scheduled-event"/>
          <short value="AIR Scheduled Event"/>
          <definition
                      value="The extension to the AIR ImmunizationRecommendation profile is used to convey information about scheduled events, including the event type, the schedule type, the series type, and the antigen group."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"/>
          </type>
          <condition value="ele-1"/>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.modifierExtension">
          <path
                value="ImmunizationRecommendation.recommendation.modifierExtension"/>
          <short value="Extensions that cannot be ignored even if unrecognized"/>
          <definition
                      value="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)."/>
          <comment
                   value="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."/>
          <requirements
                        value="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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
          <alias value="extensions"/>
          <alias value="user content"/>
          <alias value="modifiers"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="BackboneElement.modifierExtension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="true"/>
          <isModifierReason
                            value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="rim"/>
            <map value="N/A"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode">
          <path value="ImmunizationRecommendation.recommendation.vaccineCode"/>
          <short value="Vaccine  or vaccine group recommendation applies to"/>
          <definition
                      value="Vaccine(s) or vaccine group that pertain to the recommendation."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="ImmunizationRecommendation.recommendation.vaccineCode"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <binding>
            <strength value="preferred"/>
            <valueSet
                      value="https://nzhts.digital.health.nz/fhir/ValueSet/air-vaccine-product-code"/>
          </binding>
          <mapping>
            <identity value="workflow"/>
            <map value="Request.code"/>
          </mapping>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".partipication[typeCode=CSM].role[classCode=ADMM].code"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease">
          <path value="ImmunizationRecommendation.recommendation.targetDisease"/>
          <short value="Disease to be immunized against"/>
          <definition value="The targeted disease for the recommendation."/>
          <min value="0"/>
          <max value="0"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.targetDisease"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <binding>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
              <valueString value="TargetDisease"/>
            </extension>
            <strength value="example"/>
            <description
                         value="The disease that the recommended vaccination targets."/>
            <valueSet
                      value="http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease|4.0.1"/>
          </binding>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".partipication[typeCode=CSM].role[classCode=ADMM].code"/>
          </mapping>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.contraindicatedVaccineCode">
          <path
                value="ImmunizationRecommendation.recommendation.contraindicatedVaccineCode"/>
          <short
                 value="Vaccine which is contraindicated to fulfill the recommendation"/>
          <definition
                      value="Vaccine(s) which should not be used to fulfill the recommendation."/>
          <min value="0"/>
          <max value="0"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.contraindicatedVaccineCode"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <binding>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
              <valueString value="VaccineCode"/>
            </extension>
            <strength value="example"/>
            <description value="The type of vaccine administered."/>
            <valueSet value="http://hl7.org/fhir/ValueSet/vaccine-code|4.0.1"/>
          </binding>
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus">
          <path value="ImmunizationRecommendation.recommendation.forecastStatus"/>
          <short value="Vaccine recommendation status"/>
          <definition
                      value="Indicates the patient status with respect to the path to immunity for the target disease."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.forecastStatus"/>
            <min value="1"/>
            <max value="1"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="true"/>
          <isModifierReason
                            value="This element is labeled as a modifier because the forecastStatus indicates whether a patient needs additional doses (due, overdue, etc) or not  (contraindicated, complete, etc)."/>
          <isSummary value="true"/>
          <binding>
            <strength value="preferred"/>
            <valueSet
                      value="https://nzhts.digital.health.nz/fhir/ValueSet/air-forecast-status-code"/>
          </binding>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5 : OBX-3 = 59783-1"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value=".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code=&quot;Immunization Forecast Status&quot;].value"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastReason">
          <path value="ImmunizationRecommendation.recommendation.forecastReason"/>
          <short value="Vaccine administration status reason"/>
          <definition value="The reason for the assigned forecast status."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.forecastReason"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <binding>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
              <valueString value="ImmunizationRecommendationReason"/>
            </extension>
            <strength value="example"/>
            <description
                         value="The reason for the patient's status with respect to a vaccination protocol."/>
            <valueSet
                      value="http://hl7.org/fhir/ValueSet/immunization-recommendation-reason|4.0.1"/>
          </binding>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5 : OBX-3 = 30982-3"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value="N/A"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion">
          <path value="ImmunizationRecommendation.recommendation.dateCriterion"/>
          <short value="Dates governing proposed immunization"/>
          <definition
                      value="Vaccine date recommendations.  For example, earliest date to administer, latest date to administer, etc."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.dateCriterion"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="BackboneElement"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="workflow"/>
            <map value="Request.occurrence[x]"/>
          </mapping>
          <mapping>
            <identity value="v2"/>
            <map
                 value="OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value=".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.id">
          <path
                value="ImmunizationRecommendation.recommendation.dateCriterion.id"/>
          <representation value="xmlAttr"/>
          <short value="Unique id for inter-element referencing"/>
          <definition
                      value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Element.id"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
              <valueUrl value="string"/>
            </extension>
            <code value="http://hl7.org/fhirpath/System.String"/>
          </type>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.dateCriterion.extension">
          <path
                value="ImmunizationRecommendation.recommendation.dateCriterion.extension"/>
          <short value="Additional content defined by implementations"/>
          <definition
                      value="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."/>
          <comment
                   value="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."/>
          <alias value="extensions"/>
          <alias value="user content"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension">
          <path
                value="ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension"/>
          <short value="Extensions that cannot be ignored even if unrecognized"/>
          <definition
                      value="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)."/>
          <comment
                   value="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."/>
          <requirements
                        value="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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
          <alias value="extensions"/>
          <alias value="user content"/>
          <alias value="modifiers"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="BackboneElement.modifierExtension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="true"/>
          <isModifierReason
                            value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="rim"/>
            <map value="N/A"/>
          </mapping>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.dateCriterion.code">
          <path
                value="ImmunizationRecommendation.recommendation.dateCriterion.code"/>
          <short value="Type of date"/>
          <definition
                      value="Date classification of recommendation.  For example, earliest date to give, latest date to give, etc."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.dateCriterion.code"/>
            <min value="1"/>
            <max value="1"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <binding>
            <strength value="preferred"/>
            <valueSet
                      value="https://nzhts.digital.health.nz/fhir/ValueSet/air-planned-event-date-type-code"/>
          </binding>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-3"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".code"/>
          </mapping>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.dateCriterion.value">
          <path
                value="ImmunizationRecommendation.recommendation.dateCriterion.value"/>
          <short value="Recommended date"/>
          <definition
                      value="The date whose meaning is specified by dateCriterion.code."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.dateCriterion.value"/>
            <min value="1"/>
            <max value="1"/>
          </base>
          <type>
            <code value="dateTime"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".value"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.description">
          <path value="ImmunizationRecommendation.recommendation.description"/>
          <short value="Protocol details"/>
          <definition
                      value="Contains the description about the protocol under which the vaccine was administered."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="ImmunizationRecommendation.recommendation.description"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="string"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5 : OBX-3 = 30956-7"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".text"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.series">
          <path value="ImmunizationRecommendation.recommendation.series"/>
          <short value="Name of vaccination series"/>
          <definition
                      value="One possible path to achieve presumed immunity against a disease - within the context of an authority."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="ImmunizationRecommendation.recommendation.series"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="string"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="v2"/>
            <map value="RXA-5-administered code"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value=".title"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.doseNumber[x]">
          <path value="ImmunizationRecommendation.recommendation.doseNumber[x]"/>
          <short value="Recommended dose number within series"/>
          <definition
                      value="Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose)."/>
          <comment
                   value="The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose)."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.doseNumber[x]"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="positiveInt"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5 : OBX-3 = 30973-2"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value=".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"/>
          </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.seriesDoses[x]">
          <path value="ImmunizationRecommendation.recommendation.seriesDoses[x]"/>
          <short value="Recommended number of doses for immunity"/>
          <definition
                      value="The recommended number of doses to achieve immunity."/>
          <comment
                   value="The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose)."/>
          <min value="0"/>
          <max value="0"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.seriesDoses[x]"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="positiveInt"/>
          </type>
          <type>
            <code value="string"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="v2"/>
            <map value="OBX-5 : OBX-3 = 59782-3"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value=".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"/>
          </mapping>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.supportingImmunization">
          <path
                value="ImmunizationRecommendation.recommendation.supportingImmunization"/>
          <short value="Past immunizations supporting recommendation"/>
          <definition
                      value="Immunization event history and/or evaluation that supports the status and recommendation."/>
          <min value="0"/>
          <max value="0"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.supportingImmunization"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Reference"/>
            <targetProfile
                           value="http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1"/>
            <targetProfile
                           value="http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation|4.0.1"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="v2"/>
            <map value="? No clear way to associate in HL7 v2 or IG"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value=".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code=&quot;immunization&quot;]"/>
          </mapping>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.supportingPatientInformation">
          <path
                value="ImmunizationRecommendation.recommendation.supportingPatientInformation"/>
          <short value="Patient observations supporting recommendation"/>
          <definition
                      value="Patient Information that supports the status and recommendation.  This includes patient observations, adverse reactions and allergy/intolerance information."/>
          <min value="0"/>
          <max value="0"/>
          <base>
            <path
                  value="ImmunizationRecommendation.recommendation.supportingPatientInformation"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Reference"/>
            <targetProfile
                           value="http://hl7.org/fhir/StructureDefinition/Resource|4.0.1"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="workflow"/>
            <map value="Request.supportingInfo"/>
          </mapping>
          <mapping>
            <identity value="v2"/>
            <map
                 value="OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX'), could contain the reason the vaccine was not administered"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value=".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"/>
          </mapping>
        </element>
      </snapshot>
      <differential>
        <element id="ImmunizationRecommendation">
          <path value="ImmunizationRecommendation"/>
        </element>
        <element id="ImmunizationRecommendation.identifier">
          <path value="ImmunizationRecommendation.identifier"/>
          <max value="0"/>
        </element>
        <element id="ImmunizationRecommendation.patient">
          <path value="ImmunizationRecommendation.patient"/>
          <type>
            <code value="Reference"/>
            <targetProfile
                           value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient"/>
          </type>
        </element>
        <element id="ImmunizationRecommendation.authority">
          <path value="ImmunizationRecommendation.authority"/>
          <max value="0"/>
        </element>
        <element id="ImmunizationRecommendation.recommendation.id">
          <path value="ImmunizationRecommendation.recommendation.id"/>
          <min value="1"/>
        </element>
        <element id="ImmunizationRecommendation.recommendation.extension">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <slicing>
            <discriminator>
              <type value="value"/>
              <path value="url"/>
            </discriminator>
            <ordered value="false"/>
            <rules value="open"/>
          </slicing>
          <min value="4"/>
        </element>
        <element id="ImmunizationRecommendation.recommendation.extension:id">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <sliceName value="id"/>
          <min value="1"/>
          <max value="1"/>
          <type>
            <code value="Extension"/>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state"/>
          </type>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.extension:disease-covered">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <sliceName value="disease-covered"/>
          <min value="1"/>
          <max value="*"/>
          <type>
            <code value="Extension"/>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered"/>
          </type>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.extension:antigen-group">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <sliceName value="antigen-group"/>
          <min value="1"/>
          <max value="1"/>
          <type>
            <code value="Extension"/>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs"/>
          </type>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.extension:air-scheduled-event">
          <path value="ImmunizationRecommendation.recommendation.extension"/>
          <sliceName value="air-scheduled-event"/>
          <min value="1"/>
          <max value="1"/>
          <type>
            <code value="Extension"/>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"/>
          </type>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode">
          <path value="ImmunizationRecommendation.recommendation.vaccineCode"/>
          <binding>
            <strength value="preferred"/>
            <valueSet
                      value="https://nzhts.digital.health.nz/fhir/ValueSet/air-vaccine-product-code"/>
          </binding>
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease">
          <path value="ImmunizationRecommendation.recommendation.targetDisease"/>
          <max value="0"/>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.contraindicatedVaccineCode">
          <path
                value="ImmunizationRecommendation.recommendation.contraindicatedVaccineCode"/>
          <max value="0"/>
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus">
          <path value="ImmunizationRecommendation.recommendation.forecastStatus"/>
          <binding>
            <strength value="preferred"/>
            <valueSet
                      value="https://nzhts.digital.health.nz/fhir/ValueSet/air-forecast-status-code"/>
          </binding>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.dateCriterion.code">
          <path
                value="ImmunizationRecommendation.recommendation.dateCriterion.code"/>
          <binding>
            <strength value="preferred"/>
            <valueSet
                      value="https://nzhts.digital.health.nz/fhir/ValueSet/air-planned-event-date-type-code"/>
          </binding>
        </element>
        <element id="ImmunizationRecommendation.recommendation.doseNumber[x]">
          <path value="ImmunizationRecommendation.recommendation.doseNumber[x]"/>
          <type>
            <code value="positiveInt"/>
          </type>
        </element>
        <element id="ImmunizationRecommendation.recommendation.seriesDoses[x]">
          <path value="ImmunizationRecommendation.recommendation.seriesDoses[x]"/>
          <max value="0"/>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.supportingImmunization">
          <path
                value="ImmunizationRecommendation.recommendation.supportingImmunization"/>
          <max value="0"/>
        </element>
        <element
                 id="ImmunizationRecommendation.recommendation.supportingPatientInformation">
          <path
                value="ImmunizationRecommendation.recommendation.supportingPatientInformation"/>
          <max value="0"/>
        </element>
      </differential>
    </StructureDefinition>