Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.27.0 - release New Zealand

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

## : immunisation-update-response-message-match-quality - XML Representation

Raw xml | Download

    <Immunization xmlns="http://hl7.org/fhir">
      <id value="immunisation-update-response-message-match-quality"/>
      <meta>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system">
          <valueString value="HSAPP0010"/>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-by">
          <valueString value="user"/>
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/firstCreated">
          <valueInstant value="2026-03-31T01:29:49.597+00:00"/>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by">
          <valueString value="user"/>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system">
          <valueString value="HSAPP0010"/>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-data-quality-assessment">
          <extension url="dqScore">
            <valueInteger value="100"/>
          </extension>
          <extension url="dqLastUpdated">
            <valueDateTime value="2026-03-31T01:32:08.270+00:00"/>
          </extension>
          <extension url="dqStatus">
            <valueString value="P"/>
          </extension>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match">
          <extension url="match">
            <extension url="plannedEventId">
              <valueString value="00513eb7-7d2a-495a-b3aa-c361b3f923a2"/>
            </extension>
            <extension url="matchedDate">
              <valueDateTime value="2026-03-31T01:32:08.369+00:00"/>
            </extension>
            <extension url="matchedBy">
              <valueString value="user"/>
            </extension>
            <extension url="matchedReason">
              <valueCoding>
                <code value="302"/>
                <display value="Automatically matched by dose and indication"/>
              </valueCoding>
            </extension>
          </extension>
        </extension>
        <versionId value="2"/>
        <lastUpdated value="2026-03-31T01:32:08.126+00:00"/>
        <profile
                 value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization"/>
      </meta>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Immunization immunisation-update-response-message-match-quality</b></p><a name="immunisation-update-response-message-match-quality"> </a><a name="hcimmunisation-update-response-message-match-quality"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">version: 2; Last updated: 2026-03-31 01:32:08+0000</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-air-immunization.html">AIR Immunization</a></p></div><p><b>AIR Related Person</b>: <a href="#hcimmunisation-update-response-message-match-quality/45c49168-bef8-4c22-8f37-fc13ec494594">RelatedPerson Air Test Compliance </a></p><blockquote><p><b>AIR Age Given Extension</b></p><ul><li>years: 0</li><li>months: 1</li><li>days: 14</li><li>daysSinceBirth: 45</li><li>precision: DAY</li></ul></blockquote><p><b>status</b>: Completed</p><p><b>statusReason</b>: <span title="Codes:{https://standards.digital.health.nz/ns/air-status-reason-terms GIVEN}">Vaccination given</span></p><p><b>vaccineCode</b>: <span title="Codes:{http://hl7.org/fhir/sid/cvx 119}">RV1</span></p><p><b>patient</b>: <a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681">https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681</a></p><p><b>occurrence</b>: 2024-03-02 00:00:00+0000</p><p><b>location</b>: <a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E">https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E</a></p><p><b>lotNumber</b>: RV1-001</p><p><b>expirationDate</b>: 2026-01-31</p><p><b>route</b>: <span title="Codes:{https://standards.digital.health.nz/ns/air-terms-code PO}">Oral</span></p><h3>Performers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Function</b></td><td><b>Actor</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{https://standards.digital.health.nz/ns/air-terms-code VC}">Vaccinator</span></td><td><a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/92ZZRR">https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/92ZZRR</a></td></tr></table><p><b>reasonCode</b>: <span title="Codes:{https://standards.digital.health.nz/ns/air-terms-code 6W}">6 weeks</span></p><h3>ProtocolApplieds</h3><table class="grid"><tr><td style="display: none">-</td><td><b>TargetDisease</b></td><td><b>DoseNumber[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://snomed.info/sct 18624000}">Rotavirus</span></td><td>1</td></tr></table><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: RelatedPerson #45c49168-bef8-4c22-8f37-fc13ec494594</b></p><a name="immunisation-update-response-message-match-quality/45c49168-bef8-4c22-8f37-fc13ec494594"> </a><a name="hcimmunisation-update-response-message-match-quality/45c49168-bef8-4c22-8f37-fc13ec494594"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-air-related-person-prf.html">AIR Related Person Profile</a></p></div><p><b>patient</b>: <a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681">https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681</a></p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode MTH}">mother</span></p><p><b>name</b>: Air Test Compliance </p><p><b>telecom</b>: ph: 047771234(Home), ph: 0217771234(Work), <a href="mailto:air@compliance.govt.nz">air@compliance.govt.nz</a></p><p><b>address</b>: 3E 163 Thorndon Quay Thorndon Wellington 6011 (home) (NZ Suburb: Thorndon)</p></blockquote></div>
      </text>
      <contained>
        <RelatedPerson>
          <id value="45c49168-bef8-4c22-8f37-fc13ec494594"/>
          <meta>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-prf"/>
          </meta>
          <patient>
            <reference
                       value="https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681"/>
            <identifier>
              <system value="https://standards.digital.health.nz/ns/nhi-id"/>
              <value value="ZGY9681"/>
            </identifier>
          </patient>
          <relationship>
            <coding>
              <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/>
              <code value="MTH"/>
            </coding>
          </relationship>
          <name>
            <family value="Compliance"/>
            <given value="Air Test"/>
          </name>
          <telecom>
            <system value="phone"/>
            <value value="047771234"/>
            <use value="home"/>
          </telecom>
          <telecom>
            <system value="phone"/>
            <value value="0217771234"/>
            <use value="work"/>
          </telecom>
          <telecom>
            <system value="email"/>
            <value value="air@compliance.govt.nz"/>
            <use value="home"/>
          </telecom>
          <address>
            <extension url="http://hl7.org.nz/fhir/StructureDefinition/suburb">
              <valueString value="Thorndon"/>
            </extension>
            <use value="home"/>
            <type value="physical"/>
            <line value="3E 163 Thorndon Quay"/>
            <line value="Thorndon"/>
            <city value="Wellington"/>
            <postalCode value="6011"/>
          </address>
        </RelatedPerson>
      </contained>
      <extension
                 url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-extension">
        <valueReference>
          <reference value="#45c49168-bef8-4c22-8f37-fc13ec494594"/>
        </valueReference>
      </extension>
      <extension
                 url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given">
        <extension url="years">
          <valueInteger value="0"/>
        </extension>
        <extension url="months">
          <valueInteger value="1"/>
        </extension>
        <extension url="days">
          <valueInteger value="14"/>
        </extension>
        <extension url="daysSinceBirth">
          <valueInteger value="45"/>
        </extension>
        <extension url="precision">
          <valueString value="DAY"/>
        </extension>
      </extension>
      <status value="completed"/>
      <statusReason>
        <coding>
          <system
                  value="https://standards.digital.health.nz/ns/air-status-reason-terms"/>
          <code value="GIVEN"/>
          <display value="Vaccination given"/>
        </coding>
      </statusReason>
      <vaccineCode>
        <coding>
          <system value="http://hl7.org/fhir/sid/cvx"/>
          <code value="119"/>
          <display value="RV1"/>
        </coding>
        <text value="RV1"/>
      </vaccineCode>
      <patient>
        <reference
                   value="https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681"/>
        <identifier>
          <system value="https://standards.digital.health.nz/ns/nhi-id"/>
          <value value="ZGY9681"/>
        </identifier>
      </patient>
      <occurrenceDateTime value="2024-03-02T00:00:00+00:00"/>
      <location>
        <reference
                   value="https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E"/>
        <identifier>
          <system value="https://standards.digital.health.nz/ns/hpi-facility-id"/>
          <value value="FZZ835-E"/>
        </identifier>
      </location>
      <lotNumber value="RV1-001"/>
      <expirationDate value="2026-01-31"/>
      <route>
        <coding>
          <system value="https://standards.digital.health.nz/ns/air-terms-code"/>
          <code value="PO"/>
          <display value="Oral"/>
        </coding>
      </route>
      <performer>
        <function>
          <coding>
            <system
                    value="https://standards.digital.health.nz/ns/air-terms-code"/>
            <code value="VC"/>
            <display value="Vaccinator"/>
          </coding>
        </function>
        <actor>
          <reference
                     value="https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/92ZZRR"/>
          <identifier>
            <system value="https://standards.digital.health.nz/ns/hpi-person-id"/>
            <value value="92ZZRR"/>
          </identifier>
        </actor>
      </performer>
      <reasonCode>
        <coding>
          <system value="https://standards.digital.health.nz/ns/air-terms-code"/>
          <code value="6W"/>
          <display value="6 weeks"/>
        </coding>
      </reasonCode>
      <protocolApplied>
        <targetDisease>
          <coding>
            <system value="http://snomed.info/sct"/>
            <code value="18624000"/>
            <display value="Rotavirus"/>
          </coding>
        </targetDisease>
        <doseNumberPositiveInt value="1"/>
      </protocolApplied>
    </Immunization>