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
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:Claim ;
fhir:nodeRole fhir:treeRoot ;
fhir:meta [
fhir:source [ fhir:v "https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A"^^xsd:anyURI ] ;
( fhir:profile [
fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyClaim"^^xsd:anyURI ;
fhir:link <https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyClaim> ] ) ;
( fhir:tag [
fhir:system [ fhir:v "https://hub.services.digital.health.nz/ns/correlation-id"^^xsd:anyURI ] ;
fhir:code [ fhir:v "123e4567-e89b-12d3-a456-426614174000" ] ] )
] ; #
fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div "<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>"^^rdf:XMLLiteral
] ; #
fhir:extension ( [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/claimant-number"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "AG12345" ]
] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-cohort"^^xsd:anyURI ] ;
fhir:value [
a fhir:CodeableConcept ;
( fhir:coding [
fhir:system [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/pharmacy-claim-patient-cohort-codes"^^xsd:anyURI ] ;
fhir:code [ fhir:v "CRC" ] ] ) ]
] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/originating-claimant-number"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "AG54321" ]
] ) ; #
fhir:identifier ( [
fhir:use [ fhir:v "official" ] ;
fhir:system [ fhir:v "https://provider-org-name.co.nz/ns/claim-identifier"^^xsd:anyURI ] ;
fhir:value [ fhir:v "C123456" ]
] ) ; #
fhir:status [ fhir:v "active"] ; #
fhir:type [
( fhir:coding [
fhir:system [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-type"^^xsd:anyURI ] ;
fhir:code [ fhir:v "pharmacy" ] ] )
] ; #
fhir:subType [
( fhir:coding [
fhir:system [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype"^^xsd:anyURI ] ;
fhir:code [ fhir:v "ICPSA" ] ] )
] ; #
fhir:use [ fhir:v "claim"] ; #
fhir:patient [
fhir:type [ fhir:v "Patient"^^xsd:anyURI ] ;
fhir:identifier [
fhir:system [ fhir:v "https://standards.digital.health.nz/ns/nhi-id"^^xsd:anyURI ] ;
fhir:value [ fhir:v "ZZZ0008" ] ]
] ; #
fhir:billablePeriod [
fhir:start [ fhir:v "2025-01-01"^^xsd:date ] ;
fhir:end [ fhir:v "2025-01-01"^^xsd:date ]
] ; #
fhir:created [ fhir:v "2025-01-01T00:00:00+13:00"^^xsd:dateTime] ; #
fhir:enterer [
fhir:type [ fhir:v "Practitioner"^^xsd:anyURI ] ;
fhir:identifier [
fhir:system [ fhir:v "https://standards.digital.health.nz/ns/hpi-person-id"^^xsd:anyURI ] ;
fhir:value [ fhir:v "12345" ] ]
] ; #
fhir:provider [
fhir:type [ fhir:v "Organization"^^xsd:anyURI ] ;
fhir:identifier [
fhir:use [ fhir:v "official" ] ;
fhir:system [ fhir:v "https://standards.digital.health.nz/ns/hpi-organisation-id"^^xsd:anyURI ] ;
fhir:value [ fhir:v "GZZ999-9" ] ]
] ; #
fhir:priority [
( fhir:coding [
fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/processpriority"^^xsd:anyURI ] ;
fhir:code [ fhir:v "normal" ] ] )
] ; #
fhir:insurance ( [
fhir:sequence [ fhir:v "1"^^xsd:positiveInteger ] ;
fhir:focal [ fhir:v false ] ;
fhir:coverage [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/data-absent-reason"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "not-applicable" ] ] ) ;
fhir:display [ fhir:v "Not applicable" ] ]
] ) ; #
fhir:item ( [
( fhir:extension [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/item-request"^^xsd:anyURI ] ;
fhir:value [
a fhir:Reference ;
fhir:type [ fhir:v "MedicationDispense"^^xsd:anyURI ] ;
fhir:identifier [
fhir:system [ fhir:v "https://provider-org-name.co.nz/ns/scriptno-local"^^xsd:anyURI ] ;
fhir:value [ fhir:v "RX123456-01" ] ] ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/transaction-category"^^xsd:anyURI ] ;
fhir:value [
a fhir:CodeableConcept ;
( fhir:coding [
fhir:system [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-pharmacy-transaction-category"^^xsd:anyURI ] ;
fhir:code [ fhir:v "I" ] ] ) ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/extended-supply-flag"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v false ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-flag"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v true ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/prescriber-flag"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v false ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/prescription-flag"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v true ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dose-flag"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v false ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/group-id"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "GRP001" ] ] ) ;
fhir:sequence [ fhir:v "1"^^xsd:positiveInteger ] ;
fhir:productOrService [
( fhir:coding [
fhir:system [ fhir:v "https://standards.digital.health.nz/ns/purchase-unit"^^xsd:anyURI ] ;
fhir:code [ fhir:v "PU1234" ] ] ) ] ;
fhir:serviced [
a fhir:Period ;
fhir:start [ fhir:v "2025-01-01T00:00:00+13:00"^^xsd:dateTime ] ;
fhir:end [ fhir:v "2025-01-01T23:59:59+13:00"^^xsd:dateTime ] ] ;
( fhir:detail [
( fhir:extension [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hsaap-balance-owing"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "0" ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/wastageQuantity"^^xsd:anyURI ] ;
fhir:value [
a fhir:Quantity ;
fhir:value [ fhir:v "5"^^xsd:decimal ] ;
fhir:unit [ fhir:v "Tablets" ] ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cbsSubsidy"^^xsd:anyURI ] ;
fhir:value [
a fhir:Money ;
fhir:value [ fhir:v "10"^^xsd:decimal ] ;
fhir:currency [ fhir:v "NZD" ] ] ] [
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cbsPackSize"^^xsd:anyURI ] ;
fhir:value [
a fhir:Quantity ;
fhir:value [ fhir:v "30"^^xsd:decimal ] ;
fhir:unit [ fhir:v "Tablets" ] ] ] ) ;
fhir:sequence [ fhir:v "1"^^xsd:positiveInteger ] ;
fhir:productOrService [
( fhir:coding [
fhir:system [ fhir:v "https://standards.digital.health.nz/ns/pharmacode"^^xsd:anyURI ] ;
fhir:code [ fhir:v "123456" ] ] [
fhir:system [ fhir:v "https://standards.digital.health.nz/ns/nzulm"^^xsd:anyURI ] ;
fhir:code [ fhir:v "NZULM789" ] ] ) ] ;
fhir:quantity [
fhir:value [ fhir:v "180"^^xsd:decimal ] ;
fhir:unit [ fhir:v "Tablets" ] ] ;
fhir:net [
fhir:value [ fhir:v "500"^^xsd:decimal ] ;
fhir:currency [ fhir:v "NZD" ] ] ] )
] ) ; #
fhir:total [
fhir:value [ fhir:v "500"^^xsd:decimal ] ;
fhir:currency [ fhir:v "NZD" ]
] . #
IG © 2022+ Te Whatu Ora. Package tewhatuora.sharedcare#0.4.5 based on FHIR 4.0.1. Generated 2026-06-04
Links: Table of Contents |
QA Report