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" : "Encounter",
"meta" : {
"versionId" : "1",
"lastUpdated" : "2025-09-04T09:00:00.000Z",
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOutpatientEncounter"
]
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Encounter dho-outpatient-encounter-instance</b></p><a name=\"dho-outpatient-encounter-instance\"> </a><a name=\"hcdho-outpatient-encounter-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\">Profile: <a href=\"StructureDefinition-DHOutpatientEncounter.html\">Dunedin Hospital Outpatient Get Encounter</a></p></div><p><b>status</b>: Arrived</p><p><b>class</b>: <a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-ActCode.html#v3-ActCode-AMB\">ActCode AMB</a>: Ambulatory</p><p><b>serviceType</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/service-type 397}\">Outpatients</span></p><p><b>subject</b>: <a href=\"Patient-CareyCarrington.html\">Carey Carrington</a></p><h3>Participants</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Period</b></td><td><b>Individual</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-ParticipationType CON}\">Consultant</span></td><td>2025-09-03 02:30:35+0000 --> 2025-09-03 03:30:35+0000</td><td>Dr Dottie McStuffins (Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiProvider.html\" title=\"HPI providers\">HPIProvider</a>/99ZZZX\u00a0(use:\u00a0official,\u00a0))</td></tr></table><p><b>period</b>: 2025-09-03 02:30:35+0000 --> (ongoing)</p><h3>Lengths</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Value</b></td><td><b>Unit</b></td><td><b>System</b></td><td><b>Code</b></td></tr><tr><td style=\"display: none\">*</td><td>1</td><td>hour</td><td><a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-ucum.html\">http://unitsofmeasure.org</a></td><td>h</td></tr></table><h3>Diagnoses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Condition</b></td><td><b>Use</b></td><td><b>Rank</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"Condition-ConditionExample.html\">Condition COVID-19</a></td><td><span title=\"Codes:{http://terminology.hl7.org/CodeSystem/diagnosis-role CC}\">Chief Complaint</span></td><td>1</td></tr></table><h3>Locations</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Location</b></td><td><b>Status</b></td><td><b>Period</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"#hcdho-outpatient-encounter-instance/DHOClinicLocation\">Location Dunedin Hospital Outpatients, Clinic K01</a></td><td>Completed</td><td>2025-09-03 02:30:35+0000 --> 2025-09-03 03:30:35+0000</td></tr></table><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: Location #DHOClinicLocation</b></p><a name=\"dho-outpatient-encounter-instance/DHOClinicLocation\"> </a><a name=\"hcdho-outpatient-encounter-instance/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></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"
}
}
],
"status" : "arrived",
"class" : {
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "AMB",
"display" : "Ambulatory"
},
"serviceType" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/service-type",
"code" : "397",
"display" : "Outpatients"
}
],
"text" : "Outpatients"
},
"subject" : {
🔗 "reference" : "Patient/CareyCarrington",
"display" : "Carey Carrington"
},
"participant" : [
{
"type" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "CON",
"display" : "consultant"
}
],
"text" : "Consultant"
}
],
"period" : {
"start" : "2025-09-03T02:30:35Z",
"end" : "2025-09-03T03:30:35Z"
},
"individual" : {
"type" : "Practitioner",
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "99ZZZX"
},
"display" : "Dr Dottie McStuffins"
}
}
],
"period" : {
"start" : "2025-09-03T02:30:35Z"
},
"length" : {
"value" : 1,
"unit" : "hour",
"system" : "http://unitsofmeasure.org",
"code" : "h"
},
"diagnosis" : [
{
"condition" : {
🔗 "reference" : "Condition/ConditionExample"
},
"use" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code" : "CC",
"display" : "Chief complaint"
}
],
"text" : "Chief Complaint"
},
"rank" : 1
}
],
"location" : [
{
"location" : {
"reference" : "#DHOClinicLocation"
},
"status" : "completed",
"period" : {
"start" : "2025-09-03T02:30:35Z",
"end" : "2025-09-03T03:30:35Z"
}
}
]
}