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

## : DHOutpatientExample - JSON Representation

Raw json | Download

    {
      "resourceType" : "Patient",
      "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/DHOutpatient"
        ],
        "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: Patient DHO-outpatient-instance</b></p><a name=\"DHO-outpatient-instance\"> </a><a name=\"hcDHO-outpatient-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\">Profile: <a href=\"StructureDefinition-DHOutpatient.html\">Dunedin Hospital Outpatient Get Patient 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 style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Miss Carey Mary Carrington Female, DoB: 1968-01-27 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZXP7823\u00a0(use:\u00a0official,\u00a0))</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"Record is active\">Active:</td><td>true</td><td style=\"background-color: #f3f5da\" title=\"Known Marital status of Patient\">Marital Status:</td><td colspan=\"3\"><span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-MaritalStatus S}\">Never Married</span></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Ways to contact the Patient\">Contact Detail</td><td colspan=\"3\"><ul><li><a href=\"tel:+64211234567\">+64 21 123 4567</a></li><li><a href=\"mailto:example@mail.com\">example@mail.com</a></li><li>360 Cumberland Street 9016 NEW ZEALAND (work) (NZ Suburb: Dunedin)</li><li>481 Highgate 9010 NEW ZEALAND (home) (NZ Suburb: Maori Hill)</li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Patient contact\">Contact:</td><td colspan=\"3\"><ul><li>John NextOfKin</li><li><a href=\"tel:+64271234567\">+64 27 123 4567</a></li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Patient contact\">Contact:</td><td colspan=\"3\"><ul><li>Mary PowerOfAttorney</li><li><a href=\"tel:+64221234567\">+64 22 123 4567</a></li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Patient Links\">Links:</td><td colspan=\"3\"><ul><li>General Practitioner: Dottie McStuffins (Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiProvider.html\" title=\"HPI providers\">HPIProvider</a>/99ZZFX\u00a0(use:\u00a0official,\u00a0))</li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"A person’s sex at the time of their birth (considered to be immutable).\"><a href=\"http://fhir.org.nz/ig/base/StructureDefinition-sex-at-birth.html\">Sex At Birth</a></td><td colspan=\"3\"><span title=\"Codes:{http://hl7.org/fhir/administrative-gender female}\">Female</span></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Indicates whether an interpreter is required to facilitate communication in a healthcare setting. While this extension is named patient-interpreterRequired for backwards compatibility, it may also be used on RelatedPerson, Practitioner, and Encounter.\"><a href=\"http://hl7.org/fhir/extensions/5.2.0/StructureDefinition-patient-interpreterRequired.html\">Interpreter Required</a></td><td colspan=\"3\">false</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"New Zealand citizenship\">NZ Citizenship:</td><td colspan=\"3\"><ul><li>source: <span title=\"Codes:{https://standards.digital.health.nz/ns/information-source-code BREG}\">Birth Register</span></li><li>status: <span title=\"Codes:{https://standards.digital.health.nz/ns/nz-citizenship-status-code no}\">No</span></li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The ethnic group or groups that a person identifies with or feels they belong to.  Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen.  Ethnicity is self-perceived and a person can belong to more than one group.\n\nThe Stats New Zealand standard can be found [here](http://aria.stats.govt.nz/aria/#ClassificationView:uri=http://stats.govt.nz/cms/ClassificationVersion/YVqOcFHSlguKkT17).\"><a href=\"http://fhir.org.nz/ig/base/StructureDefinition-nz-ethnicity.html\">NZ Ethnicity</a></td><td colspan=\"3\"><span title=\"Codes:{https://standards.digital.health.nz/ns/ethnic-group-level-4-code 21111}\">Māori</span></td></tr></table></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth",
          "valueCodeableConcept" : {
            "coding" : [
              {
                "system" : "http://hl7.org/fhir/administrative-gender",
                "version" : "4.3.0",
                "code" : "female"
              }
            ]
          }
        },
        {
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
          "valueCodeableConcept" : {
            "coding" : [
              {
                "system" : "https://standards.digital.health.nz/ns/ethnic-group-level-4-code",
                "version" : "2.0",
                "code" : "21111",
                "display" : "Māori"
              }
            ],
            "text" : "Māori"
          }
        },
        {
          "extension" : [
            {
              "url" : "source",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "https://standards.digital.health.nz/ns/information-source-code",
                    "version" : "1.0.0",
                    "code" : "BREG",
                    "display" : "Birth Register"
                  }
                ],
                "text" : "Birth Register"
              }
            },
            {
              "url" : "status",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "https://standards.digital.health.nz/ns/nz-citizenship-status-code",
                    "version" : "1.1.0",
                    "code" : "no",
                    "display" : "No"
                  }
                ],
                "text" : "No"
              }
            }
          ],
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired",
          "valueBoolean" : false
        }
      ],
      "identifier" : [
        {
          "use" : "official",
          "system" : "https://standards.digital.health.nz/ns/nhi-id",
          "value" : "ZXP7823"
        }
      ],
      "active" : true,
      "name" : [
        {
          "use" : "usual",
          "text" : "Miss Carey Mary Carrington",
          "family" : "Carrington",
          "given" : [
            "Carey",
            "Mary"
          ],
          "prefix" : [
            "Miss"
          ]
        }
      ],
      "telecom" : [
        {
          "system" : "phone",
          "value" : "+64 21 123 4567",
          "use" : "mobile",
          "rank" : 1
        },
        {
          "system" : "email",
          "value" : "example@mail.com",
          "use" : "home",
          "rank" : 2
        }
      ],
      "gender" : "female",
      "birthDate" : "1968-01-27",
      "address" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
              "valueCodeableConcept" : {
                "text" : "Dunedin Central"
              }
            },
            {
              "url" : "http://hl7.org.nz/fhir/StructureDefinition/suburb",
              "valueString" : "Dunedin"
            }
          ],
          "use" : "work",
          "type" : "postal",
          "line" : [
            "360 Cumberland Street"
          ],
          "postalCode" : "9016",
          "country" : "NEW ZEALAND"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "https://standards.digital.health.nz/ns/domicile-code",
                    "code" : "2898",
                    "display" : "Maori Hill"
                  }
                ],
                "text" : "Maori Hill"
              }
            },
            {
              "url" : "http://hl7.org.nz/fhir/StructureDefinition/suburb",
              "valueString" : "Maori Hill"
            }
          ],
          "use" : "home",
          "type" : "physical",
          "line" : [
            "481 Highgate"
          ],
          "postalCode" : "9010",
          "country" : "NEW ZEALAND"
        }
      ],
      "maritalStatus" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
            "code" : "S",
            "display" : "Never Married"
          }
        ]
      },
      "contact" : [
        {
          "extension" : [
            {
              "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/cs-patient-contact-role",
                    "code" : "nok",
                    "display" : "Next of Kin"
                  }
                ],
                "text" : "Next of Kin"
              }
            }
          ],
          "name" : {
            "text" : "John NextOfKin",
            "family" : "NextOfKin",
            "given" : [
              "John Test"
            ]
          },
          "telecom" : [
            {
              "system" : "phone",
              "value" : "+64 27 123 4567",
              "use" : "mobile"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/cs-patient-contact-role",
                    "code" : "powatt",
                    "display" : "Power of Attorney"
                  }
                ],
                "text" : "Power of Attorney"
              }
            }
          ],
          "name" : {
            "text" : "Mary PowerOfAttorney",
            "family" : "PowerOfAttorney",
            "given" : [
              "Mary"
            ]
          },
          "telecom" : [
            {
              "system" : "phone",
              "value" : "+64 22 123 4567",
              "use" : "mobile"
            }
          ]
        }
      ],
      "generalPractitioner" : [
        {
          "type" : "Practitioner",
          "identifier" : {
            "use" : "official",
            "system" : "https://standards.digital.health.nz/ns/hpi-person-id",
            "value" : "99ZZFX"
          },
          "display" : "Dottie McStuffins"
        }
      ]
    }