Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.2 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.2 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
{
"resourceType" : "Appointment",
"meta" : {
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOutpatientAppointment"
]
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Appointment DHOutpatientClinicAppointmentExample</b></p><a name=\"DHOutpatientClinicAppointmentExample\"> </a><a name=\"hcDHOutpatientClinicAppointmentExample\"> </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=\"StructureDefinition-DHOutpatientAppointment.html\">Dunedin Hospital Outpatient Appointment Profile</a></p></div><p><b>identifier</b>: #fbdb8d66-1390-22c7-89a6-a9a75d65d3e6</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:\">Fracture Clinic</span></p><p><b>description</b>: DH Fracture Consultant</p><p><b>start</b>: 2025-09-03 02:30:35+0000</p><p><b>end</b>: 2025-09-03 03:30:35+0000</p><p><b>slot</b>: <a href=\"#hcDHOutpatientClinicAppointmentExample/AppointmentSlot\">Slot: status = busy; start = 2025-09-03 02:30:35+0000; end = 2025-09-03 03:30:35+0000</a></p><p><b>patientInstruction</b>: Bring all medications you are currently taking on your admission to hospital.</p><blockquote><p><b>participant</b></p><p><b>actor</b>: <a href=\"Patient-CareyCarrington.html\">Carey Carrington</a></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 ATND}\">attender</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>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=\"#hcDHOutpatientClinicAppointmentExample/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=\"DHOutpatientClinicAppointmentExample/DHOClinicLocation\"> </a><a name=\"hcDHOutpatientClinicAppointmentExample/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>partOf</b>: Dunedin Hospital (Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html\" title=\"HPI facilities\">HPIFacility</a>/4211)</p></blockquote><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: Slot #AppointmentSlot</b></p><a name=\"DHOutpatientClinicAppointmentExample/AppointmentSlot\"> </a><a name=\"hcDHOutpatientClinicAppointmentExample/AppointmentSlot\"> </a><p><b>schedule</b>: <a href=\"#hcDHOutpatientClinicAppointmentExample/ClinicSchedule\">Schedule: identifier = SOFRACONDHZ01</a></p><p><b>status</b>: Busy</p><p><b>start</b>: 2025-09-03 02:30:35+0000</p><p><b>end</b>: 2025-09-03 03:30:35+0000</p></blockquote><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: Schedule #ClinicSchedule</b></p><a name=\"DHOutpatientClinicAppointmentExample/ClinicSchedule\"> </a><a name=\"hcDHOutpatientClinicAppointmentExample/ClinicSchedule\"> </a><p><b>identifier</b>: SOFRACONDHZ01</p><p><b>active</b>: true</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></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",
"partOf" : {
"type" : "Location",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
"value" : "4211"
},
"display" : "Dunedin Hospital"
}
},
{
"resourceType" : "Slot",
"id" : "AppointmentSlot",
"schedule" : {
"reference" : "#ClinicSchedule"
},
"status" : "busy",
"start" : "2025-09-03T02:30:35Z",
"end" : "2025-09-03T03:30:35Z"
},
{
"resourceType" : "Schedule",
"id" : "ClinicSchedule",
"identifier" : [
{
"value" : "SOFRACONDHZ01"
}
],
"active" : true,
"actor" : [
{
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "99ZZZX"
},
"display" : "Dr Dotty McStuffins"
}
]
}
],
"identifier" : [
{
"value" : "#fbdb8d66-1390-22c7-89a6-a9a75d65d3e6"
}
],
"status" : "booked",
"serviceCategory" : [
{
"coding" : [
{
"system" : "http://nzhts.digital.health.nz/fhir/CodeSystem/nc-health-specialty-codes",
"code" : "S45",
"display" : "Orthopaedic Surgery"
}
]
}
],
"serviceType" : [
{
"coding" : [
{
"code" : "S45B",
"display" : "Fracture Clinic"
}
]
}
],
"description" : "DH Fracture Consultant",
"start" : "2025-09-03T02:30:35Z",
"end" : "2025-09-03T03:30:35Z",
"slot" : [
{
"reference" : "#AppointmentSlot"
}
],
"patientInstruction" : "Bring all medications you are currently taking on your admission to hospital.",
"participant" : [
{
"actor" : {
🔗 "reference" : "Patient/CareyCarrington",
"display" : "Carey Carrington"
},
"required" : "required",
"status" : "needs-action"
},
{
"type" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "ATND",
"display" : "attender"
}
]
}
],
"actor" : {
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "99ZZZX"
},
"display" : "Dr Dotty McStuffins"
},
"required" : "required",
"status" : "accepted"
},
{
"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"
}
]
}