| Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

## Example: Immunization-covid-01

Formats: Narrative, XML, JSON, Turtle

Raw xml

    <Immunization xmlns="http://hl7.org/fhir">
      <id value="covid-01"/>
      <meta>
        <profile
                 value="http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-immunization-core-1"/>
      </meta>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Immunization</b><a name="covid-01"> </a></p><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">Resource Immunization "covid-01" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-dh-immunization-core-1.html">ADHA Core Immunization</a></p></div><p><b>Vaccine Vial Serial Number</b>: vNo1111</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Pfizer Comirnaty <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (air-vaccine-code-formats#COMIRN; <a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#1525011000168107 "Comirnaty")</span></p><p><b>patient</b>: <a href="Patient-mhr-field-sally.html">Patient/mhr-field-sally</a> " FIELD"</p><p><b>occurrence</b>: 2021-06-17</p><p><b>recorded</b>: 2021-06-17</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a href="Location-algrester-medical-centre.html">Location/algrester-medical-centre</a> "Gregory Tindal Building"</p><p><b>manufacturer</b>: <span>: Pfizer Australia Ltd</span></p><p><b>lotNumber</b>: 200000000P</p><h3>Performers</h3><table class="grid"><tr><td>-</td><td><b>Function</b></td><td><b>Actor</b></td></tr><tr><td>*</td><td>Administering Provider <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-v2-0443.html">providerRole</a>#AP)</span></td><td><a href="PractitionerRole-algrester-greg-gp.html">PractitionerRole/algrester-greg-gp</a></td></tr></table><h3>ProtocolApplieds</h3><table class="grid"><tr><td>-</td><td><b>TargetDisease</b></td><td><b>DoseNumber[x]</b></td></tr><tr><td>*</td><td>COVID-19 <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#840539006)</span></td><td>1</td></tr></table></div>
      </text>
      <extension
                 url="http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number">
      <!-- Vial serial number below does not conform to reporting requirements to avoid conflict with real world values -->
        <valueString value="vNo1111"/>
      </extension>
      <status value="completed"/>
      <vaccineCode>
        <coding>
          <system
                  value="https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats"/>
          <code value="COMIRN"/>
        </coding>
        <coding>
          <system value="http://snomed.info/sct"/>
          <code value="1525011000168107"/>
          <display value="Comirnaty"/>
        </coding>
        <text value="Pfizer Comirnaty"/>
      </vaccineCode>
      <patient>
        <reference value="Patient/mhr-field-sally"/>
        <identifier>
          <type>
            <coding>
              <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
              <code value="NI"/>
              <display value="National unique individual identifier"/>
            </coding>
            <text value="IHI"/>
          </type>
          <system value="http://ns.electronichealth.net.au/id/hi/ihi/1.0"/>
          <value value="8003608833357361"/>
        </identifier>
      </patient>
      <occurrenceDateTime value="2021-06-17"/>
      <recorded value="2021-06-17"/>
      <primarySource value="true"/>
      <location>
        <reference value="Location/algrester-medical-centre"/>
        <identifier>
          <type>
            <coding>
              <system value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
              <code value="NOI"/>
            </coding>
            <text value="HPI-O"/>
          </type>
          <system value="http://ns.electronichealth.net.au/id/hi/hpio/1.0"/>
          <value value="8003614900041243"/>
        </identifier>
      </location>
      <manufacturer>
        <display value="Pfizer Australia Ltd"/>
      </manufacturer>
    <!-- Lot number below does not conform to batch number reporting requirements to avoid conflict with real world values -->
      <lotNumber value="200000000P"/>
      <performer>
        <function>
          <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v2-0443"/>
            <code value="AP"/>
            <display value="Administering Provider"/>
          </coding>
          <text value="Administering Provider"/>
        </function>
        <actor>
          <reference value="PractitionerRole/algrester-greg-gp"/>
          <identifier>
            <type>
              <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
                <code value="NPI"/>
                <display value="National provider identifier"/>
              </coding>
              <text value="HPI-I"/>
            </type>
            <system value="http://ns.electronichealth.net.au/id/hi/hpii/1.0"/>
            <value value="8003614900041243"/>
          </identifier>
        </actor>
      </performer>
      <protocolApplied>
        <targetDisease>
          <coding>
            <system value="http://snomed.info/sct"/>
            <code value="840539006"/>
            <display value="COVID-19"/>
          </coding>
          <text value="COVID-19"/>
        </targetDisease>
        <doseNumberPositiveInt value="1"/>
      </protocolApplied>
    </Immunization>