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

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

Example Appointment: DHOAppointmentTelehealthExample

version: 3; Last updated: 2025-11-11 02:29:24+0000;

Information Source: https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D

Profile: DHO Appointment Profile

Tag:

DHO Appointment method: Telehealth

identifier: #aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

status: Booked

serviceCategory: Orthopaedic Surgery

serviceType: Fracture Clinic

description: Telehealth follow-up

start: 2025-09-10 02:30:35+0000

end: 2025-09-10 03:00:35+0000

patientInstruction: Please be available at the scheduled time; ensure your device is charged and you have a stable connection.

participant

actor: Carey Carrington (Identifier: NHI/ZXP7823 (use: official, ))

required: Required

status: Needs Action

participant

type: consultant

actor: Dr Dotty McStuffins (Identifier: HPIProvider/99ZZZX (use: official, ))

required: Required

status: Accepted

participant

actor: Location New Dunedin Hospital Outpatients

required: Required

status: Accepted

participant

actor: Location Carey Carrington's Residence

required: Required

status: Accepted


Generated Narrative: Location #DHO-location-new-dunedin-hospital-instance

version: 1; Last updated: 2025-09-04 09:00:00+0000;

Information Source: https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D

Profile: DHO Location Profile

Tag:

identifier: https://standards.digital.health.nz/ns/dho-area-code/DHO-AREA-201

status: Active

name: New Dunedin Hospital Outpatients

mode: Instance

type: Internal facility

address: 201 Great King Street Dunedin 9016 NZ (work)

physicalType: Physical site or facility

managingOrganization: Te Whatu Ora - Southern (Identifier: HPIOrganization/G00001-E)

partOf: New Dunedin Hospital (Identifier: HPIFacility/F09000-A)


Generated Narrative: Location #DHO-location-telehealth-home-instance

version: 1; Last updated: 2025-09-04 09:00:00+0000;

Information Source: https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D

Profile: DHO Location Profile

Tag:

identifier: https://fhir-ig.digital.health.nz/id/local-patient-home-id/HOME-67890

status: Active

name: Carey Carrington's Residence

mode: Instance

type: Patient home

address: 22 Filleul Street Dunedin 9016 NZ (home)

physicalType: Virtual / online / telehealth location

managingOrganization: Te Whatu Ora - Southern (Identifier: HPIOrganization/G00001-E)