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 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\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=\"#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>"
},
"contained" : [
{
"resourceType" : "Location",
"id" : "DHOClinicLocation",
"meta" : {
"profile" : [
🔗 "http://hl7.org.nz/fhir/StructureDefinition/NzLocation"
]
},
"identifier" : [
{
"value" : "4211-K01"
}
],
"name" : "Dunedin Hospital Outpatients, Clinic K01",
"address" : {
"use" : "work",
"type" : "physical",
"line" : [
"350 Cumberland Street",
"Dunedin Central"
],
"city" : "Dunedin",
"postalCode" : "9016",
"country" : "New Zealand"
},
"partOf" : {
"type" : "Location",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nzhis-facility-id",
"value" : "4211"
},
"display" : "Dunedin Hospital"
}
}
],
"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" : "telephone",
"display" : "Telephone"
}
]
}
}
],
"identifier" : [
{
"value" : "#bbbbbbbb-cccc-dddd-eeee-ffffffffffff"
}
],
"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" : "S45B - Fracture Clinic"
}
]
}
],
"description" : "Telephone follow-up",
"start" : "2025-09-17T02:30:35Z",
"end" : "2025-09-17T02:50:35Z",
"patientInstruction" : "We will call you at the scheduled time. Please keep your phone nearby and ensure voicemail is enabled.",
"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" : "#DHOClinicLocation"
},
"required" : "required",
"status" : "accepted"
}
]
}