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
{
"resourceType" : "Claim",
"meta" : {
"source" : "https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A",
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyClaim"
],
"tag" : [
{
"system" : "https://hub.services.digital.health.nz/ns/correlation-id",
"code" : "123e4567-e89b-12d3-a456-426614174000"
}
]
},
"text" : {
"status" : "extensions",
"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\u00a0(use:\u00a0official,\u00a0)</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\u00a0(use:\u00a0official,\u00a0)</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>"
},
"extension" : [
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/claimant-number",
"valueString" : "AG12345"
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-cohort",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/pharmacy-claim-patient-cohort-codes",
"code" : "CRC"
}
]
}
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/originating-claimant-number",
"valueString" : "AG54321"
}
],
"identifier" : [
{
"use" : "official",
"system" : "https://provider-org-name.co.nz/ns/claim-identifier",
"value" : "C123456"
}
],
"status" : "active",
"type" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-type",
"code" : "pharmacy"
}
]
},
"subType" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype",
"code" : "ICPSA"
}
]
},
"use" : "claim",
"patient" : {
"type" : "Patient",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZZZ0008"
}
},
"billablePeriod" : {
"start" : "2025-01-01",
"end" : "2025-01-01"
},
"created" : "2025-01-01T00:00:00+13:00",
"enterer" : {
"type" : "Practitioner",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "12345"
}
},
"provider" : {
"type" : "Organization",
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
"value" : "GZZ999-9"
}
},
"priority" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/processpriority",
"code" : "normal"
}
]
},
"insurance" : [
{
"sequence" : 1,
"focal" : false,
"coverage" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "not-applicable"
}
],
"display" : "Not applicable"
}
}
],
"item" : [
{
"extension" : [
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/item-request",
"valueReference" : {
"type" : "MedicationDispense",
"identifier" : {
"system" : "https://provider-org-name.co.nz/ns/scriptno-local",
"value" : "RX123456-01"
}
}
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/transaction-category",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-pharmacy-transaction-category",
"code" : "I"
}
]
}
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/extended-supply-flag",
"valueBoolean" : false
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-flag",
"valueBoolean" : true
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/prescriber-flag",
"valueBoolean" : false
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/prescription-flag",
"valueBoolean" : true
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dose-flag",
"valueBoolean" : false
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/group-id",
"valueString" : "GRP001"
}
],
"sequence" : 1,
"productOrService" : {
"coding" : [
{
"system" : "https://standards.digital.health.nz/ns/purchase-unit",
"code" : "PU1234"
}
]
},
"servicedPeriod" : {
"start" : "2025-01-01T00:00:00+13:00",
"end" : "2025-01-01T23:59:59+13:00"
},
"detail" : [
{
"extension" : [
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hsaap-balance-owing",
"valueString" : "0"
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/wastageQuantity",
"valueQuantity" : {
"value" : 5,
"unit" : "Tablets"
}
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cbsSubsidy",
"valueMoney" : {
"value" : 10,
"currency" : "NZD"
}
},
{
"url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cbsPackSize",
"valueQuantity" : {
"value" : 30,
"unit" : "Tablets"
}
}
],
"sequence" : 1,
"productOrService" : {
"coding" : [
{
"system" : "https://standards.digital.health.nz/ns/pharmacode",
"code" : "123456"
},
{
"system" : "https://standards.digital.health.nz/ns/nzulm",
"code" : "NZULM789"
}
]
},
"quantity" : {
"value" : 180,
"unit" : "Tablets"
},
"net" : {
"value" : 500,
"currency" : "NZD"
}
}
]
}
],
"total" : {
"value" : 500,
"currency" : "NZD"
}
}