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 Approval search - all versions

Bundle sa-example-approval-search-all-versions of type searchset

Entry 1 - fullUrl = https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v2

Search:Mode = match

Resource ClaimResponse:

Last updated: 2025-08-20 14:40:00+1200

Profile: SA Approval ClaimResponse

Approval Detail

  • approvalType: CHEM
  • status: REVOKED
  • formNumber: SA9999

identifier: SAApprovalNumber/25SA0001234

status: Active

type: Pharmacy

use: Preauthorization

created: 2025-08-20 14:40:00+1200

insurer: Health New Zealand | Te Whatu Ora

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

outcome: complete

preAuthRef: 25SA0001234

preAuthPeriod: 2025-02-01 --> 2026-02-01

Entry 2 - fullUrl = https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v1

Search:Mode = match

Resource ClaimResponse:

Last updated: 2025-02-01 08:15:00+1300

Profile: SA Approval ClaimResponse

Approval Detail

  • approvalType: CHEM
  • status: ACTIVE
  • formNumber: SA9999

identifier: SAApprovalNumber/25SA0001234

status: Active

type: Pharmacy

use: Preauthorization

created: 2025-02-01 08:15:00+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))

outcome: complete

preAuthRef: 25SA0001234

preAuthPeriod: 2025-02-01 --> 2026-02-01

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

Search:Mode = include

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 4 - fullUrl = https://api.example.health.nz/fhir/Practitioner/sa-example-applicant

Search:Mode = include

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)