HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft
HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft
HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) 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/Bundle/sa-example-approval-search-all-versions> a fhir:Bundle ;
fhir:nodeRole fhir:treeRoot ;
fhir:Resource.id [ fhir:value "sa-example-approval-search-all-versions"] ;
fhir:Bundle.type [ fhir:value "searchset"] ;
fhir:Bundle.total [ fhir:value "2"^^xsd:nonNegativeInteger] ;
fhir:Bundle.link [
fhir:index 0 ;
fhir:Bundle.link.relation [ fhir:value "self" ] ;
fhir:Bundle.link.url [ fhir:value "https://api.example.health.nz/fhir/ClaimResponse?patient.identifier=https://standards.digital.health.nz/ns/nhi-id|ZZZ0016&approval-version-state=ALL" ]
] ;
fhir:Bundle.entry [
fhir:index 0 ;
fhir:Bundle.entry.fullUrl [ fhir:value "https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v2" ] ;
fhir:Bundle.entry.resource <https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v2> ;
fhir:Bundle.entry.search [
fhir:Bundle.entry.search.mode [ fhir:value "match" ]
]
], [
fhir:index 1 ;
fhir:Bundle.entry.fullUrl [ fhir:value "https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v1" ] ;
fhir:Bundle.entry.resource <https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v1> ;
fhir:Bundle.entry.search [
fhir:Bundle.entry.search.mode [ fhir:value "match" ]
]
], [
fhir:index 2 ;
fhir:Bundle.entry.fullUrl [ fhir:value "https://api.example.health.nz/fhir/Patient/sa-example-patient" ] ;
fhir:Bundle.entry.resource <https://api.example.health.nz/fhir/Patient/sa-example-patient> ;
fhir:Bundle.entry.search [
fhir:Bundle.entry.search.mode [ fhir:value "include" ]
]
], [
fhir:index 3 ;
fhir:Bundle.entry.fullUrl [ fhir:value "https://api.example.health.nz/fhir/Practitioner/sa-example-applicant" ] ;
fhir:Bundle.entry.resource <https://api.example.health.nz/fhir/Practitioner/sa-example-applicant> ;
fhir:Bundle.entry.search [
fhir:Bundle.entry.search.mode [ fhir:value "include" ]
]
] .
<https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v2> a fhir:ClaimResponse ;
fhir:Resource.id [ fhir:value "sa-example-approval-chem-v2"] ;
fhir:Resource.meta [
fhir:Meta.lastUpdated [ fhir:value "2025-08-20T14:40:00+12:00"^^xsd:dateTime ] ;
fhir:Meta.profile [
fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse" ;
fhir:index 0 ;
fhir:link <https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse>
]
] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ] ;
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"ClaimResponse_sa-example-approval-chem-v2\"> </a><p class=\"res-header-id\"><b>Generated Narrative: ClaimResponse sa-example-approval-chem-v2</b></p><a name=\"sa-example-approval-chem-v2\"> </a><a name=\"hcsa-example-approval-chem-v2\"> </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\">Last updated: 2025-08-20 14:40:00+1200</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-sa-approval-claimresponse.html\">SA Approval ClaimResponse</a></p></div><blockquote><p><b>Approval Detail</b></p><ul><li>approvalType: CHEM</li><li>status: REVOKED</li><li>formNumber: SA9999</li></ul></blockquote><p><b>identifier</b>: <a href=\"NamingSystem-sa-approval-number.html\" title=\"Special Authority Approval Number. Carried on ClaimResponse.identifier and ClaimResponse.preAuthRef (D23).\">SAApprovalNumber</a>/25SA0001234</p><p><b>status</b>: Active</p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/claim-type pharmacy}\">Pharmacy</span></p><p><b>use</b>: Preauthorization</p><p><b>patient</b>: <a href=\"Patient-sa-example-patient.html\">Aroha Parata (official) (no stated gender), DoB: 1968-03-14 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZZZ0016 (use: official))</a></p><p><b>created</b>: 2025-08-20 14:40:00+1200</p><p><b>insurer</b>: Health New Zealand | Te Whatu Ora</p><p><b>requestor</b>: <a href=\"Practitioner-sa-example-applicant.html\">Jane Smith (official) (https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#99ZZZZ (use: official))</a></p><p><b>outcome</b>: Processing Complete</p><p><b>preAuthRef</b>: 25SA0001234</p><p><b>preAuthPeriod</b>: 2025-02-01 --> 2026-02-01</p></div>"
] ;
fhir:DomainResource.extension [
fhir:index 0 ;
fhir:Element.extension [
fhir:index 0 ;
fhir:Extension.url [ fhir:value "approvalType" ] ;
fhir:Extension.valueCode [ fhir:value "CHEM" ]
], [
fhir:index 1 ;
fhir:Extension.url [ fhir:value "status" ] ;
fhir:Extension.valueCode [ fhir:value "REVOKED" ]
], [
fhir:index 2 ;
fhir:Extension.url [ fhir:value "formNumber" ] ;
fhir:Extension.valueString [ fhir:value "SA9999" ]
] ;
fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-detail" ]
] ;
fhir:ClaimResponse.identifier [
fhir:index 0 ;
fhir:Identifier.system [ fhir:value "https://fhir-ig.digital.health.nz/special-authority/ns/approval-number" ] ;
fhir:Identifier.value [ fhir:value "25SA0001234" ]
] ;
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 "pharmacy" ]
]
] ;
fhir:ClaimResponse.use [ fhir:value "preauthorization"] ;
fhir:ClaimResponse.patient [
fhir:link <http://hl7.org/fhir/Patient/sa-example-patient> ;
fhir:Reference.reference [ fhir:value "Patient/sa-example-patient" ]
] ;
fhir:ClaimResponse.created [ fhir:value "2025-08-20T14:40:00+12:00"^^xsd:dateTime] ;
fhir:ClaimResponse.insurer [
fhir:Reference.display [ fhir:value "Health New Zealand | Te Whatu Ora" ]
] ;
fhir:ClaimResponse.requestor [
fhir:link <http://hl7.org/fhir/Practitioner/sa-example-applicant> ;
fhir:Reference.reference [ fhir:value "Practitioner/sa-example-applicant" ]
] ;
fhir:ClaimResponse.outcome [ fhir:value "complete"] ;
fhir:ClaimResponse.preAuthRef [ fhir:value "25SA0001234"] ;
fhir:ClaimResponse.preAuthPeriod [
fhir:Period.start [ fhir:value "2025-02-01"^^xsd:date ] ;
fhir:Period.end [ fhir:value "2026-02-01"^^xsd:date ]
] .
<http://hl7.org/fhir/Patient/sa-example-patient> a fhir:Patient .
<http://hl7.org/fhir/Practitioner/sa-example-applicant> a fhir:Practitioner .
<https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v1> a fhir:ClaimResponse ;
fhir:Resource.id [ fhir:value "sa-example-approval-chem-v1"] ;
fhir:Resource.meta [
fhir:Meta.lastUpdated [ fhir:value "2025-02-01T08:15:00+13:00"^^xsd:dateTime ] ;
fhir:Meta.profile [
fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse" ;
fhir:index 0 ;
fhir:link <https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse>
]
] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ] ;
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"ClaimResponse_sa-example-approval-chem-v1\"> </a><p class=\"res-header-id\"><b>Generated Narrative: ClaimResponse sa-example-approval-chem-v1</b></p><a name=\"sa-example-approval-chem-v1\"> </a><a name=\"hcsa-example-approval-chem-v1\"> </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\">Last updated: 2025-02-01 08:15:00+1300</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-sa-approval-claimresponse.html\">SA Approval ClaimResponse</a></p></div><blockquote><p><b>Approval Detail</b></p><ul><li>approvalType: CHEM</li><li>status: ACTIVE</li><li>formNumber: SA9999</li></ul></blockquote><p><b>identifier</b>: <a href=\"NamingSystem-sa-approval-number.html\" title=\"Special Authority Approval Number. Carried on ClaimResponse.identifier and ClaimResponse.preAuthRef (D23).\">SAApprovalNumber</a>/25SA0001234</p><p><b>status</b>: Active</p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/claim-type pharmacy}\">Pharmacy</span></p><p><b>use</b>: Preauthorization</p><p><b>patient</b>: <a href=\"Patient-sa-example-patient.html\">Aroha Parata (official) (no stated gender), DoB: 1968-03-14 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZZZ0016 (use: official))</a></p><p><b>created</b>: 2025-02-01 08:15:00+1300</p><p><b>insurer</b>: Health New Zealand | Te Whatu Ora</p><p><b>requestor</b>: <a href=\"Practitioner-sa-example-applicant.html\">Jane Smith (official) (https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#99ZZZZ (use: official))</a></p><p><b>outcome</b>: Processing Complete</p><p><b>preAuthRef</b>: 25SA0001234</p><p><b>preAuthPeriod</b>: 2025-02-01 --> 2026-02-01</p></div>"
] ;
fhir:DomainResource.extension [
fhir:index 0 ;
fhir:Element.extension [
fhir:index 0 ;
fhir:Extension.url [ fhir:value "approvalType" ] ;
fhir:Extension.valueCode [ fhir:value "CHEM" ]
], [
fhir:index 1 ;
fhir:Extension.url [ fhir:value "status" ] ;
fhir:Extension.valueCode [ fhir:value "ACTIVE" ]
], [
fhir:index 2 ;
fhir:Extension.url [ fhir:value "formNumber" ] ;
fhir:Extension.valueString [ fhir:value "SA9999" ]
] ;
fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-detail" ]
] ;
fhir:ClaimResponse.identifier [
fhir:index 0 ;
fhir:Identifier.system [ fhir:value "https://fhir-ig.digital.health.nz/special-authority/ns/approval-number" ] ;
fhir:Identifier.value [ fhir:value "25SA0001234" ]
] ;
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 "pharmacy" ]
]
] ;
fhir:ClaimResponse.use [ fhir:value "preauthorization"] ;
fhir:ClaimResponse.patient [
fhir:link <http://hl7.org/fhir/Patient/sa-example-patient> ;
fhir:Reference.reference [ fhir:value "Patient/sa-example-patient" ]
] ;
fhir:ClaimResponse.created [ fhir:value "2025-02-01T08:15:00+13:00"^^xsd:dateTime] ;
fhir:ClaimResponse.insurer [
fhir:Reference.display [ fhir:value "Health New Zealand | Te Whatu Ora" ]
] ;
fhir:ClaimResponse.requestor [
fhir:link <http://hl7.org/fhir/Practitioner/sa-example-applicant> ;
fhir:Reference.reference [ fhir:value "Practitioner/sa-example-applicant" ]
] ;
fhir:ClaimResponse.outcome [ fhir:value "complete"] ;
fhir:ClaimResponse.preAuthRef [ fhir:value "25SA0001234"] ;
fhir:ClaimResponse.preAuthPeriod [
fhir:Period.start [ fhir:value "2025-02-01"^^xsd:date ] ;
fhir:Period.end [ fhir:value "2026-02-01"^^xsd:date ]
] .
<https://api.example.health.nz/fhir/Patient/sa-example-patient> a fhir:Patient ;
fhir:Resource.id [ fhir:value "sa-example-patient"] ;
fhir:Resource.meta [
fhir:Meta.profile [
fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-patient" ;
fhir:index 0 ;
fhir:link <https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-patient>
]
] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ] ;
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Patient_sa-example-patient\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Patient sa-example-patient</b></p><a name=\"sa-example-patient\"> </a><a name=\"hcsa-example-patient\"> </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-sa-patient.html\">SA Patient</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Aroha Parata (official) (no stated gender), DoB: 1968-03-14 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZZZ0016 (use: official))</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"Ways to contact the Patient\">Contact Detail</td><td colspan=\"3\">12 Kowhai Street Waikanae 5036 NZ (home) (NZ Suburb: Waikanae Beach)</td></tr></table></div>"
] ;
fhir:Patient.identifier [
fhir:index 0 ;
fhir:Identifier.use [ fhir:value "official" ] ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/nhi-id" ] ;
fhir:Identifier.value [ fhir:value "ZZZ0016" ]
] ;
fhir:Patient.name [
fhir:index 0 ;
fhir:HumanName.use [ fhir:value "official" ] ;
fhir:HumanName.family [ fhir:value "Parata" ] ;
fhir:HumanName.given [
fhir:value "Aroha" ;
fhir:index 0
] ;
fhir:HumanName.prefix [
fhir:value "Ms" ;
fhir:index 0
]
] ;
fhir:Patient.birthDate [ fhir:value "1968-03-14"^^xsd:date] ;
fhir:Patient.address [
fhir:index 0 ;
fhir:Element.extension [
fhir:index 0 ;
fhir:Extension.url [ fhir:value "http://hl7.org.nz/fhir/StructureDefinition/suburb" ] ;
fhir:Extension.valueString [ fhir:value "Waikanae Beach" ]
] ;
fhir:Address.use [ fhir:value "home" ] ;
fhir:Address.line [
fhir:value "12 Kowhai Street" ;
fhir:index 0
] ;
fhir:Address.city [ fhir:value "Waikanae" ] ;
fhir:Address.postalCode [ fhir:value "5036" ] ;
fhir:Address.country [ fhir:value "NZ" ]
] .
<https://api.example.health.nz/fhir/Practitioner/sa-example-applicant> a fhir:Practitioner ;
fhir:Resource.id [ fhir:value "sa-example-applicant"] ;
fhir:Resource.meta [
fhir:Meta.profile [
fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-practitioner" ;
fhir:index 0 ;
fhir:link <https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-practitioner>
]
] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "generated" ] ;
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Practitioner_sa-example-applicant\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Practitioner sa-example-applicant</b></p><a name=\"sa-example-applicant\"> </a><a name=\"hcsa-example-applicant\"> </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-sa-practitioner.html\">SA Practitioner</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Jane Smith (official) (https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#99ZZZZ (use: official))</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"Other Id (see the one above)\">Other Id:</td><td colspan=\"3\"><a href=\"http://fhir.org.nz/ig/base/3.1.0/NamingSystem-medical-council-id.html\" title=\"Medical Council of New Zealand Register Number\">NZMC</a>/12345 (use: secondary)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Ways to contact the Practitioner\">Contact Detail</td><td colspan=\"3\">1 Main Highway Otaki 5512 NZ (work)</td></tr></table></div>"
] ;
fhir:Practitioner.identifier [
fhir:index 0 ;
fhir:Identifier.use [ fhir:value "official" ] ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-person-id" ] ;
fhir:Identifier.value [ fhir:value "99ZZZZ" ]
], [
fhir:index 1 ;
fhir:Identifier.use [ fhir:value "secondary" ] ;
fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/medical-council-id" ] ;
fhir:Identifier.value [ fhir:value "12345" ]
] ;
fhir:Practitioner.name [
fhir:index 0 ;
fhir:HumanName.use [ fhir:value "official" ] ;
fhir:HumanName.family [ fhir:value "Smith" ] ;
fhir:HumanName.given [
fhir:value "Jane" ;
fhir:index 0
] ;
fhir:HumanName.prefix [
fhir:value "Dr" ;
fhir:index 0
]
] ;
fhir:Practitioner.address [
fhir:index 0 ;
fhir:Address.use [ fhir:value "work" ] ;
fhir:Address.line [
fhir:value "1 Main Highway" ;
fhir:index 0
] ;
fhir:Address.city [ fhir:value "Otaki" ] ;
fhir:Address.postalCode [ fhir:value "5512" ] ;
fhir:Address.country [ fhir:value "NZ" ]
] .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/Bundle/sa-example-approval-search-all-versions.ttl> a owl:Ontology ;
owl:imports fhir:fhir.ttl ;
owl:versionIRI <http://build.fhir.org/Bundle/sa-example-approval-search-all-versions.ttl> .
IG © 2026+ Health New Zealand | Te Whatu Ora. Package tewhatuora.specialauthority#0.1.1 based on FHIR 4.0.1. Generated 2026-10-16
Links: Table of Contents |
QA Report