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

## : Immunization Example 2 - XML Representation

Raw xml | Download

    <Immunization xmlns="http://hl7.org/fhir">
      <id value="imm-example-2"/>
      <meta>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system">
          <valueString value="SS345"/>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by">
          <valueString value="222"/>
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/firstCreated">
          <valueDateTime value="2023-08-21T02:18:30.303+00:00"/>
        </extension>
        <versionId value="2"/>
        <lastUpdated value="2023-08-31T02:18:32.217+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 imm-example-2</b></p><a name="imm-example-2"> </a><a name="hcimm-example-2"> </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: 2023-08-31 02:18:32+0000</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-air-immunization.html">AIR Immunization</a></p></div><blockquote><p><b>Immunization Diluent</b></p><ul><li>diluentLotNumber: 33332222</li><li>diluentExpiryDate: 2026-01-01</li></ul></blockquote><p><b>AIR Administered Product Extension</b>: <span title="Codes:{http://nzmt.org.nz 44016911000116108}">M-M-R-II</span></p><p><b>mobileSiteId</b>: FZZ958-K_MOB0001</p><blockquote><p><b>AIR Age Given Extension</b></p><ul><li>years: 1</li><li>months: 2</li><li>days: 22</li><li>daysSinceBirth: 445</li><li>precision: Day</li></ul></blockquote><p><b>status</b>: Completed</p><p><b>statusReason</b>: <span title="Codes:{http://snomed.info/sct 127785005}">Active or passive immunization</span></p><p><b>vaccineCode</b>: <span title="Codes:{http://hl7.org/fhir/sid/cvx 03}">MMR</span></p><p><b>patient</b>: Identifier: NHI/ZAA0792</p><p><b>occurrence</b>: 2023-03-01 16:45:46+1300</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>: 1234567890</p><p><b>expirationDate</b>: 2024-08-31</p><p><b>site</b>: <span title="Codes:{http://snomed.info/sct 368209003}">Right upper arm</span></p><p><b>route</b>: <span title="Codes:{http://snomed.info/sct 54471007}">Buccal route</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>Identifier: HPIProvider/90ZZLP</td></tr></table><p><b>reasonCode</b>: <span title="Codes:{http://snomed.info/sct 161651000210107}">Publicly funded vaccination given for 65 years of age or older</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 14189004}">Measles</span></td><td>1</td></tr></table><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: RelatedPerson #imm-related-person-1</b></p><a name="imm-example-2/imm-related-person-1"> </a><a name="hcimm-example-2/imm-related-person-1"> </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/ZZZ9994">https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ9994</a></p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode MTH}">mother</span></p><p><b>name</b>: Jane Jess Test-Dill </p><p><b>telecom</b>: ph: 041111111(Home), ph: 091111111(Work), <a href="mailto:jadill@test.mail">jadill@test.mail</a></p><p><b>address</b>: 456 Main St Suite 256 Hamilton 1111 (home) (NZ Suburb: ccc)</p></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: Observation #imm-serology-report-1</b></p><a name="imm-example-2/imm-serology-report-1"> </a><a name="hcimm-example-2/imm-serology-report-1"> </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-serology-report-profile.html">AIR Serology Report Profile</a></p></div><p><b>status</b>: Final</p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 278969009}">Hepatitis B status</span></p><p><b>interpretation</b>: <span title="Codes:{https://standards.digital.health.nz/ns/air-serology-protection-terms IND}">Indeterminate</span></p></blockquote></div>
      </text>
      <contained>
        <RelatedPerson>
          <id value="imm-related-person-1"/>
          <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/ZZZ9994"/>
            <identifier>
              <system value="https://standards.digital.health.nz/ns/nhi-id"/>
              <value value="ZZZ9994"/>
            </identifier>
          </patient>
          <relationship>
            <coding>
              <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/>
              <code value="MTH"/>
            </coding>
          </relationship>
          <name>
            <family value="Test-Dill"/>
            <given value="Jane Jess"/>
          </name>
          <telecom>
            <system value="phone"/>
            <value value="041111111"/>
            <use value="home"/>
          </telecom>
          <telecom>
            <system value="phone"/>
            <value value="091111111"/>
            <use value="work"/>
          </telecom>
          <telecom>
            <system value="email"/>
            <value value="jadill@test.mail"/>
            <use value="home"/>
          </telecom>
          <address>
            <extension url="http://hl7.org.nz/fhir/StructureDefinition/suburb">
              <valueString value="ccc"/>
            </extension>
            <use value="home"/>
            <type value="physical"/>
            <line value="456 Main St"/>
            <line value="Suite 256"/>
            <city value="Hamilton"/>
            <postalCode value="1111"/>
          </address>
        </RelatedPerson>
      </contained>
      <contained>
        <Observation>
          <id value="imm-serology-report-1"/>
          <meta>
            <profile
                     value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-profile"/>
          </meta>
          <status value="final"/>
          <code>
            <coding>
              <system value="http://snomed.info/sct"/>
              <code value="278969009"/>
            </coding>
          </code>
          <interpretation>
            <coding>
              <system
                      value="https://standards.digital.health.nz/ns/air-serology-protection-terms"/>
              <code value="IND"/>
            </coding>
          </interpretation>
        </Observation>
      </contained>
      <extension
                 url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent">
        <extension url="diluentLotNumber">
          <valueString value="33332222"/>
        </extension>
        <extension url="diluentExpiryDate">
          <valueDate value="2026-01-01"/>
        </extension>
      </extension>
      <extension
                 url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product">
        <valueCodeableConcept>
          <coding>
            <system value="http://nzmt.org.nz"/>
            <code value="44016911000116108"/>
            <display value="M-M-R-II"/>
          </coding>
        </valueCodeableConcept>
      </extension>
      <extension url="mobileSiteId">
        <valueString value="FZZ958-K_MOB0001"/>
      </extension>
      <extension
                 url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given">
        <extension url="years">
          <valueInteger value="1"/>
        </extension>
        <extension url="months">
          <valueInteger value="2"/>
        </extension>
        <extension url="days">
          <valueInteger value="22"/>
        </extension>
        <extension url="daysSinceBirth">
          <valueInteger value="445"/>
        </extension>
        <extension url="precision">
          <valueString value="Day"/>
        </extension>
      </extension>
      <status value="completed"/>
      <statusReason>
        <coding>
          <system value="http://snomed.info/sct"/>
          <code value="127785005"/>
        </coding>
      </statusReason>
      <vaccineCode>
        <coding>
          <system value="http://hl7.org/fhir/sid/cvx"/>
          <code value="03"/>
          <display value="MMR"/>
        </coding>
      </vaccineCode>
      <patient>
        <identifier>
          <system value="https://standards.digital.health.nz/ns/nhi-id"/>
          <value value="ZAA0792"/>
        </identifier>
      </patient>
      <occurrenceDateTime value="2023-03-01T16:45:46+13: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="1234567890"/>
      <expirationDate value="2024-08-31"/>
      <site>
        <coding>
          <system value="http://snomed.info/sct"/>
          <version value="1.0.0"/>
          <code value="368209003"/>
          <display value="Right upper arm"/>
        </coding>
      </site>
      <route>
        <coding>
          <system value="http://snomed.info/sct"/>
          <version value="1.0.0"/>
          <code value="54471007"/>
          <display value="Buccal route"/>
        </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>
          <identifier>
            <system value="https://standards.digital.health.nz/ns/hpi-person-id"/>
            <value value="90ZZLP"/>
          </identifier>
        </actor>
      </performer>
      <reasonCode>
        <coding>
          <system value="http://snomed.info/sct"/>
          <version value="1.0.0"/>
          <code value="161651000210107"/>
          <display
                   value="Publicly funded vaccination given for 65 years of age or older"/>
        </coding>
      </reasonCode>
      <protocolApplied>
        <targetDisease>
          <coding>
            <system value="http://snomed.info/sct"/>
            <code value="14189004"/>
          </coding>
        </targetDisease>
        <doseNumberPositiveInt value="1"/>
      </protocolApplied>
    </Immunization>