Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
<Appointment xmlns="http://hl7.org/fhir">
<meta>
<versionId value="3"/>
<lastUpdated value="2025-11-11T02:29:24.844Z"/>
<source
value="https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D"/>
<profile
value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment"/>
<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: Appointment DHOAppointmentTelephoneExample</b></p><a name="DHOAppointmentTelephoneExample"> </a><a name="hcDHOAppointmentTelephoneExample"> </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">version: 3; Last updated: 2025-11-11 02:29:24+0000; </p><p style="margin-bottom: 0px">Information Source: <a href="https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D">https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D</a></p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-DHOAppointment.html">DHO Appointment Profile</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>DHO Appointment method</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-appointment-modality-cs telephone}">Telephone</span></p><p><b>identifier</b>: #bbbbbbbb-cccc-dddd-eeee-ffffffffffff</p><p><b>status</b>: Booked</p><p><b>serviceCategory</b>: <span title="Codes:{http://nzhts.digital.health.nz/fhir/CodeSystem/nc-health-specialty-codes S45}">Orthopaedic Surgery</span></p><p><b>serviceType</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-health-speciality-cs S45B}">S45B - Fracture Clinic</span></p><p><b>description</b>: Telephone follow-up</p><p><b>start</b>: 2025-09-17 02:30:35+0000</p><p><b>end</b>: 2025-09-17 02:50:35+0000</p><p><b>patientInstruction</b>: We will call you at the scheduled time. Please keep your phone nearby and ensure voicemail is enabled.</p><blockquote><p><b>participant</b></p><p><b>actor</b>: Carey Carrington (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-nhi.html" title="NHI number">NHI</a>/ZXP7823 (use: official, ))</p><p><b>required</b>: Required</p><p><b>status</b>: Needs Action</p></blockquote><blockquote><p><b>participant</b></p><p><b>type</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-ParticipationType CON}">consultant</span></p><p><b>actor</b>: Dr Dotty McStuffins (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiProvider.html" title="HPI providers">HPIProvider</a>/99ZZZX (use: official, ))</p><p><b>required</b>: Required</p><p><b>status</b>: Accepted</p></blockquote><blockquote><p><b>participant</b></p><p><b>actor</b>: <a href="#hcDHOAppointmentTelephoneExample/DHOClinicLocation">Location Dunedin Hospital Outpatients, Clinic K01</a></p><p><b>required</b>: Required</p><p><b>status</b>: Accepted</p></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: Location #DHOClinicLocation</b></p><a name="DHOAppointmentTelephoneExample/DHOClinicLocation"> </a><a name="hcDHOAppointmentTelephoneExample/DHOClinicLocation"> </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="http://fhir.org.nz/ig/base/StructureDefinition-NzLocation.html">Location resource for use in NZ</a></p></div><p><b>identifier</b>: 4211-K01</p><p><b>name</b>: Dunedin Hospital Outpatients, Clinic K01</p><p><b>address</b>: 350 Cumberland Street Dunedin Central Dunedin 9016 New Zealand (work)</p><p><b>partOf</b>: Dunedin Hospital (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html" title="HPI facilities">HPIFacility</a>/4211)</p></blockquote></div>
</text>
<contained>
<Location>
<id value="DHOClinicLocation"/>
<meta>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/NzLocation"/>
</meta>
<identifier>
<value value="4211-K01"/>
</identifier>
<name value="Dunedin Hospital Outpatients, Clinic K01"/>
<address>
<use value="work"/>
<type value="physical"/>
<line value="350 Cumberland Street"/>
<line value="Dunedin Central"/>
<city value="Dunedin"/>
<postalCode value="9016"/>
<country value="New Zealand"/>
</address>
<partOf>
<type value="Location"/>
<identifier>
<system
value="https://standards.digital.health.nz/ns/nzhis-facility-id"/>
<value value="4211"/>
</identifier>
<display value="Dunedin Hospital"/>
</partOf>
</Location>
</contained>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod">
<valueCodeableConcept>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-appointment-modality-cs"/>
<code value="telephone"/>
<display value="Telephone"/>
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<value value="#bbbbbbbb-cccc-dddd-eeee-ffffffffffff"/>
</identifier>
<status value="booked"/>
<serviceCategory>
<coding>
<system
value="http://nzhts.digital.health.nz/fhir/CodeSystem/nc-health-specialty-codes"/>
<code value="S45"/>
<display value="Orthopaedic Surgery"/>
</coding>
</serviceCategory>
<serviceType>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-health-speciality-cs"/>
<code value="S45B"/>
<display value="S45B - Fracture Clinic"/>
</coding>
</serviceType>
<description value="Telephone follow-up"/>
<start value="2025-09-17T02:30:35Z"/>
<end value="2025-09-17T02:50:35Z"/>
<patientInstruction
value="We will call you at the scheduled time. Please keep your phone nearby and ensure voicemail is enabled."/>
<participant>
<actor>
<identifier>
<use value="official"/>
<system value="https://standards.digital.health.nz/ns/nhi-id"/>
<value value="ZXP7823"/>
</identifier>
<display value="Carey Carrington"/>
</actor>
<required value="required"/>
<status value="needs-action"/>
</participant>
<participant>
<type>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/>
<code value="CON"/>
<display value="consultant"/>
</coding>
</type>
<actor>
<identifier>
<use value="official"/>
<system value="https://standards.digital.health.nz/ns/hpi-person-id"/>
<value value="99ZZZX"/>
</identifier>
<display value="Dr Dotty McStuffins"/>
</actor>
<required value="required"/>
<status value="accepted"/>
</participant>
<participant>
<actor>
<reference value="#DHOClinicLocation"/>
</actor>
<required value="required"/>
<status value="accepted"/>
</participant>
</Appointment>