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

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

## : DHOutpatientUnstructuredAppointmentExample - JSON Representation

Raw json | Download

    {
      "resourceType" : "Appointment",
      "meta" : {
        "source" : "https://standards.digital.health.nz/ns/hpi-facility-id/F12345",
        "profile" : [
          🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOutpatientAppointment"
        ],
        "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: Appointment DHOutpatientUnstructuredAppointmentExample</b></p><a name=\"DHOutpatientUnstructuredAppointmentExample\"> </a><a name=\"hcDHOutpatientUnstructuredAppointmentExample\"> </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\">https://standards.digital.health.nz/ns/hpi-facility-id/F12345</a></p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-DHOutpatientAppointment.html\">Dunedin Hospital Outpatient Appointment Profile</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>identifier</b>: #fbdb8d66-1390-22c7-89a6-a9a75d65d3e6</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 A01}\">Allied Health and other</span></p><p><b>serviceType</b>: <span title=\"Codes:\">Physiotherapy</span></p><p><b>description</b>: Physiotherapy Appointment</p><p><b>start</b>: 2025-09-03 02:30:35+0000</p><p><b>end</b>: 2025-09-03 03:30:35+0000</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\u00a0(use:\u00a0official,\u00a0))</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\u00a0(use:\u00a0official,\u00a0))</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=\"#hcDHOutpatientUnstructuredAppointmentExample/DHOClinicLocation\">Location Dunedin Hospital Outpatients, Clinic K01</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 #DHOClinicLocation</b></p><a name=\"DHOutpatientUnstructuredAppointmentExample/DHOClinicLocation\"> </a><a name=\"hcDHOutpatientUnstructuredAppointmentExample/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"
          }
        }
      ],
      "identifier" : [
        {
          "value" : "#fbdb8d66-1390-22c7-89a6-a9a75d65d3e6"
        }
      ],
      "status" : "booked",
      "serviceCategory" : [
        {
          "coding" : [
            {
              "system" : "http://nzhts.digital.health.nz/fhir/CodeSystem/nc-health-specialty-codes",
              "code" : "A01",
              "display" : "Allied Health and other"
            }
          ]
        }
      ],
      "serviceType" : [
        {
          "coding" : [
            {
              "code" : "A01B",
              "display" : "Physiotherapy"
            }
          ]
        }
      ],
      "description" : "Physiotherapy Appointment",
      "start" : "2025-09-03T02:30:35Z",
      "end" : "2025-09-03T03:30:35Z",
      "participant" : [
        {
          "actor" : {
            "identifier" : {
              "use" : "official",
              "system" : "https://standards.digital.health.nz/ns/nhi-id",
              "value" : "ZXP7823"
            },
            "display" : "Carey Carrington"
          },
          "required" : "required",
          "status" : "needs-action"
        },
        {
          "type" : [
            {
              "coding" : [
                {
                  "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                  "code" : "CON",
                  "display" : "consultant"
                }
              ]
            }
          ],
          "actor" : {
            "identifier" : {
              "use" : "official",
              "system" : "https://standards.digital.health.nz/ns/hpi-person-id",
              "value" : "99ZZZX"
            },
            "display" : "Dr Dotty McStuffins"
          },
          "required" : "required",
          "status" : "accepted"
        },
        {
          "actor" : {
            "reference" : "#DHOClinicLocation"
          },
          "required" : "required",
          "status" : "accepted"
        }
      ]
    }