{ "resourceType" : "CapabilityStatement", "id" : "SpecialAuthorityFHIRAPICapabilityStatement", "meta" : { "profile" : ["https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement"] }, "text" : { "status" : "extensions", "div" : "

Generated Narrative: CapabilityStatement SpecialAuthorityFHIRAPICapabilityStatement

Profile: Capability Statement profile for use with the Health New Zealand Te Whatu Ora OpenAPI spec converter

Special Authority FHIR Server Capability Statement

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

All token searches on identifiers SHALL be system-qualified (system|value). All requests require a validated access token and a validated signed Request-Context header.

\n
Security
Enable CORS: no
Security services supported: SMART-on-FHIR

OAuth 2.0 client credentials flow and signed Request-Context header, per the Health NZ Digital Services Hub onboarding process. The authenticated requester identity is never taken from the FHIR payload.

\n

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

Resource TypeProfileRSUCSearches_include_revincludeOperations
Claimhttps://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-claim
Additional supported profiles:
\u00a0\u00a0SA Claim		yidentifier, patient, requestor, application-status, createdClaim:patient, Claim:requestor, Claim:supportinginfo$submit
ClaimResponseSupported Profiles
\u00a0\u00a0SA Application ClaimResponse
\u00a0\u00a0SA Approval ClaimResponse		yidentifier, request, patient, requestor, approval-status, approval-valid-on, approval-expiring, approval-provider-id, approval-version-state, _elementsClaimResponse:request

Resource Conformance: unspecified Claim

Base System Profile
SA Claim
Profile Conformance
SHALL
Reference Policy

Supported Profiles

SA Claim

Interaction summary
  • Supports
    search-type

    Search Applications, or retrieve a submitted Application by Application Number with _include. Search results are summary representations: referenced resources are only resolved via _include.

    \n

Documentation

Special Authority Applications. Submitted with $submit; enquired with search.

\n
Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Application Number. SHALL be system-qualified.

\n
SHALLpatientreference

Supports the chained form patient.identifier=nhi-system|NHI only.

\n
SHALLrequestorreference

Supports requestor:Practitioner.identifier with the HPI CPN system or an NZ registration authority system.

\n
SHALLapplication-statustoken

SUBMITTED | PENDING_REVIEW | CANCELLED | DONE

\n
SHALLcreateddate

Submission date range: ge and le map to submittedFrom and submittedTo.

\n
\u00a0
Extended Operations
ConformanceOperationDocumentation
SHALL$submit

Resource Conformance: unspecified ClaimResponse

Core FHIR Resource
ClaimResponse
Reference Policy
Interaction summary
  • Supports search-type.

Supported Profiles

SA Application ClaimResponse
SA Approval ClaimResponse

Documentation

Application outcomes (searched by request.identifier) and Approvals (searched by Approval Number, NHI or practitioner). An Approval search SHALL supply at least one of identifier, patient.identifier or requestor:Practitioner.identifier. approval-valid-on and approval-expiring are mutually exclusive.

\n
Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Approval Number. SHALL be system-qualified.

\n
SHALLrequestreference

Supports the chained form request.identifier=application-number-system|applicationNumber.

\n
SHALLpatientreference

Supports the chained form patient.identifier=nhi-system|NHI only.

\n
SHALLrequestorreference

Supports requestor:Practitioner.identifier with the HPI CPN system or an NZ registration authority system.

\n
SHALLapproval-statustoken

ACTIVE | CANCELLED | REVOKED

\n
SHALLapproval-valid-ondate

Approvals valid on the supplied date.

\n
SHALLapproval-expiringdate

Approvals expiring within a date range.

\n
SHALLapproval-provider-idtoken

Provider - pharmacy - on the Approval. SHALL be system-qualified.

\n
SHALLapproval-version-statetoken

LATEST - default - or PREVIOUS or ALL.

\n
SHALL_elementsspecial

Supported for Retrieve Application Outcome: _elements=extension,preAuthRef.

\n
\u00a0
" }, "extension" : [{ "extension" : [{ "url" : "licenseURL", "valueUri" : "https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx" }, { "url" : "externalDocs", "valueUri" : "https://fhir-ig.digital.health.nz/special-authority" }, { "url" : "licenseName", "valueString" : "Health New Zealand Digital Services Hub API Access and Use Agreement" }, { "extension" : [{ "extension" : [{ "url" : "key", "valueString" : "Request-Context" }, { "url" : "value", "valueUri" : "https://raw.githubusercontent.com/tewhatuora/schemas/main/openapi-definitions/Request-Context.json" }, { "url" : "required", "valueBoolean" : true }, { "url" : "documentation", "valueString" : "Signed Request-Context header asserting the authenticated user, organisation and facility. Validated on every request." }], "url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension" }, { "extension" : [{ "url" : "key", "valueString" : "X-Correlation-Id" }, { "url" : "value", "valueUri" : "https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Correlation-Id.json" }, { "url" : "required", "valueBoolean" : false }, { "url" : "documentation", "valueString" : "Optional client-supplied correlation id, returned in the response and recorded in audit events." }], "url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension" }], "url" : "globalHeaders" }], "url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension" }], "url" : "https://fhir-ig.digital.health.nz/special-authority/CapabilityStatement/SpecialAuthorityFHIRAPICapabilityStatement", "version" : "0.1.1", "name" : "SpecialAuthorityFHIRAPICapabilityStatement", "title" : "Special Authority FHIR Server Capability Statement", "status" : "draft", "experimental" : false, "date" : "2026-10-15", "publisher" : "Health New Zealand | Te Whatu Ora", "contact" : [{ "name" : "Health New Zealand | Te Whatu Ora", "telecom" : [{ "system" : "url", "value" : "https://www.tewhatuora.govt.nz/" }, { "system" : "email", "value" : "integration@tewhatuora.govt.nz" }] }, { "name" : "HNZ Integration Team", "telecom" : [{ "system" : "email", "value" : "integration@tewhatuora.govt.nz", "use" : "work" }] }], "description" : "Health NZ | Te Whatu Ora Special Authority FHIR API", "jurisdiction" : [{ "coding" : [{ "system" : "urn:iso:std:iso:3166", "code" : "NZ", "display" : "New Zealand" }] }], "kind" : "instance", "implementation" : { "description" : "Production Special Authority FHIR API", "url" : "https://api.sa.digital.health.nz/s2s/fhir/R4" }, "fhirVersion" : "4.0.1", "format" : ["application/fhir+json"], "rest" : [{ "mode" : "server", "documentation" : "All token searches on identifiers SHALL be system-qualified (system|value). All requests require a validated access token and a validated signed Request-Context header.", "security" : { "extension" : [{ "extension" : [{ "url" : "token", "valueUri" : "https://auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/token" }, { "url" : "authorize", "valueUri" : "https://auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/auth" }], "url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris" }, { "url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities", "valueCode" : "client-confidential-symmetric" }], "cors" : false, "service" : [{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/restful-security-service", "code" : "SMART-on-FHIR" }] }], "description" : "OAuth 2.0 client credentials flow and signed Request-Context header, per the Health NZ Digital Services Hub onboarding process. The authenticated requester identity is never taken from the FHIR payload." }, "resource" : [{ "type" : "Claim", "profile" : "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-claim", "supportedProfile" : ["https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-claim"], "documentation" : "Special Authority Applications. Submitted with $submit; enquired with search.", "interaction" : [{ "code" : "search-type", "documentation" : "Search Applications, or retrieve a submitted Application by Application Number with _include. Search results are summary representations: referenced resources are only resolved via _include." }], "searchInclude" : ["Claim:patient", "Claim:requestor", "Claim:supportinginfo"], "searchParam" : [{ "name" : "identifier", "definition" : "http://hl7.org/fhir/SearchParameter/Claim-identifier", "type" : "token", "documentation" : "Application Number. SHALL be system-qualified." }, { "name" : "patient", "definition" : "http://hl7.org/fhir/SearchParameter/Claim-patient", "type" : "reference", "documentation" : "Supports the chained form patient.identifier=nhi-system|NHI only." }, { "name" : "requestor", "definition" : "https://fhir-ig.digital.health.nz/special-authority/SearchParameter/claim-requestor", "type" : "reference", "documentation" : "Supports requestor:Practitioner.identifier with the HPI CPN system or an NZ registration authority system." }, { "name" : "application-status", "definition" : "https://fhir-ig.digital.health.nz/special-authority/SearchParameter/application-status", "type" : "token", "documentation" : "SUBMITTED | PENDING_REVIEW | CANCELLED | DONE" }, { "name" : "created", "definition" : "http://hl7.org/fhir/SearchParameter/Claim-created", "type" : "date", "documentation" : "Submission date range: ge and le map to submittedFrom and submittedTo." }], "operation" : [{ "name" : "submit", "definition" : "https://fhir-ig.digital.health.nz/special-authority/OperationDefinition/sa-claim-submit" }] }, { "type" : "ClaimResponse", "supportedProfile" : ["https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-application-claimresponse", "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse"], "documentation" : "Application outcomes (searched by request.identifier) and Approvals (searched by Approval Number, NHI or practitioner). An Approval search SHALL supply at least one of identifier, patient.identifier or requestor:Practitioner.identifier. approval-valid-on and approval-expiring are mutually exclusive.", "interaction" : [{ "code" : "search-type" }], "searchInclude" : ["ClaimResponse:request"], "searchParam" : [{ "name" : "identifier", "definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-identifier", "type" : "token", "documentation" : "Approval Number. SHALL be system-qualified." }, { "name" : "request", "definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-request", "type" : "reference", "documentation" : "Supports the chained form request.identifier=application-number-system|applicationNumber." }, { "name" : "patient", "definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-patient", "type" : "reference", "documentation" : "Supports the chained form patient.identifier=nhi-system|NHI only." }, { "name" : "requestor", "definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-requestor", "type" : "reference", "documentation" : "Supports requestor:Practitioner.identifier with the HPI CPN system or an NZ registration authority system." }, { "name" : "approval-status", "definition" : "https://fhir-ig.digital.health.nz/special-authority/SearchParameter/approval-status", "type" : "token", "documentation" : "ACTIVE | CANCELLED | REVOKED" }, { "name" : "approval-valid-on", "definition" : "https://fhir-ig.digital.health.nz/special-authority/SearchParameter/approval-valid-on", "type" : "date", "documentation" : "Approvals valid on the supplied date." }, { "name" : "approval-expiring", "definition" : "https://fhir-ig.digital.health.nz/special-authority/SearchParameter/approval-expiring", "type" : "date", "documentation" : "Approvals expiring within a date range." }, { "name" : "approval-provider-id", "definition" : "https://fhir-ig.digital.health.nz/special-authority/SearchParameter/approval-provider-id", "type" : "token", "documentation" : "Provider - pharmacy - on the Approval. SHALL be system-qualified." }, { "name" : "approval-version-state", "definition" : "https://fhir-ig.digital.health.nz/special-authority/SearchParameter/approval-version-state", "type" : "token", "documentation" : "LATEST - default - or PREVIOUS or ALL." }, { "name" : "_elements", "type" : "special", "documentation" : "Supported for Retrieve Application Outcome: _elements=extension,preAuthRef." }] }] }] }