Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.2 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.2 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
<Claim xmlns="http://hl7.org/fhir">
<meta>
<profile
value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaim"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Claim NzTelehealthClaimExample</b></p><a name="NzTelehealthClaimExample"> </a><a name="hcNzTelehealthClaimExample"> </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">Profile: <a href="StructureDefinition-SharedCareClaim.html">NZ SharedCare Claim</a></p></div><p><b>Shared Care Claim Trace Number</b>: <code>https://example.org/fhir/trace-number</code>/7890</p><p><b>identifier</b>: <code>https://standards.digital.health.nz/ns/claim-identifier</code>/C123456 (use: official, )</p><p><b>status</b>: Active</p><p><b>type</b>: <span title="Codes:{https://standards.digital.health.nz/ns/nz-claim-type professional}">professional</span></p><p><b>subType</b>: <span title="Codes:{https://standards.digital.health.nz/ns/nz-claim-subtype online-gp-services}">online-gp-services</span></p><p><b>use</b>: Claim</p><p><b>patient</b>: <a href="Patient/ZZZ0008">Mr Test Patient | Male | 2001-01-01</a></p><p><b>billablePeriod</b>: 2025-01-01 --> 2025-01-01</p><p><b>created</b>: 2025-01-01 00:00:00+1300</p><p><b>insurer</b>: <a href="Organization/GZZ000-1">Organization/GZZ000-1</a></p><p><b>provider</b>: <a href="Organization/GZZ999-9">Organization/GZZ999-9</a></p><p><b>priority</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/processpriority normal}">Normal</span></p><h3>Payees</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Party</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/payeetype provider}">Provider</span></td><td>Identifier: <code>https://standards.digital.health.nz/ns/hsaap-provider-site-id</code>/P012345 (use: official, )</td></tr></table><h3>CareTeams</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Sequence</b></td><td><b>Provider</b></td><td><b>Responsible</b></td><td><b>Role</b></td><td><b>Qualification</b></td></tr><tr><td style="display: none">*</td><td>1</td><td><a href="Practitioner/12345">Practitioner/12345</a></td><td>true</td><td><span title="Codes:{https://standards.digital.health.nz/ns/claim-careteam-role-code primary}">primary</span></td><td><span title="Codes:{https://standards.digital.health.nz/ns/provider-qualification-codes S12345}">S12345</span></td></tr></table><h3>Insurances</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Sequence</b></td><td><b>Focal</b></td><td><b>Coverage</b></td></tr><tr><td style="display: none">*</td><td>1</td><td>true</td><td><a href="Coverage/1234567890">Coverage/1234567890</a></td></tr></table><blockquote><p><b>item</b></p><p><b>Shared Care Patient Copayment</b>: <span title="New Zealand Dollar">$20.00</span> (NZD)</p><p><b>Shared Care Item Tax</b>: <span title="New Zealand Dollar">$75.00</span> (NZD)</p><p><b>sequence</b>: 1</p><p><b>productOrService</b>: <span title="Codes:{https://standards.digital.health.nz/ns/purchase-unit PU1234}">PU1234</span></p><p><b>serviced</b>: 2025-01-01 10:00:00+1300 --> 2025-01-01 10:17:00+1300</p><p><b>location</b>: Example Telehealth Facility (Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html" title="HPI facilities">HPIFacility</a>/F12345)</p><p><b>quantity</b>: 1</p><h3>UnitPrices</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>500</td><td>New Zealand dollar</td></tr></table><h3>Nets</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>500</td><td>New Zealand dollar</td></tr></table><p><b>encounter</b>: <a href="Encounter-NzTelehealthEncounterExample.html">Encounter: extension = https://standards.digital.health.nz/ns/csc-id#123456789 (use: official, ),false,enrolled,Ambulance (arrivalMode#A); identifier = https://standards.digital.health.nz/ns/telehealth-token#TH123456789 (use: official, ); status = finished; class = Virtual (ActCode#VR); type = Telephone consultation; priority = Category 3; period = 2025-01-01 10:00:00+1300 --> 2025-01-01 10:17:00+1300; reasonCode = Fever</a></p></blockquote><h3>Totals</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>500</td><td>New Zealand dollar</td></tr></table></div>
</text>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-trace-number">
<valueIdentifier>
<system value="https://example.org/fhir/trace-number"/>
<value value="7890"/>
</valueIdentifier>
</extension>
<identifier>
<use value="official"/>
<system value="https://standards.digital.health.nz/ns/claim-identifier"/>
<value value="C123456"/>
</identifier>
<status value="active"/>
<type>
<coding>
<system value="https://standards.digital.health.nz/ns/nz-claim-type"/>
<code value="professional"/>
</coding>
</type>
<subType>
<coding>
<system
value="https://standards.digital.health.nz/ns/nz-claim-subtype"/>
<code value="online-gp-services"/>
</coding>
</subType>
<use value="claim"/>
<patient>
<reference value="Patient/ZZZ0008"/>
<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>
<billablePeriod>
<start value="2025-01-01"/>
<end value="2025-01-01"/>
</billablePeriod>
<created value="2025-01-01T00:00:00+13:00"/>
<insurer>
<reference value="Organization/GZZ000-1"/>
<type value="Organization"/>
<identifier>
<system
value="https://standards.digital.health.nz/ns/hpi-organisation-id"/>
<value value="GZZ000-1"/>
</identifier>
</insurer>
<provider>
<reference value="Organization/GZZ999-9"/>
<type value="Organization"/>
<identifier>
<use value="secondary"/>
<system value="https://standards.digital.health.nz/ns/hpi-nzbn"/>
<value value="9876543210123"/>
</identifier>
</provider>
<priority>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/processpriority"/>
<code value="normal"/>
</coding>
</priority>
<payee>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/payeetype"/>
<code value="provider"/>
</coding>
</type>
<party>
<identifier>
<use value="official"/>
<system
value="https://standards.digital.health.nz/ns/hsaap-provider-site-id"/>
<value value="P012345"/>
</identifier>
</party>
</payee>
<careTeam>
<sequence value="1"/>
<provider>
<reference value="Practitioner/12345"/>
</provider>
<responsible value="true"/>
<role>
<coding>
<system
value="https://standards.digital.health.nz/ns/claim-careteam-role-code"/>
<code value="primary"/>
</coding>
</role>
<qualification>
<coding>
<system
value="https://standards.digital.health.nz/ns/provider-qualification-codes"/>
<code value="S12345"/>
</coding>
</qualification>
</careTeam>
<insurance>
<sequence value="1"/>
<focal value="true"/>
<coverage>
<reference value="Coverage/1234567890"/>
</coverage>
</insurance>
<item>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-patient-copayment">
<valueMoney>
<value value="20"/>
<currency value="NZD"/>
</valueMoney>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-item-tax">
<valueMoney>
<value value="75"/>
<currency value="NZD"/>
</valueMoney>
</extension>
<sequence value="1"/>
<productOrService>
<coding>
<system value="https://standards.digital.health.nz/ns/purchase-unit"/>
<code value="PU1234"/>
</coding>
</productOrService>
<servicedPeriod>
<start value="2025-01-01T10:00:00+13:00"/>
<end value="2025-01-01T10:17:00+13:00"/>
</servicedPeriod>
<locationReference>
<type value="Location"/>
<identifier>
<system
value="https://standards.digital.health.nz/ns/hpi-facility-id"/>
<value value="F12345"/>
</identifier>
<display value="Example Telehealth Facility"/>
</locationReference>
<quantity>
<value value="1"/>
</quantity>
<unitPrice>
<value value="500"/>
<currency value="NZD"/>
</unitPrice>
<net>
<value value="500"/>
<currency value="NZD"/>
</net>
<encounter>🔗
<reference value="Encounter/NzTelehealthEncounterExample"/>
</encounter>
</item>
<total>
<value value="500"/>
<currency value="NZD"/>
</total>
</Claim>