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

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

## : NZ Telehealth Claim Response Example - XML Representation

Raw xml | Download

    <ClaimResponse xmlns="http://hl7.org/fhir">
      <meta>
        <source
                value="https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A"/>
        <profile
                 value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaimResponse"/>
        <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: ClaimResponse NzTelehealthClaimResponseExample</b></p><a name="NzTelehealthClaimResponseExample"> </a><a name="hcNzTelehealthClaimResponseExample"> </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-A">https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A</a></p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-SharedCareClaimResponse.html">NZ SharedCare Claim Response</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>: <code>https://standards.digital.health.nz/ns/claim-response-identifier</code>/CR12345 (use: official, )</p><p><b>status</b>: Active</p><p><b>type</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/claim-type professional}">Professional</span></p><p><b>subType</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype-cs telehealth}">Telehealth</span></p><p><b>use</b>: Claim</p><p><b>patient</b>: Mr Test Patient | Male | 2001-01-01 (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-nhi.html" title="NHI number">NHI</a>/ZZZ0008)</p><p><b>created</b>: 2025-01-01 00:00:00+0000</p><p><b>insurer</b>: Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html" title="HPI organizations">HPIOrganization</a>/n/a</p><p><b>request</b>: <a href="Claim-NzTelehealthClaimExample.html">Claim: extension = AGRS-202sdfg4-00121,https://example.org/fhir/trace-number#7890; identifier = https://standards.digital.health.nz/ns/claim-identifier#C123456 (use: official, ); status = active; type = Professional; subType = Telehealth; use = claim; billablePeriod = 2025-01-01 --&gt; 2025-01-01; created = 2025-01-01 00:00:00+1300; priority = Normal</a></p><p><b>outcome</b>: Processing Complete</p><blockquote><p><b>item</b></p><p><b>Shared Care Product Or Service</b>: <span title="Codes:{https://standards.digital.health.nz/ns/purchase-unit PU1234}">PU1234</span></p><p><b>itemSequence</b>: 1</p><blockquote><p><b>adjudication</b></p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/adjudication benefit}">Benefit Amount</span></p><p><b>reason</b>: <span title="Codes:{https://standards.digital.health.nz/ns/adjudication-reason-code ar1234}">ar1234</span></p><h3>Amounts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Value</b></td><td><b>Currency</b></td></tr><tr><td style="display: none">*</td><td>100</td><td>New Zealand dollar</td></tr></table><p><b>value</b>: 1</p></blockquote></blockquote><blockquote><p><b>total</b></p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/adjudication benefit}">Benefit Amount</span></p><h3>Amounts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Value</b></td><td><b>Currency</b></td></tr><tr><td style="display: none">*</td><td>100</td><td>New Zealand dollar</td></tr></table></blockquote><blockquote><p><b>payment</b></p><p><b>type</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/ex-paymenttype complete}">Complete</span></p><p><b>date</b>: 2025-01-01</p><h3>Amounts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Value</b></td><td><b>Currency</b></td></tr><tr><td style="display: none">*</td><td>100</td><td>New Zealand dollar</td></tr></table></blockquote></div>
      </text>
      <identifier>
        <use value="official"/>
        <system
                value="https://standards.digital.health.nz/ns/claim-response-identifier"/>
        <value value="CR12345"/>
      </identifier>
      <status value="active"/>
      <type>
        <coding>
          <system value="http://terminology.hl7.org/CodeSystem/claim-type"/>
          <code value="professional"/>
        </coding>
      </type>
      <subType>
        <coding>
          <system
                  value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype-cs"/>
          <code value="telehealth"/>
        </coding>
      </subType>
      <use value="claim"/>
      <patient>
        <type value="Patient"/>
        <identifier>
          <system value="https://standards.digital.health.nz/ns/nhi-id"/>
          <value value="ZZZ0008"/>
        </identifier>
        <display value="Mr Test Patient | Male | 2001-01-01"/>
      </patient>
      <created value="2025-01-01T00:00:00-00:00"/>
      <insurer>
        <type value="Organization"/>
        <identifier>
          <system
                  value="https://standards.digital.health.nz/ns/hpi-organisation-id"/>
          <value value="n/a"/>
        </identifier>
      </insurer>
      <request>🔗
        <reference value="Claim/NzTelehealthClaimExample"/>
      </request>
      <outcome value="complete"/>
      <item>
        <extension
                   url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-product-or-service">
          <valueCodeableConcept>
            <coding>
              <system
                      value="https://standards.digital.health.nz/ns/purchase-unit"/>
              <code value="PU1234"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <itemSequence value="1"/>
        <adjudication>
          <category>
            <coding>
              <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
              <code value="benefit"/>
            </coding>
          </category>
          <reason>
            <coding>
              <system
                      value="https://standards.digital.health.nz/ns/adjudication-reason-code"/>
              <code value="ar1234"/>
            </coding>
          </reason>
          <amount>
            <value value="100"/>
            <currency value="NZD"/>
          </amount>
          <value value="1"/>
        </adjudication>
      </item>
      <total>
        <category>
          <coding>
            <system value="http://terminology.hl7.org/CodeSystem/adjudication"/>
            <code value="benefit"/>
          </coding>
        </category>
        <amount>
          <value value="100"/>
          <currency value="NZD"/>
        </amount>
      </total>
      <payment>
        <type>
          <coding>
            <system value="http://terminology.hl7.org/CodeSystem/ex-paymenttype"/>
            <code value="complete"/>
          </coding>
        </type>
        <date value="2025-01-01"/>
        <amount>
          <value value="100"/>
          <currency value="NZD"/>
        </amount>
      </payment>
    </ClaimResponse>