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
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
<http://hl7.org/fhir/Appointment/DHOAppointmentTelehealthDunstanExample> a fhir:Appointment ;
fhir:nodeRole fhir:treeRoot ;
fhir:Resource.id [ fhir:value "DHOAppointmentTelehealthDunstanExample"] ;
fhir:Resource.meta [
fhir:Meta.versionId [ fhir:value "3" ] ;
fhir:Meta.lastUpdated [ fhir:value "2025-11-11T02:29:24.844Z"^^xsd:dateTime ] ;
fhir:Meta.source [ fhir:value "https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D" ] ;
fhir:Meta.profile [
fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment" ;
fhir:index 0 ;
fhir:link <https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment>
] ;
fhir:Meta.tag [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://hub.services.digital.health.nz/ns/correlation-id" ] ;
fhir:Coding.code [ fhir:value "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ]
]
] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ] ;
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Appointment DHOAppointmentTelehealthDunstanExample</b></p><a name=\"DHOAppointmentTelehealthDunstanExample\"> </a><a name=\"hcDHOAppointmentTelehealthDunstanExample\"> </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: </p></div><p><b>DHO Appointment method</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-appointment-modality-cs telehealth}\">Telehealth</span></p><p><b>identifier</b>: #dddddddd-eeee-ffff-0000-111111111111</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}\">Fracture Clinic</span></p><p><b>description</b>: Telehealth follow-up (patient at Dunstan outreach clinic)</p><p><b>start</b>: 2025-10-01 02:30:35+0000</p><p><b>end</b>: 2025-10-01 03:00:35+0000</p><p><b>patientInstruction</b>: Please attend the Dunstan outreach clinic at the scheduled time; clinic staff will connect you to the specialist by telehealth.</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 (use: official, ))</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 (use: official, ))</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=\"#hcDHOAppointmentTelehealthDunstanExample/DHO-location-new-dunedin-hospital-instance\">Location New Dunedin Hospital Outpatients</a></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=\"#hcDHOAppointmentTelehealthDunstanExample/DHO-location-dunstan-outreach-instance\">Location Dunstan Outreach Clinic</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 #DHO-location-new-dunedin-hospital-instance</b></p><a name=\"DHOAppointmentTelehealthDunstanExample/DHO-location-new-dunedin-hospital-instance\"> </a><a name=\"hcDHOAppointmentTelehealthDunstanExample/DHO-location-new-dunedin-hospital-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\">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-DHOLocation.html\">DHO Location Profile</a></p><p style=\"margin-bottom: 0px\">Tag: </p></div><p><b>identifier</b>: <code>https://standards.digital.health.nz/ns/dho-area-code</code>/DHO-AREA-201</p><p><b>status</b>: Active</p><p><b>name</b>: New Dunedin Hospital Outpatients</p><p><b>mode</b>: Instance</p><p><b>type</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship internal}\">Internal facility</span></p><p><b>address</b>: 201 Great King Street Dunedin 9016 NZ (work)</p><p><b>physicalType</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType physical}\">Physical site or facility</span></p><p><b>managingOrganization</b>: Te Whatu Ora - Southern (Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html\" title=\"HPI organizations\">HPIOrganization</a>/G00001-E)</p><p><b>partOf</b>: New Dunedin Hospital (Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html\" title=\"HPI facilities\">HPIFacility</a>/F09000-A)</p></blockquote><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: Location #DHO-location-dunstan-outreach-instance</b></p><a name=\"DHOAppointmentTelehealthDunstanExample/DHO-location-dunstan-outreach-instance\"> </a><a name=\"hcDHOAppointmentTelehealthDunstanExample/DHO-location-dunstan-outreach-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\">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-DHOLocation.html\">DHO Location Profile</a></p><p style=\"margin-bottom: 0px\">Tag: </p></div><p><b>DHO Outreach vs Fixed site</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationOutreach outreach}\">Outreach / mobile location</span></p><p><b>identifier</b>: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html\" title=\"HPI facilities\">HPIFacility</a>/F04180-A</p><p><b>status</b>: Active</p><p><b>name</b>: Dunstan Outreach Clinic</p><p><b>mode</b>: Instance</p><p><b>type</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship external}\">External facility</span></p><p><b>address</b>: 26 Symes Road Clyde 9330 NZ (work)</p><p><b>physicalType</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType physical}\">Physical site or facility</span></p><p><b>managingOrganization</b>: Te Whatu Ora - Southern (Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html\" title=\"HPI organizations\">HPIOrganization</a>/G00001-E)</p></blockquote></div>"
] ;
fhir:DomainResource.contained [
a fhir:Location ;
fhir:index 0 ;
fhir:Resource.id [ fhir:value "DHO-location-new-dunedin-hospital-instance" ] ;
fhir:Resource.meta [
fhir:Meta.versionId [ fhir:value "1" ] ;
fhir:Meta.lastUpdated [ fhir:value "2025-09-04T09:00:00.000Z"^^xsd:dateTime ] ;
fhir:Meta.source [ fhir:value "https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D" ] ;
fhir:Meta.profile [
fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation" ;
fhir:index 0 ;
fhir:link <https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation>
] ;
fhir:Meta.tag [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://hub.services.digital.health.nz/ns/correlation-id" ] ;
fhir:Coding.code [ fhir:value "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ]
]
] ;
fhir:Location.identifier [
fhir:index 0 ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/dho-area-code" ] ;
fhir:Identifier.value [ fhir:value "DHO-AREA-201" ]
] ;
fhir:Location.status [ fhir:value "active" ] ;
fhir:Location.name [ fhir:value "New Dunedin Hospital Outpatients" ] ;
fhir:Location.mode [ fhir:value "instance" ] ;
fhir:Location.type [
fhir:index 0 ;
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship" ] ;
fhir:Coding.code [ fhir:value "internal" ]
]
] ;
fhir:Location.address [
fhir:Address.use [ fhir:value "work" ] ;
fhir:Address.type [ fhir:value "physical" ] ;
fhir:Address.line [
fhir:value "201 Great King Street" ;
fhir:index 0
] ;
fhir:Address.city [ fhir:value "Dunedin" ] ;
fhir:Address.postalCode [ fhir:value "9016" ] ;
fhir:Address.country [ fhir:value "NZ" ]
] ;
fhir:Location.physicalType [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType" ] ;
fhir:Coding.code [ fhir:value "physical" ]
]
] ;
fhir:Location.managingOrganization [
fhir:Reference.identifier [
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-organisation-id" ] ;
fhir:Identifier.value [ fhir:value "G00001-E" ]
] ;
fhir:Reference.display [ fhir:value "Te Whatu Ora - Southern" ]
] ;
fhir:Location.partOf [
fhir:Reference.identifier [
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-facility-id" ] ;
fhir:Identifier.value [ fhir:value "F09000-A" ]
] ;
fhir:Reference.display [ fhir:value "New Dunedin Hospital" ]
]
], [
a fhir:Location ;
fhir:index 1 ;
fhir:Resource.id [ fhir:value "DHO-location-dunstan-outreach-instance" ] ;
fhir:Resource.meta [
fhir:Meta.versionId [ fhir:value "1" ] ;
fhir:Meta.lastUpdated [ fhir:value "2025-09-04T09:00:00.000Z"^^xsd:dateTime ] ;
fhir:Meta.source [ fhir:value "https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D" ] ;
fhir:Meta.profile [
fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation" ;
fhir:index 0 ;
fhir:link <https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation>
] ;
fhir:Meta.tag [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://hub.services.digital.health.nz/ns/correlation-id" ] ;
fhir:Coding.code [ fhir:value "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ]
]
] ;
fhir:DomainResource.extension [
fhir:index 0 ;
fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach" ] ;
fhir:Extension.valueCodeableConcept [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationOutreach" ] ;
fhir:Coding.code [ fhir:value "outreach" ] ;
fhir:Coding.display [ fhir:value "Outreach / mobile location" ]
]
]
] ;
fhir:Location.identifier [
fhir:index 0 ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-facility-id" ] ;
fhir:Identifier.value [ fhir:value "F04180-A" ]
] ;
fhir:Location.status [ fhir:value "active" ] ;
fhir:Location.name [ fhir:value "Dunstan Outreach Clinic" ] ;
fhir:Location.mode [ fhir:value "instance" ] ;
fhir:Location.type [
fhir:index 0 ;
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationRelationship" ] ;
fhir:Coding.code [ fhir:value "external" ]
]
] ;
fhir:Location.address [
fhir:Address.use [ fhir:value "work" ] ;
fhir:Address.type [ fhir:value "physical" ] ;
fhir:Address.line [
fhir:value "26 Symes Road" ;
fhir:index 0
] ;
fhir:Address.city [ fhir:value "Clyde" ] ;
fhir:Address.postalCode [ fhir:value "9330" ] ;
fhir:Address.country [ fhir:value "NZ" ]
] ;
fhir:Location.physicalType [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/DHOLocationPhysicalType" ] ;
fhir:Coding.code [ fhir:value "physical" ]
]
] ;
fhir:Location.managingOrganization [
fhir:Reference.identifier [
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-organisation-id" ] ;
fhir:Identifier.value [ fhir:value "G00001-E" ]
] ;
fhir:Reference.display [ fhir:value "Te Whatu Ora - Southern" ]
]
] ;
fhir:DomainResource.extension [
fhir:index 0 ;
fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentMethod" ] ;
fhir:Extension.valueCodeableConcept [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-appointment-modality-cs" ] ;
fhir:Coding.code [ fhir:value "telehealth" ] ;
fhir:Coding.display [ fhir:value "Telehealth" ]
]
]
] ;
fhir:Appointment.identifier [
fhir:index 0 ;
fhir:Identifier.value [ fhir:value "#dddddddd-eeee-ffff-0000-111111111111" ]
] ;
fhir:Appointment.status [ fhir:value "booked"] ;
fhir:Appointment.serviceCategory [
fhir:index 0 ;
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "http://nzhts.digital.health.nz/fhir/CodeSystem/nc-health-specialty-codes" ] ;
fhir:Coding.code [ fhir:value "S45" ] ;
fhir:Coding.display [ fhir:value "Orthopaedic Surgery" ]
]
] ;
fhir:Appointment.serviceType [
fhir:index 0 ;
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/dho-health-speciality-cs" ] ;
fhir:Coding.code [ fhir:value "S45B" ] ;
fhir:Coding.display [ fhir:value "Fracture Clinic" ]
]
] ;
fhir:Appointment.description [ fhir:value "Telehealth follow-up (patient at Dunstan outreach clinic)"] ;
fhir:Appointment.start [ fhir:value "2025-10-01T02:30:35Z"^^xsd:dateTime] ;
fhir:Appointment.end [ fhir:value "2025-10-01T03:00:35Z"^^xsd:dateTime] ;
fhir:Appointment.patientInstruction [ fhir:value "Please attend the Dunstan outreach clinic at the scheduled time; clinic staff will connect you to the specialist by telehealth."] ;
fhir:Appointment.participant [
fhir:index 0 ;
fhir:Appointment.participant.actor [
fhir:Reference.identifier [
fhir:Identifier.use [ fhir:value "official" ] ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/nhi-id" ] ;
fhir:Identifier.value [ fhir:value "ZXP7823" ]
] ;
fhir:Reference.display [ fhir:value "Carey Carrington" ]
] ;
fhir:Appointment.participant.required [ fhir:value "required" ] ;
fhir:Appointment.participant.status [ fhir:value "needs-action" ]
], [
fhir:index 1 ;
fhir:Appointment.participant.type [
fhir:index 0 ;
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v3-ParticipationType" ] ;
fhir:Coding.code [ fhir:value "CON" ] ;
fhir:Coding.display [ fhir:value "consultant" ]
]
] ;
fhir:Appointment.participant.actor [
fhir:Reference.identifier [
fhir:Identifier.use [ fhir:value "official" ] ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-person-id" ] ;
fhir:Identifier.value [ fhir:value "99ZZZX" ]
] ;
fhir:Reference.display [ fhir:value "Dr Dotty McStuffins" ]
] ;
fhir:Appointment.participant.required [ fhir:value "required" ] ;
fhir:Appointment.participant.status [ fhir:value "accepted" ]
], [
fhir:index 2 ;
fhir:Appointment.participant.actor [
fhir:Reference.reference [ fhir:value "#DHO-location-new-dunedin-hospital-instance" ]
] ;
fhir:Appointment.participant.required [ fhir:value "required" ] ;
fhir:Appointment.participant.status [ fhir:value "accepted" ]
], [
fhir:index 3 ;
fhir:Appointment.participant.actor [
fhir:Reference.reference [ fhir:value "#DHO-location-dunstan-outreach-instance" ]
] ;
fhir:Appointment.participant.required [ fhir:value "required" ] ;
fhir:Appointment.participant.status [ fhir:value "accepted" ]
] .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/Appointment/DHOAppointmentTelehealthDunstanExample.ttl> a owl:Ontology ;
owl:imports fhir:fhir.ttl ;
owl:versionIRI <http://build.fhir.org/Appointment/DHOAppointmentTelehealthDunstanExample.ttl> .
IG © 2022+ Te Whatu Ora. Package tewhatuora.sharedcare#0.4.5 based on FHIR 4.0.1. Generated 2026-08-11
Links: Table of Contents |
QA Report