NZ Shared Digital Health Record API
1.0.0 - 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.0 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

## : SearchWithRecordsWithheldExample - XML Representation

Raw xml | Download

    <Bundle xmlns="http://hl7.org/fhir">
      <id value="SearchWithRecordsWithheldExample"/>
      <meta>
        <lastUpdated value="2025-04-29T23:35:29.795Z"/>
      </meta>
      <type value="searchset"/>
      <total value="1"/>
      <link>
        <relation value="self"/>
        <url
             value="https://api.mock.sdhr.digital.health.nz/s2s/Condition?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/Condition/ConditionHypertensionExample"/>
        <resource>
          <Condition>
            <id value="ConditionHypertensionExample"/>
            <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/SDHRCondition"/>
            </meta>
            <text>
              <status value="extensions"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="Condition_ConditionHypertensionExample"> </a><p class="res-header-id"><b>Generated Narrative: Condition ConditionHypertensionExample</b></p><a name="ConditionHypertensionExample"> </a><a name="hcConditionHypertensionExample"> </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-SDHRCondition.html">SDHRCondition</a></p></div><p><b>Long Term Condition Indicator</b>: true</p><p><b>Client Last Updated</b>: 2023-11-26 10:02:45+1300</p><p><b>HNZ SDHR Highlighted</b>: true</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/condition-clinical active}">Active</span></p><p><b>verificationStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-ver-status confirmed}">Confirmed</span></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 38341003}">Hypertension</span></p><p><b>subject</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>onset</b>: 2011-02-05 00:00:00+1300</p><p><b>recordedDate</b>: 2023-11-26 10:02:45+1300</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/99ZZZZ">Dottie McStuffins</a></p><p><b>asserter</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="http://hl7.org.nz/fhir/StructureDefinition/long-term-condition">
              <valueBoolean value="true"/>
            </extension>
            <extension
                       url="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension">
              <valueDateTime value="2023-11-26T10:02:45+13:00"/>
            </extension>
            <extension
                       url="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension">
              <valueBoolean value="true"/>
            </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/condition-clinical"/>
                <code value="active"/>
              </coding>
            </clinicalStatus>
            <verificationStatus>
              <coding>
                <system
                        value="http://terminology.hl7.org/CodeSystem/condition-ver-status"/>
                <code value="confirmed"/>
              </coding>
            </verificationStatus>
            <code>
              <coding>
                <system value="http://snomed.info/sct"/>
                <code value="38341003"/>
                <display value="HT - Hypertension"/>
              </coding>
              <text value="Hypertension"/>
            </code>
            <subject>
              <reference
                         value="https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZKC7284"/>
              <type value="Patient"/>
              <display value="Sage Westbrook"/>
            </subject>
            <onsetDateTime value="2011-02-05T00:00:00+13:00"/>
            <recordedDate value="2023-11-26T10:02:45+13:00"/>
            <recorder>
              <reference
                         value="https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/99ZZZZ"/>
              <type value="Practitioner"/>
              <display value="Dottie McStuffins"/>
            </recorder>
            <asserter>
              <reference
                         value="https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/91ZZXN"/>
              <type value="Practitioner"/>
              <display value="DR Julian Subatoi Bashir"/>
            </asserter>
          </Condition>
        </resource>
        <search>
          <mode value="match"/>
        </search>
      </entry>
      <entry>
        <resource>
          <OperationOutcome>
            <id value="OperationOutcomeRecordsWithheldAtSource"/>
            <text>
              <status value="generated"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="OperationOutcome_OperationOutcomeRecordsWithheldAtSource"> </a><p class="res-header-id"><b>Generated Narrative: OperationOutcome OperationOutcomeRecordsWithheldAtSource</b></p><a name="OperationOutcomeRecordsWithheldAtSource"> </a><a name="hcOperationOutcomeRecordsWithheldAtSource"> </a><h3>Issues</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Severity</b></td><td><b>Code</b></td><td><b>Details</b></td></tr><tr><td style="display: none">*</td><td>Information</td><td>Informational Note</td><td><span title="Codes:{https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-outcome-codes sdhr-records-withheld-at-source}">Patient has withheld records at source. The operation was successful, but some records were not included in the response due to confidentiality settings.</span></td></tr></table></div>
            </text>
            <issue>
              <severity value="information"/>
              <code value="informational"/>
              <details>
                <coding>
                  <system
                          value="https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-outcome-codes"/>
                  <code value="sdhr-records-withheld-at-source"/>
                  <display value="Records withheld at source"/>
                </coding>
                <text
                      value="Patient has withheld records at source. The operation was successful, but some records were not included in the response due to confidentiality settings."/>
              </details>
            </issue>
          </OperationOutcome>
        </resource>
        <search>
          <mode value="outcome"/>
        </search>
      </entry>
    </Bundle>