Australian Digital Health Agency FHIR Implementation Guide 1.0.0

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: Bundle-air-02

Formats: Narrative, XML, JSON, Turtle

Raw xml



<Bundle xmlns="http://hl7.org/fhir">
<!-- Bundle from Medicare Repository to MHR system of the set of resources that make up the AIR for Patient with IHI 8003608000216028  -->
  <id value="air-02"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value
           value="urn:oid:1.2.36.1.2001.1007.11.8003640002000035.212021023128"/>
  </identifier>
  <type value="collection"/>
<!--     IMMUNIZATION (air-infl-04)     -->
  <entry>
    <fullUrl value="urn:uuid:0db57fef-dee6-446a-af15-4dfb3fa4d0b5"/>
    <resource>
      <Immunization>
        <meta>
          <profile
                   value="http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-immunization-air-1"/>
        </meta>
        <text>
          <status value="extensions"/>
          <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Immunization</b></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">Profile: <a href="StructureDefinition-dh-immunization-air-1.html">ADHA Record of Immunisation from Australian Immunisation Register</a></p></div><p><b>Vaccine Vial Serial Number</b>: SERIAL1234</p><p><b>identifier</b>: id: urn:oid:1.2.36.1.2001.1007.11.8003640002000035.212021023128</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Panvax <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (air-vaccine-code-formats#PANVAX)</span></p><p><b>patient</b>: <span/></p><p><b>occurrence</b>: 2019-01-01</p><p><b>primarySource</b>: true</p><p><b>lotNumber</b>: lot001</p><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>Influenza <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> ()</span></td><td>1</td></tr></table></div>
        </text>
        <extension
                   url="http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number">
          <valueString value="SERIAL1234"/>
        </extension>
        <identifier>
          <system value="urn:ietf:rfc:3986"/>
          <value
                 value="urn:oid:1.2.36.1.2001.1007.11.8003640002000035.212021023128"/>
        </identifier>
        <status value="completed"/>
        <vaccineCode>
          <coding>
            <system
                    value="https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats"/>
            <code value="PANVAX"/>
            <display value="Panvax"/>
          </coding>
          <text value="Panvax"/>
        </vaccineCode>
        <patient>
          <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="8003608000216028"/>
          </identifier>
        </patient>
        <occurrenceDateTime value="2019-01-01"/>
        <primarySource value="true"/>
        <lotNumber value="lot001"/>
        <protocolApplied>
          <targetDisease>
            <text value="Influenza"/>
          </targetDisease>
          <doseNumberPositiveInt value="1"/>
        </protocolApplied>
      </Immunization>
    </resource>
  </entry>
<!-- PATIENT -->
<!-- A resource that doesn't have a persistent home / isn't a resource already on the server - but it does have a UUID assigned for this bundle "locally identified" -->
  <entry>
    <fullUrl value="urn:uuid:c821dcb1-f09f-4fec-b205-1e6ae0046d37"/>
    <resource>
      <Patient>
        <text>
          <status value="generated"/>
          <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Patient</b></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"/><p><b>identifier</b>: IHI: 8003608000216028</p></div>
        </text>
        <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="8003608000216028"/>
        </identifier>
      </Patient>
    </resource>
  </entry>
<!--     FLAG (air-03)  -->
  <entry>
    <fullUrl value="urn:uuid:12e8af92-d9d5-49e6-8ff4-a57aed9834b3"/>
    <resource>
      <Flag>
        <meta>
          <profile
                   value="http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-flag-air-1"/>
        </meta>
        <text>
          <status value="generated"/>
          <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Flag</b></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">Profile: <a href="StructureDefinition-dh-flag-air-1.html">ADHA Australian Immunisation Register Notice</a></p></div><p><b>identifier</b>: id: urn:oid:1.2.36.1.2001.1007.11.8003640002000035.212021023128</p><p><b>status</b>: active</p><p><b>category</b>: Australian Immunisation Register notice <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#1500551000168103)</span></p><p><b>code</b>: Natural immunity to Influenza recorded on 01 January 2019. <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> ()</span></p><p><b>subject</b>: <span/></p><p><b>author</b>: <a href="Organization-medicare-rs-operator.html">Organization/medicare-rs-operator</a> &quot;Medicare Australia repository services operator&quot;</p></div>
        </text>
        <identifier>
          <system value="urn:ietf:rfc:3986"/>
          <value
                 value="urn:oid:1.2.36.1.2001.1007.11.8003640002000035.212021023128"/>
        </identifier>
        <status value="active"/>
        <category>
          <coding>
            <system value="http://snomed.info/sct"/>
            <code value="1500551000168103"/>
          </coding>
          <text value="Australian Immunisation Register notice"/>
        </category>
        <code>
          <text
                value="Natural immunity to Influenza recorded on 01 January 2019."/>
        </code>
        <subject>
          <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="8003608000216028"/>
          </identifier>
        </subject>
        <author>
          <reference value="Organization/medicare-rs-operator"/>
          <identifier>
            <type>
              <coding>
                <system
                        value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
                <code value="NOI"/>
                <display value="National Organisation Identifier"/>
              </coding>
              <text value="PAI-O"/>
            </type>
            <system
                    value="http://ns.electronichealth.net.au/id/pcehr/paio/1.0"/>
            <value value="8003640001000036"/>
          </identifier>
        </author>
      </Flag>
    </resource>
  </entry>
</Bundle>