HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft New Zealand flag

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

Example Bundle: Example Response Bundle - Approved

Bundle sa-example-response-bundle-approved of type collection


Entry 1 - fullUrl = https://api.example.health.nz/fhir/ClaimResponse/sa-example-cr-approved

Resource ClaimResponse:

Application Status

  • status: DONE
  • outcome: APPROVED

identifier: SAApprovalNumber/26SA0004567

status: Active

type: Pharmacy

use: Preauthorization

created: 2026-10-14 10:35:07+1300

insurer: Health New Zealand | Te Whatu Ora

requestor: Jane Smith (official) (https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#99ZZZZ (use: official))

request: Identifier: SAApplicationNumber/000123456

outcome: complete

disposition: Application approved

preAuthRef: 26SA0004567

preAuthPeriod: 2026-10-14 --> 2027-10-14


Entry 2 - fullUrl = https://api.example.health.nz/fhir/Patient/sa-example-patient

Resource Patient:

Profile: SA Patient

Aroha Parata (official) (no stated gender), DoB: 1968-03-14 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZZZ0016 (use: official))


Contact Detail12 Kowhai Street Waikanae 5036 NZ (home) (NZ Suburb: Waikanae Beach)

Entry 3 - fullUrl = https://api.example.health.nz/fhir/Practitioner/sa-example-applicant

Resource Practitioner:

Jane Smith (official) (https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#99ZZZZ (use: official))


Other Id:NZMC/12345 (use: secondary)
Contact Detail1 Main Highway Otaki 5512 NZ (work)