Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.3 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : DHOutpatientEncounterUpdateExample - JSON Representation

Raw json | Download

    {
      "resourceType" : "Encounter",
      "meta" : {
        "versionId" : "1",
        "lastUpdated" : "2025-09-04T09:00:00.000Z",
        "source" : "https://standards.digital.health.nz/ns/hpi-facility-id/F12345",
        "profile" : [
          🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOutpatientEncounterUpdate"🔗 ,
          "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOutpatientEncounter"
        ],
        "tag" : [
          {
            "system" : "https://hub.services.digital.health.nz/ns/correlation-id",
            "code" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
          }
        ]
      },
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Encounter dho-outpatient-encounter-update-instance</b></p><a name=\"dho-outpatient-encounter-update-instance\"> </a><a name=\"hcdho-outpatient-encounter-update-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/F12345\">https://standards.digital.health.nz/ns/hpi-facility-id/F12345</a></p><p style=\"margin-bottom: 0px\">Profiles: <a href=\"StructureDefinition-DHOutpatientEncounterUpdate.html\">Dunedin Hospital Outpatient Update Encounter</a>, <a href=\"StructureDefinition-DHOutpatientEncounter.html\">Dunedin Hospital Outpatient Get 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>status</b>: Finished</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>subject</b>: <a href=\"Patient-CareyCarrington.html\">Carey Carrington</a></p><p><b>appointment</b>: <a href=\"Appointment-DHOutpatientClinicAppointmentExample.html\">Appointment: identifier = #fbdb8d66-1390-22c7-89a6-a9a75d65d3e6; status = booked; serviceCategory = Orthopaedic Surgery; serviceType = Fracture Clinic; description = DH Fracture Consultant; start = 2025-09-03 02:30:35+0000; end = 2025-09-03 03:30:35+0000; patientInstruction = Bring all medications you are currently taking on your admission to hospital.</a></p><p><b>period</b>: 2025-09-03 02:30:35+0000 --&gt; 2025-09-03 03:30:35+0000</p><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-update-instance/DHOClinicLocation\">Location Dunedin Hospital Outpatients, Clinic K01</a></td><td>Completed</td><td>2025-09-03 02:30:35+0000 --&gt; 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-update-instance/DHOClinicLocation\"> </a><a name=\"hcdho-outpatient-encounter-update-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" : "finished",
      "class" : {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code" : "AMB",
        "display" : "Ambulatory"
      },
      "subject" : {
        🔗 "reference" : "Patient/CareyCarrington",
        "display" : "Carey Carrington"
      },
      "appointment" : [
        {
          🔗 "reference" : "Appointment/DHOutpatientClinicAppointmentExample"
        }
      ],
      "period" : {
        "start" : "2025-09-03T02:30:35Z",
        "end" : "2025-09-03T03:30:35Z"
      },
      "location" : [
        {
          "location" : {
            "reference" : "#DHOClinicLocation"
          },
          "status" : "completed",
          "period" : {
            "start" : "2025-09-03T02:30:35Z",
            "end" : "2025-09-03T03:30:35Z"
          }
        }
      ]
    }