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

## : DHOPatientExample - XML Representation

Raw xml | Download

    <Patient xmlns="http://hl7.org/fhir">
      <meta>
        <versionId value="1"/>
        <lastUpdated value="2025-09-04T09:00:00.000Z"/>
        <source
                value="https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D"/>
        <profile
                 value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOPatient"/>
        <tag>
          <system
                  value="https://hub.services.digital.health.nz/ns/correlation-id"/>
          <code value="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"/>
        </tag>
      </meta>
      <text>
        <status value="extensions"/>
        <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/F04066-D">https://standards.digital.health.nz/ns/hpi-facility-id/F04066-D</a></p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-DHOPatient.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 (use: official, ))</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 (use: official, ))</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.

    The 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>
      </text>
      <extension url="http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth">
        <valueCodeableConcept>
          <coding>
            <system value="http://hl7.org/fhir/administrative-gender"/>
            <version value="4.0.1"/>
            <code value="female"/>
          </coding>
        </valueCodeableConcept>
      </extension>
      <extension url="http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity">
        <valueCodeableConcept>
          <coding>
            <system
                    value="https://standards.digital.health.nz/ns/ethnic-group-level-4-code"/>
            <version value="2.0"/>
            <code value="21111"/>
            <display value="Māori"/>
          </coding>
          <text value="Māori"/>
        </valueCodeableConcept>
      </extension>
      <extension url="http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship">
        <extension url="source">
          <valueCodeableConcept>
            <coding>
              <system
                      value="https://standards.digital.health.nz/ns/information-source-code"/>
              <version value="1.0.0"/>
              <code value="BREG"/>
              <display value="Birth Register"/>
            </coding>
            <text value="Birth Register"/>
          </valueCodeableConcept>
        </extension>
        <extension url="status">
          <valueCodeableConcept>
            <coding>
              <system
                      value="https://standards.digital.health.nz/ns/nz-citizenship-status-code"/>
              <version value="1.1.0"/>
              <code value="no"/>
              <display value="No"/>
            </coding>
            <text value="No"/>
          </valueCodeableConcept>
        </extension>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired">
        <valueBoolean value="false"/>
      </extension>
      <identifier>
        <use value="official"/>
        <system value="https://standards.digital.health.nz/ns/nhi-id"/>
        <value value="ZXP7823"/>
      </identifier>
      <active value="true"/>
      <name>
        <use value="usual"/>
        <text value="Miss Carey Mary Carrington"/>
        <family value="Carrington"/>
        <given value="Carey"/>
        <given value="Mary"/>
        <prefix value="Miss"/>
      </name>
      <telecom>
        <system value="phone"/>
        <value value="+64 21 123 4567"/>
        <use value="mobile"/>
        <rank value="1"/>
      </telecom>
      <telecom>
        <system value="email"/>
        <value value="example@mail.com"/>
        <use value="home"/>
        <rank value="2"/>
      </telecom>
      <gender value="female"/>
      <birthDate value="1968-01-27"/>
      <address>
        <extension
                   url="http://hl7.org.nz/fhir/StructureDefinition/domicile-code">
          <valueCodeableConcept>
            <text value="Dunedin Central"/>
          </valueCodeableConcept>
        </extension>
        <extension url="http://hl7.org.nz/fhir/StructureDefinition/suburb">
          <valueString value="Dunedin"/>
        </extension>
        <use value="work"/>
        <type value="postal"/>
        <line value="360 Cumberland Street"/>
        <postalCode value="9016"/>
        <country value="NEW ZEALAND"/>
      </address>
      <address>
        <extension
                   url="http://hl7.org.nz/fhir/StructureDefinition/domicile-code">
          <valueCodeableConcept>
            <coding>
              <system
                      value="https://standards.digital.health.nz/ns/domicile-code"/>
              <code value="2898"/>
              <display value="Maori Hill"/>
            </coding>
            <text value="Maori Hill"/>
          </valueCodeableConcept>
        </extension>
        <extension url="http://hl7.org.nz/fhir/StructureDefinition/suburb">
          <valueString value="Maori Hill"/>
        </extension>
        <use value="home"/>
        <type value="physical"/>
        <line value="481 Highgate"/>
        <postalCode value="9010"/>
        <country value="NEW ZEALAND"/>
      </address>
      <maritalStatus>
        <coding>
          <system value="http://terminology.hl7.org/CodeSystem/v3-MaritalStatus"/>
          <code value="S"/>
          <display value="Never Married"/>
        </coding>
      </maritalStatus>
      <contact>
        <extension
                   url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id">
          <valueCodeableConcept>
            <coding>
              <system
                      value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/cs-patient-contact-role"/>
              <code value="nok"/>
              <display value="Next of Kin"/>
            </coding>
            <text value="Next of Kin"/>
          </valueCodeableConcept>
        </extension>
        <name>
          <text value="John NextOfKin"/>
          <family value="NextOfKin"/>
          <given value="John Test"/>
        </name>
        <telecom>
          <system value="phone"/>
          <value value="+64 27 123 4567"/>
          <use value="mobile"/>
        </telecom>
      </contact>
      <contact>
        <extension
                   url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id">
          <valueCodeableConcept>
            <coding>
              <system
                      value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/cs-patient-contact-role"/>
              <code value="powatt"/>
              <display value="Power of Attorney"/>
            </coding>
            <text value="Power of Attorney"/>
          </valueCodeableConcept>
        </extension>
        <name>
          <text value="Mary PowerOfAttorney"/>
          <family value="PowerOfAttorney"/>
          <given value="Mary"/>
        </name>
        <telecom>
          <system value="phone"/>
          <value value="+64 22 123 4567"/>
          <use value="mobile"/>
        </telecom>
      </contact>
      <generalPractitioner>
        <type value="Practitioner"/>
        <identifier>
          <use value="official"/>
          <system value="https://standards.digital.health.nz/ns/hpi-person-id"/>
          <value value="99ZZFX"/>
        </identifier>
        <display value="Dottie McStuffins"/>
      </generalPractitioner>
    </Patient>