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 DHOAppointmentTelehealthDunstanExample</b></p><a name="DHOAppointmentTelehealthDunstanExample"> </a><a name="hcDHOAppointmentTelehealthDunstanExample"> </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>: #dddddddd-eeee-ffff-0000-111111111111</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 (patient at Dunstan outreach clinic)</p><p><b>start</b>: 2025-10-01 02:30:35+0000</p><p><b>end</b>: 2025-10-01 03:00:35+0000</p><p><b>patientInstruction</b>: Please attend the Dunstan outreach clinic at the scheduled time; clinic staff will connect you to the specialist by telehealth.</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="#hcDHOAppointmentTelehealthDunstanExample/DHO-location-new-dunedin-hospital-instance">Location New Dunedin Hospital Outpatients</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="#hcDHOAppointmentTelehealthDunstanExample/DHO-location-dunstan-outreach-instance">Location Dunstan Outreach Clinic</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="DHOAppointmentTelehealthDunstanExample/DHO-location-new-dunedin-hospital-instance"> </a><a name="hcDHOAppointmentTelehealthDunstanExample/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><b>identifier</b>: <code>https://standards.digital.health.nz/ns/dho-area-code</code>/DHO-AREA-201</p><p><b>status</b>: Active</p><p><b>name</b>: New Dunedin Hospital Outpatients</p><p><b>mode</b>: Instance</p><p><b>type</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship internal}">Internal facility</span></p><p><b>address</b>: 201 Great King Street Dunedin 9016 NZ (work)</p><p><b>physicalType</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType physical}">Physical site or facility</span></p><p><b>managingOrganization</b>: Te Whatu Ora - Southern (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html" title="HPI organizations">HPIOrganization</a>/G00001-E)</p><p><b>partOf</b>: New Dunedin Hospital (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html" title="HPI facilities">HPIFacility</a>/F09000-A)</p></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: Location #DHO-location-dunstan-outreach-instance</b></p><a name="DHOAppointmentTelehealthDunstanExample/DHO-location-dunstan-outreach-instance"> </a><a name="hcDHOAppointmentTelehealthDunstanExample/DHO-location-dunstan-outreach-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><b>DHO Outreach vs Fixed site</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationOutreach outreach}">Outreach / mobile location</span></p><p><b>identifier</b>: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html" title="HPI facilities">HPIFacility</a>/F04180-A</p><p><b>status</b>: Active</p><p><b>name</b>: Dunstan Outreach Clinic</p><p><b>mode</b>: Instance</p><p><b>type</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship external}">External facility</span></p><p><b>address</b>: 26 Symes Road Clyde 9330 NZ (work)</p><p><b>physicalType</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType physical}">Physical site or facility</span></p><p><b>managingOrganization</b>: Te Whatu Ora - Southern (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html" title="HPI organizations">HPIOrganization</a>/G00001-E)</p></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-dunstan-outreach-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>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach">
<valueCodeableConcept>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationOutreach"/>
<code value="outreach"/>
<display value="Outreach / mobile location"/>
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<system
value="https://standards.digital.health.nz/ns/hpi-facility-id"/>
<value value="F04180-A"/>
</identifier>
<status value="active"/>
<name value="Dunstan Outreach Clinic"/>
<mode value="instance"/>
<type>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship"/>
<code value="external"/>
</coding>
</type>
<address>
<use value="work"/>
<type value="physical"/>
<line value="26 Symes Road"/>
<city value="Clyde"/>
<postalCode value="9330"/>
<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>
</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>
<value value="#dddddddd-eeee-ffff-0000-111111111111"/>
</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 (patient at Dunstan outreach clinic)"/>
<start value="2025-10-01T02:30:35Z"/>
<end value="2025-10-01T03:00:35Z"/>
<patientInstruction
value="Please attend the Dunstan outreach clinic at the scheduled time; clinic staff will connect you to the specialist by telehealth."/>
<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-dunstan-outreach-instance"/>
</actor>
<required value="required"/>
<status value="accepted"/>
</participant>
</Appointment>