Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
{
"resourceType" : "Encounter",
"meta" : {
"source" : "https://standards.digital.health.nz/ns/hpi-facility-id/F12345",
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareEncounter"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Encounter NzTelehealthEncounterExample</b></p><a name=\"NzTelehealthEncounterExample\"> </a><a name=\"hcNzTelehealthEncounterExample\"> </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\">Information Source: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&canonical=https://standards.digital.health.nz/ns/hpi-facility-id/F12345\">https://standards.digital.health.nz/ns/hpi-facility-id/F12345</a></p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-SharedCareEncounter.html\">NZ SharedCare Encounter</a></p></div><p><b>CSC Number</b>: <code>https://standards.digital.health.nz/ns/csc-id</code>/123456789\u00a0(use:\u00a0official,\u00a0)</p><p><b>Accident Related</b>: false</p><p><b>Registration Code</b>: enrolled</p><p><b>Encounter Mode Of Arrival</b>: <a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v2-0430.html#v2-0430-A\">arrivalMode A</a>: Ambulance</p><p><b>Triage Category</b>: 3</p><p><b>identifier</b>: <code>https://standards.digital.health.nz/ns/telehealth-token</code>/TH123456789\u00a0(use:\u00a0official,\u00a0)</p><p><b>status</b>: Finished</p><p><b>class</b>: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-v3-ActCode.html#v3-ActCode-VR\">ActCode VR</a>: Virtual</p><p><b>type</b>: <span title=\"Codes:{http://snomed.info/sct 185317003}\">Telephone consultation</span></p><p><b>subject</b>: Mr Test Patient | Male | 2001-01-01 (Identifier: NHI/ZZZ0008)</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:{https://standards.digital.health.nz/ns/participant-type ATND}\">ATND</span></td><td>2025-01-01 10:00:00+1300 --> 2025-01-01 10:17:00+1300</td><td><a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&canonical=http://fhir.org.nz/ig/base/Practitioner/12345\">Practitioner/12345</a></td></tr></table><p><b>appointment</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&canonical=http://fhir.org.nz/ig/base/Appointment/SharedCareAppointmentExample\">Appointment/SharedCareAppointmentExample</a></p><p><b>period</b>: 2025-01-01 10:00:00+1300 --> 2025-01-01 10:17:00+1300</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>17</td><td>min</td><td><a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-v3-ucum.html\">http://unitsofmeasure.org</a></td><td>min</td></tr></table><p><b>reasonCode</b>: <span title=\"Codes:{http://snomed.info/sct 386661006}\">Fever</span></p><h3>Diagnoses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Condition</b></td><td><b>Use</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&canonical=http://fhir.org.nz/ig/base/Condition/viral-infection\">Condition/viral-infection</a></td><td><span title=\"Codes:{http://terminology.hl7.org/CodeSystem/diagnosis-role AD}\">Admission diagnosis</span></td></tr></table><h3>Hospitalizations</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>AdmitSource</b></td><td><b>DischargeDisposition</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://snomed.info/sct 305956004}\">Referral by physician</span></td><td><span title=\"Codes:{http://snomed.info/sct 306689006}\">Discharge to home</span></td></tr></table><blockquote><p><b>location</b></p><p><b>location</b>: Clinic Waiting Room</p><p><b>status</b>: Active</p><p><b>period</b>: 2025-01-01 09:45:00+1300 --> 2025-01-01 10:00:00+1300</p></blockquote><blockquote><p><b>location</b></p><p><b>location</b>: Consulting Room 2</p><p><b>status</b>: Active</p><p><b>period</b>: 2025-01-01 10:00:00+1300 --> 2025-01-01 10:17:00+1300</p></blockquote><p><b>serviceProvider</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&canonical=http://fhir.org.nz/ig/base/Organization/GZZ999-9\">Organization/GZZ999-9</a></p></div>"
},
"extension" : [
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number",
"valueIdentifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/csc-id",
"value" : "123456789"
}
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/accident",
"valueBoolean" : false
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/reg-code",
"valueString" : "enrolled"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival",
"valueCoding" : {
"system" : "http://terminology.hl7.org/CodeSystem/v2-0430",
"code" : "A",
"display" : "Ambulance"
}
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/triage-category",
"valueCode" : "3"
}
],
"identifier" : [
{
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/telehealth-token",
"value" : "TH123456789"
}
],
"status" : "finished",
"class" : {
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "VR",
"display" : "Virtual"
},
"type" : [
{
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "185317003",
"display" : "Telephone consultation"
}
]
}
],
"subject" : {
"type" : "Patient",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZZZ0008"
},
"display" : "Mr Test Patient | Male | 2001-01-01"
},
"participant" : [
{
"type" : [
{
"coding" : [
{
"system" : "https://standards.digital.health.nz/ns/participant-type",
"code" : "ATND"
}
]
}
],
"period" : {
"start" : "2025-01-01T10:00:00+13:00",
"end" : "2025-01-01T10:17:00+13:00"
},
"individual" : {
"reference" : "Practitioner/12345"
}
}
],
"appointment" : [
{
"reference" : "Appointment/SharedCareAppointmentExample"
}
],
"period" : {
"start" : "2025-01-01T10:00:00+13:00",
"end" : "2025-01-01T10:17:00+13:00"
},
"length" : {
"value" : 17,
"unit" : "min",
"system" : "http://unitsofmeasure.org",
"code" : "min"
},
"reasonCode" : [
{
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "386661006",
"display" : "Fever"
}
]
}
],
"diagnosis" : [
{
"condition" : {
"reference" : "Condition/viral-infection"
},
"use" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code" : "AD",
"display" : "Admission diagnosis"
}
]
}
}
],
"hospitalization" : {
"admitSource" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "305956004",
"display" : "Referral by physician"
}
]
},
"dischargeDisposition" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "306689006",
"display" : "Discharge to home"
}
]
}
},
"location" : [
{
"location" : {
"display" : "Clinic Waiting Room"
},
"status" : "active",
"period" : {
"start" : "2025-01-01T09:45:00+13:00",
"end" : "2025-01-01T10:00:00+13:00"
}
},
{
"location" : {
"display" : "Consulting Room 2"
},
"status" : "active",
"period" : {
"start" : "2025-01-01T10:00:00+13:00",
"end" : "2025-01-01T10:17:00+13:00"
}
}
],
"serviceProvider" : {
"reference" : "Organization/GZZ999-9",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
"value" : "GZZ999-9"
}
}
}