Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.1.0 - release New Zealand

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

## : Planned Event Example - XML Representation

Raw xml | Download

    <ImmunizationRecommendation xmlns="http://hl7.org/fhir">
      <id value="ir1"/>
      <meta>
        <profile
                 value="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation"/>
      </meta>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: ImmunizationRecommendation ir1</b></p><a name="ir1"> </a><a name="hcir1"> </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-immunization-recommendation.html">AIR Immunization Recommendation</a></p></div><p><b>patient</b>: <a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=http://fhir.org.nz/ig/base/pat">pat</a></p><p><b>date</b>: 2021-01-20</p><blockquote><p><b>recommendation</b></p><blockquote><p><b>id</b></p>12345-asdf</blockquote><p><b>AIR Recommendation Id</b>: 12345</p><p><b>AIR Disease Covered</b>: <span title="Codes:{http://snomed.info/sct 397428000}">Diphtheria</span></p><p><b>AIR Disease Covered</b>: <span title="Codes:{http://snomed.info/sct 76902006}">Tetanus</span></p><p><b>AIR Disease Covered</b>: <span title="Codes:{http://snomed.info/sct 27836007}">Pertussis</span></p><p><b>AIR Disease Covered</b>: <span title="Codes:{http://snomed.info/sct 398102009}">Poliomyelitis</span></p><p><b>AIR Disease Covered</b>: <span title="Codes:{http://snomed.info/sct 66071002}">Viral Hepatitis type B</span></p><p><b>AIR Disease Covered</b>: <span title="Codes:{http://snomed.info/sct 91428005}">Haemophilus influenzae infection</span></p><blockquote><p><b>AIR Antigen Group Vaccination Schedule</b></p><ul><li>schedule-type: <a href="CodeSystem-air-agvs-type.html#air-agvs-type-NIS">AIR AGVS: NIS</a> (National Immunisation Schedule)</li><li>series-type: <a href="CodeSystem-air-agvs-series-type.html#air-agvs-series-type-PRIMARY">AIR AGVS Series Type: PRIMARY</a> (Primary)</li><li>antigen-group: <a href="http://snomed.info/id/871761004">SNOMED CT: 871761004</a> (RV1)</li><li>version: 1.0</li></ul></blockquote><blockquote><p><b>AIR Scheduled Event</b></p><ul><li>type: <a href="CodeSystem-air-planned-event-type-terms.html#air-planned-event-type-terms-CPE">AIR Planned Event Type: CPE</a> (Consumer Planned Event)</li></ul></blockquote><p><b>vaccineCode</b>: <span title="Codes:{http://nzmt.org.nz 29455411000116105}">DTaP-IPV-HepB/Hib</span></p><p><b>forecastStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/immunization-recommendation-status due}">Due</span></p><h3>DateCriterions</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Value</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:">DUE</span></td><td>2021-01-14</td></tr></table><p><b>series</b>: DTaP-IPV-HepB/Hib</p><p><b>doseNumber</b>: 1</p></blockquote></div>
      </text>
      <patient>
        <reference value="pat"/>
      </patient>
      <date value="2021-01-20"/>
      <recommendation id="12345-asdf">
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state">
          <valueString value="12345"/>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered">
          <valueCodeableConcept>
            <coding>
              <system value="http://snomed.info/sct"/>
              <code value="397428000"/>
              <display value="Diphtheria"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs">
          <extension url="schedule-type">
            <valueCoding>
              <system
                      value="https://standards.digital.health.nz/ns/air-agvs-type"/>
              <code value="NIS"/>
            </valueCoding>
          </extension>
          <extension url="series-type">
            <valueCoding>
              <system
                      value="https://standards.digital.health.nz/ns/air-agvs-series-type"/>
              <code value="PRIMARY"/>
            </valueCoding>
          </extension>
          <extension url="antigen-group">
            <valueCoding>
              <system value="http://snomed.info/sct"/>
              <code value="871761004"/>
              <display value="RV1"/>
            </valueCoding>
          </extension>
          <extension url="version">
            <valueString value="1.0"/>
          </extension>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event">
          <extension url="type">
            <valueCoding>
              <system
                      value="https://standards.digital.health.nz/ns/air-scheduled-event-type-terms"/>
              <code value="CPE"/>
            </valueCoding>
          </extension>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered">
          <valueCodeableConcept>
            <coding>
              <system value="http://snomed.info/sct"/>
              <code value="76902006"/>
              <display value="Tetanus"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered">
          <valueCodeableConcept>
            <coding>
              <system value="http://snomed.info/sct"/>
              <code value="27836007"/>
              <display value="Pertussis"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered">
          <valueCodeableConcept>
            <coding>
              <system value="http://snomed.info/sct"/>
              <code value="398102009"/>
              <display value="Poliomyelitis"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered">
          <valueCodeableConcept>
            <coding>
              <system value="http://snomed.info/sct"/>
              <code value="66071002"/>
              <display value="Viral Hepatitis type B"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <extension
                   url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered">
          <valueCodeableConcept>
            <coding>
              <system value="http://snomed.info/sct"/>
              <code value="91428005"/>
              <display value="Haemophilus influenzae infection"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <vaccineCode>
          <coding>
            <system value="http://nzmt.org.nz"/>
            <code value="29455411000116105"/>
            <display value="DTaP-IPV-HepB/Hib"/>
          </coding>
        </vaccineCode>
        <forecastStatus>
          <coding>
            <system
                    value="http://terminology.hl7.org/CodeSystem/immunization-recommendation-status"/>
            <code value="due"/>
          </coding>
        </forecastStatus>
        <dateCriterion>
          <code>
            <coding>
              <code value="DUE"/>
            </coding>
          </code>
          <value value="2021-01-14"/>
        </dateCriterion>
        <series value="DTaP-IPV-HepB/Hib"/>
        <doseNumberString value="1"/>
      </recommendation>
    </ImmunizationRecommendation>