Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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 862a3d2d-afad-468c-8afe-d61c11ad76c6</b></p><a name="862a3d2d-afad-468c-8afe-d61c11ad76c6"> </a><a name="hc862a3d2d-afad-468c-8afe-d61c11ad76c6"> </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: </p></div><p><b>DHO Appointment method</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-appointment-modality-cs telehealth}">Telehealth</span></p><p><b>identifier</b>: <code>https://dho.tewhatuora.govt.nz/ns/sipics/appointment-id</code>/7735003</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}">Fracture Clinic</span></p><p><b>description</b>: Telehealth follow-up</p><p><b>start</b>: 2025-09-10 02:30:35+0000</p><p><b>end</b>: 2025-09-10 03:00:35+0000</p><p><b>patientInstruction</b>: Please be available at the scheduled time; ensure your device is charged and you have a stable connection.</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="#hc862a3d2d-afad-468c-8afe-d61c11ad76c6/DHO-location-new-dunedin-hospital-instance">New Dunedin Hospital Outpatients (Internal facility) (https://standards.digital.health.nz/ns/dho-area-code#DHO-AREA-201)</a></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="#hc862a3d2d-afad-468c-8afe-d61c11ad76c6/DHO-location-telehealth-home-instance">Carey Carrington's Residence (Patient home) (https://fhir-ig.digital.health.nz/id/local-patient-home-id#HOME-67890)</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 #DHO-location-new-dunedin-hospital-instance</b></p><a name="862a3d2d-afad-468c-8afe-d61c11ad76c6/DHO-location-new-dunedin-hospital-instance"> </a><a name="hc862a3d2d-afad-468c-8afe-d61c11ad76c6/DHO-location-new-dunedin-hospital-instance"> </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: 1; Last updated: 2025-09-04 09:00:00+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-DHOLocation.html">DHO Location Profile</a></p><p style="margin-bottom: 0px">Tag: </p></div><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;">New Dunedin Hospital Outpatients (Internal facility) (https://standards.digital.health.nz/ns/dho-area-code#DHO-AREA-201)</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="The status of the location">Status:</td><td>Active</td><td style="background-color: #f3f5da" title="Whether this describes a specific location, or a class of locations">Mode:</td><td>Instance</td></tr><tr><td style="background-color: #f3f5da" title="The physical form of the location (e.g. building, room, vehicle, road)">Form:</td><td colspan="3"><span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType physical}">Physical site or facility</span></td></tr><tr><td style="background-color: #f3f5da" title="The type of function performed at the location">Type:</td><td colspan="3"><span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship internal}">Internal facility</span></td></tr><tr><td style="background-color: #f3f5da" title="Physical location">Address:</td><td colspan="3">201 Great King Street Dunedin 9016 NZ (work)</td></tr><tr><td style="background-color: #f3f5da" title="The organization responsible for the provisioning and upkeep of the location">Managed By:</td><td colspan="3">Te Whatu Ora - Southern (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html" title="HPI organizations">HPIOrganization</a>/G00001-E)</td></tr><tr><td style="background-color: #f3f5da" title="Another location this one is physically a part of">Part Of:</td><td colspan="3">New Dunedin Hospital (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html" title="HPI facilities">HPIFacility</a>/F09000-A)</td></tr></table></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: Location #DHO-location-telehealth-home-instance</b></p><a name="862a3d2d-afad-468c-8afe-d61c11ad76c6/DHO-location-telehealth-home-instance"> </a><a name="hc862a3d2d-afad-468c-8afe-d61c11ad76c6/DHO-location-telehealth-home-instance"> </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: 1; Last updated: 2025-09-04 09:00:00+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-DHOLocation.html">DHO Location Profile</a></p><p style="margin-bottom: 0px">Tag: </p></div><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;">Carey Carrington's Residence (Patient home) (https://fhir-ig.digital.health.nz/id/local-patient-home-id#HOME-67890)</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="The status of the location">Status:</td><td>Active</td><td style="background-color: #f3f5da" title="Whether this describes a specific location, or a class of locations">Mode:</td><td>Instance</td></tr><tr><td style="background-color: #f3f5da" title="The physical form of the location (e.g. building, room, vehicle, road)">Form:</td><td colspan="3"><span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType virtual}">Virtual / online / telehealth location</span></td></tr><tr><td style="background-color: #f3f5da" title="The type of function performed at the location">Type:</td><td colspan="3"><span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship patient_home}">Patient home</span></td></tr><tr><td style="background-color: #f3f5da" title="Physical location">Address:</td><td colspan="3">22 Filleul Street Dunedin 9016 NZ (home)</td></tr><tr><td style="background-color: #f3f5da" title="The organization responsible for the provisioning and upkeep of the location">Managed By:</td><td colspan="3">Te Whatu Ora - Southern (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html" title="HPI organizations">HPIOrganization</a>/G00001-E)</td></tr></table></blockquote></div>
</text>
<contained>
<Location>
<id value="DHO-location-new-dunedin-hospital-instance"/>
<meta>
<versionId value="1"/>
<lastUpdated value="2025-09-04T09:00:00.000Z"/>
<source
value="https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D"/>
<profile
value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation"/>
<tag>
<system
value="https://hub.services.digital.health.nz/ns/correlation-id"/>
<code value="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"/>
</tag>
</meta>
<identifier>
<system value="https://standards.digital.health.nz/ns/dho-area-code"/>
<value value="DHO-AREA-201"/>
</identifier>
<status value="active"/>
<name value="New Dunedin Hospital Outpatients"/>
<mode value="instance"/>
<type>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship"/>
<code value="internal"/>
</coding>
</type>
<address>
<use value="work"/>
<type value="physical"/>
<line value="201 Great King Street"/>
<city value="Dunedin"/>
<postalCode value="9016"/>
<country value="NZ"/>
</address>
<physicalType>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType"/>
<code value="physical"/>
</coding>
</physicalType>
<managingOrganization>
<identifier>
<system
value="https://standards.digital.health.nz/ns/hpi-organisation-id"/>
<value value="G00001-E"/>
</identifier>
<display value="Te Whatu Ora - Southern"/>
</managingOrganization>
<partOf>
<identifier>
<system
value="https://standards.digital.health.nz/ns/hpi-facility-id"/>
<value value="F09000-A"/>
</identifier>
<display value="New Dunedin Hospital"/>
</partOf>
</Location>
</contained>
<contained>
<Location>
<id value="DHO-location-telehealth-home-instance"/>
<meta>
<versionId value="1"/>
<lastUpdated value="2025-09-04T09:00:00.000Z"/>
<source
value="https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D"/>
<profile
value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation"/>
<tag>
<system
value="https://hub.services.digital.health.nz/ns/correlation-id"/>
<code value="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"/>
</tag>
</meta>
<identifier>
<system
value="https://fhir-ig.digital.health.nz/id/local-patient-home-id"/>
<value value="HOME-67890"/>
</identifier>
<status value="active"/>
<name value="Carey Carrington's Residence"/>
<mode value="instance"/>
<type>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship"/>
<code value="patient_home"/>
</coding>
</type>
<address>
<use value="home"/>
<line value="22 Filleul Street"/>
<city value="Dunedin"/>
<postalCode value="9016"/>
<country value="NZ"/>
</address>
<physicalType>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType"/>
<code value="virtual"/>
</coding>
</physicalType>
<managingOrganization>
<identifier>
<system
value="https://standards.digital.health.nz/ns/hpi-organisation-id"/>
<value value="G00001-E"/>
</identifier>
<display value="Te Whatu Ora - Southern"/>
</managingOrganization>
</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="telehealth"/>
<display value="Telehealth"/>
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<system value="https://dho.tewhatuora.govt.nz/ns/sipics/appointment-id"/>
<value value="7735003"/>
</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="Fracture Clinic"/>
</coding>
</serviceType>
<description value="Telehealth follow-up"/>
<start value="2025-09-10T02:30:35Z"/>
<end value="2025-09-10T03:00:35Z"/>
<patientInstruction
value="Please be available at the scheduled time; ensure your device is charged and you have a stable connection."/>
<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="#DHO-location-new-dunedin-hospital-instance"/>
</actor>
<required value="required"/>
<status value="accepted"/>
</participant>
<participant>
<actor>
<reference value="#DHO-location-telehealth-home-instance"/>
</actor>
<required value="required"/>
<status value="accepted"/>
</participant>
</Appointment>