Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.4 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : NZ Telehealth Encounter Example - XML Representation

Raw xml | Download

    <Encounter xmlns="http://hl7.org/fhir">
      <meta>
        <source
                value="https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A"/>
        <profile
                 value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareEncounter"/>
        <tag>
          <system
                  value="https://hub.services.digital.health.nz/ns/correlation-id"/>
          <code value="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"/>
        </tag>
      </meta>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Encounter NzTelehealthEncounterExample</b></p><a name="NzTelehealthEncounterExample"> </a><a name="hcNzTelehealthEncounterExample"> </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">Information Source: <a href="https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A">https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A</a></p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-SharedCareEncounter.html">NZ SharedCare Encounter</a></p><p style="margin-bottom: 0px">Tag: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (Details: correlation-id code xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)</p></div><p><b>Shared Care CSC holder</b>: true</p><p><b>Shared Care Accident Related</b>: false</p><p><b>Shared Care Registration Code</b>: enrolled</p><p><b>Encounter Mode Of Arrival</b>: <a href="http://terminology.hl7.org/6.5.0/CodeSystem-v2-0430.html#v2-0430-A">arrivalMode A</a>: Ambulance</p><p><b>identifier</b>: <code>https://standards.digital.health.nz/ns/telehealth-token</code>/TH123456789 (use: secondary, )</p><p><b>status</b>: Finished</p><p><b>class</b>: <a href="http://terminology.hl7.org/6.5.0/CodeSystem-v3-ActCode.html#v3-ActCode-VR">ActCode VR</a>: Virtual</p><p><b>type</b>: <span title="Codes:{http://snomed.info/sct 185317003}">Telephone encounter</span></p><p><b>priority</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/australasian-triage-scale-cs 3}">Category 3</span></p><p><b>subject</b>: Mr Test Patient | Male | 2001-01-01 (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-nhi.html" title="NHI number">NHI</a>/ZZZ0008)</p><h3>Participants</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Period</b></td><td><b>Individual</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-ParticipationType ATND}">attender</span></td><td>2025-01-01 10:00:00+1300 --&gt; 2025-01-01 10:17:00+1300</td><td>Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiProvider.html" title="HPI providers">HPIProvider</a>/AA1234</td></tr></table><p><b>appointment</b>: <a href="Appointment-NzTelehealthAppointmentExample.html">Appointment: identifier = https://standards.digital.health.nz/ns/appointment-identifier#APT123456 (use: official, ); status = fulfilled; reasonCode = Transport problem (finding); start = 2025-01-01 10:00:00+1300; end = 2025-01-01 10:17:00+1300; created = 2025-01-01 09:30:00+1300</a></p><p><b>period</b>: 2025-01-01 10:00:00+1300 --&gt; 2025-01-01 10:17:00+1300</p><h3>Lengths</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Value</b></td><td><b>Unit</b></td><td><b>System</b></td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td>17</td><td>min</td><td><a href="http://terminology.hl7.org/6.5.0/CodeSystem-v3-ucum.html">http://unitsofmeasure.org</a></td><td>min</td></tr></table><p><b>reasonCode</b>: <span title="Codes:{http://snomed.info/sct 266934004}">Transport problem (finding)</span></p><h3>Diagnoses</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Condition</b></td><td><b>Use</b></td></tr><tr><td style="display: none">*</td><td>Identifier: <code>https://standards.digital.health.nz/ns/condition-identifier</code>/viral-infection</td><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/diagnosis-role AD}">Admission diagnosis</span></td></tr></table><h3>Hospitalizations</h3><table class="grid"><tr><td style="display: none">-</td><td><b>AdmitSource</b></td><td><b>DischargeDisposition</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://snomed.info/sct 305956004}">Referral by physician</span></td><td><span title="Codes:{http://snomed.info/sct 306689006}">Discharge to home</span></td></tr></table><blockquote><p><b>location</b></p><p><b>location</b>: Clinic Waiting Room</p><p><b>status</b>: Active</p><p><b>period</b>: 2025-01-01 09:45:00+1300 --&gt; 2025-01-01 10:00:00+1300</p></blockquote><blockquote><p><b>location</b></p><p><b>location</b>: Consulting Room 2</p><p><b>status</b>: Active</p><p><b>period</b>: 2025-01-01 10:00:00+1300 --&gt; 2025-01-01 10:17:00+1300</p></blockquote><p><b>serviceProvider</b>: Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html" title="HPI organizations">HPIOrganization</a>/GZZ999-9</p></div>
      </text>
      <extension
                 url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder">
        <valueBoolean value="true"/>
      </extension>
      <extension
                 url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-accident-related">
        <valueBoolean value="false"/>
      </extension>
      <extension
                 url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code">
        <valueString value="enrolled"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival">
        <valueCoding>
          <system value="http://terminology.hl7.org/CodeSystem/v2-0430"/>
          <code value="A"/>
          <display value="Ambulance"/>
        </valueCoding>
      </extension>
      <identifier>
        <use value="secondary"/>
        <system value="https://standards.digital.health.nz/ns/telehealth-token"/>
        <value value="TH123456789"/>
      </identifier>
      <status value="finished"/>
      <class>
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
        <code value="VR"/>
        <display value="Virtual"/>
      </class>
      <type>
        <coding>
          <system value="http://snomed.info/sct"/>
          <code value="185317003"/>
          <display value="Telephone encounter"/>
        </coding>
      </type>
      <priority>
        <coding>
          <system
                  value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/australasian-triage-scale-cs"/>
          <code value="3"/>
        </coding>
      </priority>
      <subject>
        <type value="Patient"/>
        <identifier>
          <system value="https://standards.digital.health.nz/ns/nhi-id"/>
          <value value="ZZZ0008"/>
        </identifier>
        <display value="Mr Test Patient | Male | 2001-01-01"/>
      </subject>
      <participant>
        <type>
          <coding>
            <system
                    value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/>
            <code value="ATND"/>
            <display value="attender"/>
          </coding>
        </type>
        <period>
          <start value="2025-01-01T10:00:00+13:00"/>
          <end value="2025-01-01T10:17:00+13:00"/>
        </period>
        <individual>
          <identifier>
            <system value="https://standards.digital.health.nz/ns/hpi-person-id"/>
            <value value="AA1234"/>
          </identifier>
        </individual>
      </participant>
      <appointment>🔗
        <reference value="Appointment/NzTelehealthAppointmentExample"/>
      </appointment>
      <period>
        <start value="2025-01-01T10:00:00+13:00"/>
        <end value="2025-01-01T10:17:00+13:00"/>
      </period>
      <length>
        <value value="17"/>
        <unit value="min"/>
        <system value="http://unitsofmeasure.org"/>
        <code value="min"/>
      </length>
      <reasonCode>
        <coding>
          <system value="http://snomed.info/sct"/>
          <code value="266934004"/>
          <display value="Transport problem (finding)"/>
        </coding>
      </reasonCode>
      <diagnosis>
        <condition>
          <identifier>
            <system
                    value="https://standards.digital.health.nz/ns/condition-identifier"/>
            <value value="viral-infection"/>
          </identifier>
        </condition>
        <use>
          <coding>
            <system value="http://terminology.hl7.org/CodeSystem/diagnosis-role"/>
            <code value="AD"/>
            <display value="Admission diagnosis"/>
          </coding>
        </use>
      </diagnosis>
      <hospitalization>
        <admitSource>
          <coding>
            <system value="http://snomed.info/sct"/>
            <code value="305956004"/>
            <display value="Referral by physician"/>
          </coding>
        </admitSource>
        <dischargeDisposition>
          <coding>
            <system value="http://snomed.info/sct"/>
            <code value="306689006"/>
            <display value="Discharge to home"/>
          </coding>
        </dischargeDisposition>
      </hospitalization>
      <location>
        <location>
          <display value="Clinic Waiting Room"/>
        </location>
        <status value="active"/>
        <period>
          <start value="2025-01-01T09:45:00+13:00"/>
          <end value="2025-01-01T10:00:00+13:00"/>
        </period>
      </location>
      <location>
        <location>
          <display value="Consulting Room 2"/>
        </location>
        <status value="active"/>
        <period>
          <start value="2025-01-01T10:00:00+13:00"/>
          <end value="2025-01-01T10:17:00+13:00"/>
        </period>
      </location>
      <serviceProvider>
        <type value="organization"/>
        <identifier>
          <system
                  value="https://standards.digital.health.nz/ns/hpi-organisation-id"/>
          <value value="GZZ999-9"/>
        </identifier>
      </serviceProvider>
    </Encounter>