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

Example: Immunization-covid-03

Formats: Narrative, XML, JSON, Turtle

Raw xml

<Immunization xmlns="http://hl7.org/fhir">
  <id value="covid-03"/>
  <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-03"> </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 &quot;covid-03&quot; </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>: vNo12121</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Moderna Spikevax <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (air-vaccine-code-formats#MODERN; <a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#1565201000168106 &quot;Spikevax&quot;)</span></p><p><b>patient</b>: <a href="Patient-mhr-field-sally.html">Patient/mhr-field-sally</a> &quot; FIELD&quot;</p><p><b>occurrence</b>: 2022-02-14</p><p><b>recorded</b>: 2022-02-14</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a href="Location-hi-testdata-pharmacy.html">Location/hi-testdata-pharmacy</a></p><p><b>manufacturer</b>: <span>: ModernaTX, Inc.</span></p><p><b>lotNumber</b>: RX00000F</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-pharmacist-retail.html">PractitionerRole/pharmacist-retail</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>3</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="vNo12121"/>
  </extension>
  <status value="completed"/>
  <vaccineCode>
    <coding>
      <system
              value="https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats"/>
      <code value="MODERN"/>
    </coding>
    <coding>
      <system value="http://snomed.info/sct"/>
      <code value="1565201000168106"/>
      <display value="Spikevax"/>
    </coding>
    <text value="Moderna Spikevax"/>
  </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="2022-02-14"/>
  <recorded value="2022-02-14"/>
  <primarySource value="true"/>
  <location>
    <reference value="Location/hi-testdata-pharmacy"/>
    <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="8003629900033370"/>
    </identifier>
  </location>
  <manufacturer>
    <display value="ModernaTX, Inc."/>
  </manufacturer>
<!-- Lot number below does not conform to batch number reporting requirements to avoid conflict with real world values -->
  <lotNumber value="RX00000F"/>
  <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/pharmacist-retail"/>
      <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="8003611566708354"/>
      </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="3"/>
  </protocolApplied>
</Immunization>