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" : "Encounter",
"meta" : {
"source" : "https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A",
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OnlineGPEncounter"
],
"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: Encounter NzGpOnlineEncounterExample</b></p><a name=\"NzGpOnlineEncounterExample\"> </a><a name=\"hcNzGpOnlineEncounterExample\"> </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://standards.digital.health.nz/ns/hpi-facility-id/F12345-A\">https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A</a></p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-OnlineGPEncounter.html\">Online GP Encounter</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>Shared Care Diagnosis Code</b>: <span title=\"Codes:{http://snomed.info/sct 195662009}\">Acute viral pharyngitis</span></p><p><b>Shared Care CSC holder</b>: true</p><p><b>Shared Care Registration Code</b>: enrolled</p><p><b>identifier</b>: <code>https://onlinegp-provider-name.co.nz/ns/encounter-identifier</code>/ENC123456789\u00a0(use:\u00a0official,\u00a0)</p><p><b>status</b>: Finished</p><p><b>class</b>: <a href=\"http://terminology.hl7.org/6.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 719410009}\">Video consultation</span></p><p><b>subject</b>: Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-nhi.html\" title=\"NHI number\">NHI</a>/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:{http://snomed.info/sct 224535009}\">Registered nurse (occupation)</span></td><td>2025-01-01 10:00:00+1300 --> 2025-01-01 10:17:00+1300</td><td>Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiProvider.html\" title=\"HPI providers\">HPIProvider</a>/99ZZFX</td></tr></table><p><b>appointment</b>: <a href=\"Appointment-NzTelehealthAppointmentExample.html\">Appointment: identifier = https://standards.digital.health.nz/ns/appointment-identifier#APT123456\u00a0(use:\u00a0official,\u00a0); status = fulfilled; reasonCode = Transport problem (finding); start = 2025-01-01 10:00:00+1300; end = 2025-01-01 10:17:00+1300; created = 2025-01-01 09:30:00+1300</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/6.5.0/CodeSystem-v3-ucum.html\">http://unitsofmeasure.org</a></td><td>min</td></tr></table><h3>Hospitalizations</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>DischargeDisposition</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://snomed.info/sct 182991002}\">Treatment given</span></td></tr></table><p><b>serviceProvider</b>: Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html\" title=\"HPI organizations\">HPIOrganization</a>/GZZ999-9</p></div>"
},
"extension" : [
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "195662009",
"display" : "Acute viral pharyngitis"
}
],
"text" : "Acute viral pharyngitis"
}
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder",
"valueBoolean" : true
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code",
"valueString" : "enrolled"
}
],
"identifier" : [
{
"use" : "official",
"system" : "https://onlinegp-provider-name.co.nz/ns/encounter-identifier",
"value" : "ENC123456789"
}
],
"status" : "finished",
"class" : {
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "VR",
"display" : "virtual"
},
"type" : [
{
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "719410009",
"display" : "Video consultation"
}
]
}
],
"subject" : {
"type" : "Patient",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZZZ0008"
}
},
"participant" : [
{
"type" : [
{
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "224535009",
"display" : "Registered nurse (occupation)"
}
]
}
],
"period" : {
"start" : "2025-01-01T10:00:00+13:00",
"end" : "2025-01-01T10:17:00+13:00"
},
"individual" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "99ZZFX"
}
}
}
],
"appointment" : [
{
🔗 "reference" : "Appointment/NzTelehealthAppointmentExample"
}
],
"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"
},
"hospitalization" : {
"dischargeDisposition" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "182991002",
"display" : "Treatment given"
}
]
}
},
"serviceProvider" : {
"type" : "organization",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
"value" : "GZZ999-9"
}
}
}