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
{
"resourceType" : "Appointment",
"meta" : {
"versionId" : "3",
"lastUpdated" : "2025-11-11T02:29:24.844Z",
"source" : "https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D",
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment"
],
"tag" : [
{
"system" : "https://hub.services.digital.health.nz/ns/correlation-id",
"code" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
},
"text" : {
"status" : "extensions",
"div" : "<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\u00a0(use:\u00a0official,\u00a0))</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\u00a0(use:\u00a0official,\u00a0))</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>"
},
"contained" : [
{
"resourceType" : "Location",
"id" : "DHO-location-new-dunedin-hospital-instance",
"meta" : {
"versionId" : "1",
"lastUpdated" : "2025-09-04T09:00:00.000Z",
"source" : "https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D",
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation"
],
"tag" : [
{
"system" : "https://hub.services.digital.health.nz/ns/correlation-id",
"code" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
},
"identifier" : [
{
"system" : "https://standards.digital.health.nz/ns/dho-area-code",
"value" : "DHO-AREA-201"
}
],
"status" : "active",
"name" : "New Dunedin Hospital Outpatients",
"mode" : "instance",
"type" : [
{
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship",
"code" : "internal"
}
]
}
],
"address" : {
"use" : "work",
"type" : "physical",
"line" : [
"201 Great King Street"
],
"city" : "Dunedin",
"postalCode" : "9016",
"country" : "NZ"
},
"physicalType" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType",
"code" : "physical"
}
]
},
"managingOrganization" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
"value" : "G00001-E"
},
"display" : "Te Whatu Ora - Southern"
},
"partOf" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
"value" : "F09000-A"
},
"display" : "New Dunedin Hospital"
}
},
{
"resourceType" : "Location",
"id" : "DHO-location-dunstan-outreach-instance",
"meta" : {
"versionId" : "1",
"lastUpdated" : "2025-09-04T09:00:00.000Z",
"source" : "https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D",
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation"
],
"tag" : [
{
"system" : "https://hub.services.digital.health.nz/ns/correlation-id",
"code" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
},
"extension" : [
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationOutreach",
"code" : "outreach",
"display" : "Outreach / mobile location"
}
]
}
}
],
"identifier" : [
{
"system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
"value" : "F04180-A"
}
],
"status" : "active",
"name" : "Dunstan Outreach Clinic",
"mode" : "instance",
"type" : [
{
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship",
"code" : "external"
}
]
}
],
"address" : {
"use" : "work",
"type" : "physical",
"line" : [
"26 Symes Road"
],
"city" : "Clyde",
"postalCode" : "9330",
"country" : "NZ"
},
"physicalType" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType",
"code" : "physical"
}
]
},
"managingOrganization" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
"value" : "G00001-E"
},
"display" : "Te Whatu Ora - Southern"
}
}
],
"extension" : [
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-appointment-modality-cs",
"code" : "telehealth",
"display" : "Telehealth"
}
]
}
}
],
"identifier" : [
{
"value" : "#dddddddd-eeee-ffff-0000-111111111111"
}
],
"status" : "booked",
"serviceCategory" : [
{
"coding" : [
{
"system" : "http://nzhts.digital.health.nz/fhir/CodeSystem/nc-health-specialty-codes",
"code" : "S45",
"display" : "Orthopaedic Surgery"
}
]
}
],
"serviceType" : [
{
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-health-speciality-cs",
"code" : "S45B",
"display" : "Fracture Clinic"
}
]
}
],
"description" : "Telehealth follow-up (patient at Dunstan outreach clinic)",
"start" : "2025-10-01T02:30:35Z",
"end" : "2025-10-01T03:00:35Z",
"patientInstruction" : "Please attend the Dunstan outreach clinic at the scheduled time; clinic staff will connect you to the specialist by telehealth.",
"participant" : [
{
"actor" : {
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZXP7823"
},
"display" : "Carey Carrington"
},
"required" : "required",
"status" : "needs-action"
},
{
"type" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "CON",
"display" : "consultant"
}
]
}
],
"actor" : {
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "99ZZZX"
},
"display" : "Dr Dotty McStuffins"
},
"required" : "required",
"status" : "accepted"
},
{
"actor" : {
"reference" : "#DHO-location-new-dunedin-hospital-instance"
},
"required" : "required",
"status" : "accepted"
},
{
"actor" : {
"reference" : "#DHO-location-dunstan-outreach-instance"
},
"required" : "required",
"status" : "accepted"
}
]
}