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 rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
<http://hl7.org/fhir/ClaimResponse/NzTelehealthClaimResponseExample> a fhir:ClaimResponse ;
fhir:nodeRole fhir:treeRoot ;
fhir:Resource.id [ fhir:value "NzTelehealthClaimResponseExample"] ;
fhir:Resource.meta [
fhir:Meta.source [ fhir:value "https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A" ] ;
fhir:Meta.profile [
fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaimResponse" ;
fhir:index 0 ;
fhir:link <https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaimResponse>
] ;
fhir:Meta.tag [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://hub.services.digital.health.nz/ns/correlation-id" ] ;
fhir:Coding.code [ fhir:value "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ]
]
] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ] ;
fhir:Narrative.div "<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: </p></div><p><b>identifier</b>: <code>https://standards.digital.health.nz/ns/claim-response-identifier</code>/a1b2c3d4-e5f6-7890-abcd-ef1234567890 (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>: 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-15 10:30:00+0000</p><p><b>insurer</b>: Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html\" title=\"HPI organizations\">HPIOrganization</a>/G0K357-H</p><p><b>requestor</b>: Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html\" title=\"HPI organizations\">HPIOrganization</a>/GZZ999-J (use: official, )</p><p><b>request</b>: <a href=\"Claim-NzTelehealthClaimExample.html\">Claim: extension = AGRS-202sdfg4-00121,https://example.org/fhir/trace-number#7890; identifier = https://provider-org-name.co.nz/ns/claim-identifier#C123456 (use: official, ); status = active; type = professional; subType = Telehealth; use = claim; billablePeriod = 2025-01-01 00:00:00+1300 --> 2025-01-02 00:00:00+1300; 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 COGP0068}\">COGP0068</span></p><p><b>Shared Care Claim Trace Number</b>: <code>https://standards.digital.health.nz/ns/claim-response-item-identifier</code>/cd7b6e0d-c554-4786-a52d-3efd1c187c1a</p><blockquote><p><b>Shared Care Review Outcome</b></p><ul><li>decision: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/claim-decision-cs approved}\">Approved</span></li><li>reason: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/claim-decision-reason-cs DET064.001}\">Record of encounter was found in our system.</span></li></ul></blockquote><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 policy}\">policy</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><h3>Errors</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://terminology.hl7.org/CodeSystem/adjudication-error a001}\">Claim validation failed: Missing required service date</span></td></tr></table></div>"
] ;
fhir:ClaimResponse.identifier [
fhir:index 0 ;
fhir:Identifier.use [ fhir:value "official" ] ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/claim-response-identifier" ] ;
fhir:Identifier.value [ fhir:value "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ]
] ;
fhir:ClaimResponse.status [ fhir:value "active"] ;
fhir:ClaimResponse.type [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/claim-type" ] ;
fhir:Coding.code [ fhir:value "professional" ]
]
] ;
fhir:ClaimResponse.subType [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype-cs" ] ;
fhir:Coding.code [ fhir:value "telehealth" ]
]
] ;
fhir:ClaimResponse.use [ fhir:value "claim"] ;
fhir:ClaimResponse.patient [
fhir:Reference.type [ fhir:value "Patient" ] ;
fhir:Reference.identifier [
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/nhi-id" ] ;
fhir:Identifier.value [ fhir:value "ZZZ0008" ]
]
] ;
fhir:ClaimResponse.created [ fhir:value "2025-01-15T10:30:00-00:00"^^xsd:dateTime] ;
fhir:ClaimResponse.insurer [
fhir:Reference.type [ fhir:value "Organization" ] ;
fhir:Reference.identifier [
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-organisation-id" ] ;
fhir:Identifier.value [ fhir:value "G0K357-H" ]
]
] ;
fhir:ClaimResponse.requestor [
fhir:Reference.type [ fhir:value "Organization" ] ;
fhir:Reference.identifier [
fhir:Identifier.use [ fhir:value "official" ] ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-organisation-id" ] ;
fhir:Identifier.value [ fhir:value "GZZ999-J" ]
]
] ;
fhir:ClaimResponse.request [
fhir:link <http://hl7.org/fhir/Claim/NzTelehealthClaimExample> ;
fhir:Reference.reference [ fhir:value "Claim/NzTelehealthClaimExample" ]
] ;
fhir:ClaimResponse.outcome [ fhir:value "complete"] ;
fhir:ClaimResponse.item [
fhir:index 0 ;
fhir:Element.extension [
fhir:index 0 ;
fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-product-or-service" ] ;
fhir:Extension.valueCodeableConcept [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/purchase-unit" ] ;
fhir:Coding.code [ fhir:value "COGP0068" ]
]
]
], [
fhir:index 1 ;
fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-trace-number" ] ;
fhir:Extension.valueIdentifier [
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/claim-response-item-identifier" ] ;
fhir:Identifier.value [ fhir:value "cd7b6e0d-c554-4786-a52d-3efd1c187c1a" ]
]
], [
fhir:index 2 ;
fhir:Element.extension [
fhir:index 0 ;
fhir:Extension.url [ fhir:value "decision" ] ;
fhir:Extension.valueCodeableConcept [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/claim-decision-cs" ] ;
fhir:Coding.code [ fhir:value "approved" ] ;
fhir:Coding.display [ fhir:value "Approved" ]
]
]
], [
fhir:index 1 ;
fhir:Extension.url [ fhir:value "reason" ] ;
fhir:Extension.valueCodeableConcept [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/claim-decision-reason-cs" ] ;
fhir:Coding.code [ fhir:value "DET064.001" ] ;
fhir:Coding.display [ fhir:value "Passed" ]
] ;
fhir:CodeableConcept.text [ fhir:value "Record of encounter was found in our system." ]
]
] ;
fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-review-outcome" ]
] ;
fhir:ClaimResponse.item.itemSequence [ fhir:value "1"^^xsd:positiveInteger ] ;
fhir:ClaimResponse.item.adjudication [
fhir:index 0 ;
fhir:ClaimResponse.item.adjudication.category [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/adjudication" ] ;
fhir:Coding.code [ fhir:value "benefit" ]
]
] ;
fhir:ClaimResponse.item.adjudication.reason [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/adjudication-reason-code" ] ;
fhir:Coding.code [ fhir:value "policy" ]
]
] ;
fhir:ClaimResponse.item.adjudication.amount [
fhir:Money.value [ fhir:value "100"^^xsd:decimal ] ;
fhir:Money.currency [ fhir:value "NZD" ]
] ;
fhir:ClaimResponse.item.adjudication.value [ fhir:value "1"^^xsd:decimal ]
]
] ;
fhir:ClaimResponse.total [
fhir:index 0 ;
fhir:ClaimResponse.total.category [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/adjudication" ] ;
fhir:Coding.code [ fhir:value "benefit" ]
]
] ;
fhir:ClaimResponse.total.amount [
fhir:Money.value [ fhir:value "100"^^xsd:decimal ] ;
fhir:Money.currency [ fhir:value "NZD" ]
]
] ;
fhir:ClaimResponse.payment [
fhir:ClaimResponse.payment.type [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/ex-paymenttype" ] ;
fhir:Coding.code [ fhir:value "complete" ]
]
] ;
fhir:ClaimResponse.payment.date [ fhir:value "2025-01-01"^^xsd:date ] ;
fhir:ClaimResponse.payment.amount [
fhir:Money.value [ fhir:value "100"^^xsd:decimal ] ;
fhir:Money.currency [ fhir:value "NZD" ]
]
] ;
fhir:ClaimResponse.error [
fhir:index 0 ;
fhir:ClaimResponse.error.code [
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/adjudication-error" ] ;
fhir:Coding.code [ fhir:value "a001" ] ;
fhir:Coding.display [ fhir:value "Invalid claim" ]
] ;
fhir:CodeableConcept.text [ fhir:value "Claim validation failed: Missing required service date" ]
]
] .
<http://hl7.org/fhir/Claim/NzTelehealthClaimExample> a fhir:Claim .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/ClaimResponse/NzTelehealthClaimResponseExample.ttl> a owl:Ontology ;
owl:imports fhir:fhir.ttl ;
owl:versionIRI <http://build.fhir.org/ClaimResponse/NzTelehealthClaimResponseExample.ttl> .
IG © 2022+ Te Whatu Ora. Package tewhatuora.sharedcare#0.4.5 based on FHIR 4.0.1. Generated 2026-07-20
Links: Table of Contents |
QA Report