Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
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
<Claim xmlns="http://hl7.org/fhir">
<meta>
<source
value="https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A"/>
<profile
value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyClaim"/>
<tag>
<system
value="https://hub.services.digital.health.nz/ns/correlation-id"/>
<code value="123e4567-e89b-12d3-a456-426614174000"/>
</tag>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Claim NzPharmacyClaimExample2</b></p><a name="NzPharmacyClaimExample2"> </a><a name="hcNzPharmacyClaimExample2"> </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/FZZ111-A">https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A</a></p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-NzPharmacyClaim.html">NZ Pharmacy Claim</a></p><p style="margin-bottom: 0px">Tag: 123e4567-e89b-12d3-a456-426614174000 (Details: correlation-id code 123e4567-e89b-12d3-a456-426614174000)</p></div><p><b>Claimant Number</b>: AG12345</p><p><b>Patient Cohort</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/pharmacy-claim-patient-cohort-codes CRC}">Community Residential Care</span></p><p><b>Originating Claimant Number</b>: AG54321</p><p><b>identifier</b>: <code>https://provider-org-name.co.nz/ns/claim-identifier</code>/C123456 (use: official, )</p><p><b>status</b>: Active</p><p><b>type</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-type pharmacy}">pharmacy</span></p><p><b>subType</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype ICPSA}">ICPSA</span></p><p><b>use</b>: Claim</p><p><b>patient</b>: Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-nhi.html" title="NHI number">NHI</a>/ZZZ0008</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>enterer</b>: Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiProvider.html" title="HPI providers">HPIProvider</a>/12345</p><p><b>provider</b>: Identifier: <a href="http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html" title="HPI organizations">HPIOrganization</a>/GZZ999-9 (use: official, )</p><p><b>priority</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/processpriority normal}">Normal</span></p><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>false</td><td>Not applicable</td></tr></table><blockquote><p><b>item</b></p><p><b>Item Request</b>: Identifier: <code>https://provider-org-name.co.nz/ns/scriptno-local</code>/RX123456-01</p><p><b>Transaction Category</b>: <span title="Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-pharmacy-transaction-category I}">Invoice</span></p><p><b>Extended Supply Flag</b>: false</p><p><b>Patient Flag</b>: true</p><p><b>Prescriber Flag</b>: false</p><p><b>Prescription Flag</b>: true</p><p><b>Dose Flag</b>: false</p><p><b>Group ID</b>: GRP001</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 00:00:00+1300 --> 2025-01-01 23:59:59+1300</p><blockquote><p><b>detail</b></p><p><b>Balance Owing</b>: 0</p><p><b>Wastage Quantity</b>: 5 Tablets</p><p><b>CBS Subsidy</b>: <span title="New Zealand Dollar">$10.00</span> (NZD)</p><p><b>CBS Pack Size</b>: 30 Tablets</p><p><b>sequence</b>: 1</p><p><b>productOrService</b>: <span title="Codes:{https://standards.digital.health.nz/ns/pharmacode 123456}, {https://standards.digital.health.nz/ns/nzulm NZULM789}">123456</span></p><p><b>quantity</b>: 180 Tablets</p><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></blockquote></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/claimant-number">
<valueString value="AG12345"/>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-cohort">
<valueCodeableConcept>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/pharmacy-claim-patient-cohort-codes"/>
<code value="CRC"/>
</coding>
</valueCodeableConcept>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/originating-claimant-number">
<valueString value="AG54321"/>
</extension>
<identifier>
<use value="official"/>
<system value="https://provider-org-name.co.nz/ns/claim-identifier"/>
<value value="C123456"/>
</identifier>
<status value="active"/>
<type>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-type"/>
<code value="pharmacy"/>
</coding>
</type>
<subType>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype"/>
<code value="ICPSA"/>
</coding>
</subType>
<use value="claim"/>
<patient>
<type value="Patient"/>
<identifier>
<system value="https://standards.digital.health.nz/ns/nhi-id"/>
<value value="ZZZ0008"/>
</identifier>
</patient>
<billablePeriod>
<start value="2025-01-01"/>
<end value="2025-01-01"/>
</billablePeriod>
<created value="2025-01-01T00:00:00+13:00"/>
<enterer>
<type value="Practitioner"/>
<identifier>
<system value="https://standards.digital.health.nz/ns/hpi-person-id"/>
<value value="12345"/>
</identifier>
</enterer>
<provider>
<type value="Organization"/>
<identifier>
<use value="official"/>
<system
value="https://standards.digital.health.nz/ns/hpi-organisation-id"/>
<value value="GZZ999-9"/>
</identifier>
</provider>
<priority>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/processpriority"/>
<code value="normal"/>
</coding>
</priority>
<insurance>
<sequence value="1"/>
<focal value="false"/>
<coverage>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="not-applicable"/>
</extension>
<display value="Not applicable"/>
</coverage>
</insurance>
<item>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/item-request">
<valueReference>
<type value="MedicationDispense"/>
<identifier>
<system value="https://provider-org-name.co.nz/ns/scriptno-local"/>
<value value="RX123456-01"/>
</identifier>
</valueReference>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/transaction-category">
<valueCodeableConcept>
<coding>
<system
value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-pharmacy-transaction-category"/>
<code value="I"/>
</coding>
</valueCodeableConcept>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/extended-supply-flag">
<valueBoolean value="false"/>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-flag">
<valueBoolean value="true"/>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/prescriber-flag">
<valueBoolean value="false"/>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/prescription-flag">
<valueBoolean value="true"/>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dose-flag">
<valueBoolean value="false"/>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/group-id">
<valueString value="GRP001"/>
</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-01T00:00:00+13:00"/>
<end value="2025-01-01T23:59:59+13:00"/>
</servicedPeriod>
<detail>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hsaap-balance-owing">
<valueString value="0"/>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/wastageQuantity">
<valueQuantity>
<value value="5"/>
<unit value="Tablets"/>
</valueQuantity>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cbsSubsidy">
<valueMoney>
<value value="10"/>
<currency value="NZD"/>
</valueMoney>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cbsPackSize">
<valueQuantity>
<value value="30"/>
<unit value="Tablets"/>
</valueQuantity>
</extension>
<sequence value="1"/>
<productOrService>
<coding>
<system value="https://standards.digital.health.nz/ns/pharmacode"/>
<code value="123456"/>
</coding>
<coding>
<system value="https://standards.digital.health.nz/ns/nzulm"/>
<code value="NZULM789"/>
</coding>
</productOrService>
<quantity>
<value value="180"/>
<unit value="Tablets"/>
</quantity>
<net>
<value value="500"/>
<currency value="NZD"/>
</net>
</detail>
</item>
<total>
<value value="500"/>
<currency value="NZD"/>
</total>
</Claim>