NZ Shared Digital Health Record API
1.0.1 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

## : SearchConfidentialRecordsResponseExample - XML Representation

Raw xml | Download

    <Bundle xmlns="http://hl7.org/fhir">
      <id value="SearchConfidentialRecordsResponseExample"/>
      <meta>
        <lastUpdated value="2025-04-29T23:35:29.795Z"/>
        <security>
          <system
                  value="http://terminology.hl7.org/CodeSystem/v3-ObservationValue"/>
          <code value="redacted"/>
          <display value="REDACTED"/>
        </security>
      </meta>
      <type value="searchset"/>
      <total value="2"/>
      <link>
        <relation value="self"/>
        <url
             value="https://api.mock.sdhr.digital.health.nz/s2s/AllergyIntolerance?patient=https%3A%2F%2Fapi.hip.digital.health.nz%2Ffhir%2Fnhi%2Fv1%2FPatient%2FZKC7284"/>
      </link>
      <entry>
        <fullUrl
                 value="https://api.mock.sdhr.digital.health.nz/s2s/AllergyIntolerance/AllergyIntoleranceExample2"/>
        <resource>
          <AllergyIntolerance>
            <id value="AllergyIntoleranceExample2"/>
            <meta>
              <lastUpdated value="2024-01-26T10:03:26+13:00"/>
              <source
                      value="https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F38006-B"/>
              <profile
                       value="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance"/>
            </meta>
            <text>
              <status value="extensions"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="AllergyIntolerance_AllergyIntoleranceExample2"> </a><p class="res-header-id"><b>Generated Narrative: AllergyIntolerance AllergyIntoleranceExample2</b></p><a name="AllergyIntoleranceExample2"> </a><a name="hcAllergyIntoleranceExample2"> </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">Last updated: 2024-01-26 10:03:26+1300; </p><p style="margin-bottom: 0px">Information Source: <a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&amp;canonical=https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F38006-B">https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F38006-B</a></p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-SDHRAllergyIntolerance.html">SDHRAllergyIntolerance</a></p></div><p><b>Client Last Updated</b>: 2024-02-14 11:15:00+1300</p><p><b>identifier</b>: <code>https://fhir.examplepms.co.nz</code>/ec2d6cad-1e19-46ee-accf-dc460a680710 (use: secondary, )</p><p><b>clinicalStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical active}">Active</span></p><p><b>verificationStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/allergyintolerance-verification confirmed}">Confirmed</span></p><p><b>type</b>: Allergy</p><p><b>category</b>: 370540009</p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 227493005}">Cashew nuts</span></p><p><b>patient</b>: <a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&amp;canonical=https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZKC7284">Sage Westbrook</a></p><p><b>recorder</b>: <a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&amp;canonical=https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/91ZZXN">DR Julian Subatoi Bashir</a></p></div>
            </text>
            <extension
                       url="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension">
              <valueDateTime value="2024-02-14T11:15:00+13:00"/>
            </extension>
            <identifier>
              <use value="secondary"/>
              <system value="https://fhir.examplepms.co.nz"/>
              <value value="ec2d6cad-1e19-46ee-accf-dc460a680710"/>
            </identifier>
            <clinicalStatus>
              <coding>
                <system
                        value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical"/>
                <code value="active"/>
                <display value="Active"/>
              </coding>
            </clinicalStatus>
            <verificationStatus>
              <coding>
                <system
                        value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification"/>
                <code value="confirmed"/>
                <display value="Confirmed"/>
              </coding>
            </verificationStatus>
            <type value="allergy"/>
            <category value="370540009"/>
            <code>
              <coding>
                <system value="http://snomed.info/sct"/>
                <code value="227493005"/>
                <display value="Cashew nuts"/>
                <userSelected value="true"/>
              </coding>
            </code>
            <patient>
              <reference
                         value="https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZKC7284"/>
              <type value="Patient"/>
              <display value="Sage Westbrook"/>
            </patient>
            <recorder>
              <reference
                         value="https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/91ZZXN"/>
              <type value="Practitioner"/>
              <display value="DR Julian Subatoi Bashir"/>
            </recorder>
          </AllergyIntolerance>
        </resource>
        <search>
          <mode value="match"/>
        </search>
      </entry>
    </Bundle>