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
| Official URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status | Version: 0.1.1 | |||
| Draft as of 2026-10-16 | Computable Name: ApplicationStatus | |||
The HSAAP status and outcome of a Special Authority Application. The same shape is returned whether the status
arrives synchronously from $submit or later through Application Enquiry (D22).
Carried on ClaimResponse. It may also be carried on Claim in Application Enquiry results so that the
application-status search parameter on Claim has an element to evaluate (see Design Notes).
Context of Use
This extension may be used on the following element(s)
ClaimResponse
Claim
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Extension |
C | 0..* | Extension | Application Status Constraints: sa-appstatus-1 |
  extension |
1..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:status |
1..1 | Extension | SUBMITTED | PENDING_REVIEW | CANCELLED | DONE | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "status" | |
  value[x] |
0..1 | code | Value of extension Binding: SA Application Status (required) | |
| extension:outcome |
0..1 | Extension | APPROVED | INVALID | DECLINED - present only where status is DONE | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "outcome" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Application Outcome (required) | |
| extension:outcomeCode |
0..1 | Extension | Machine readable reason, from the Error Code Catalogue | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "outcomeCode" | |
 value[x] |
0..1 | Coding | Value of extension Binding: SA Outcome Code (extensible) | |
 extension:outcomeReason |
0..1 | Extension | Human readable reason | |
 extension |
0..0 | Extension | ||
| url |
1..1 | uri | "outcomeReason" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status" | |
 value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
C | 0..* | Extension | Application Status Constraints: sa-appstatus-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:status |
1..1 | Extension | SUBMITTED | PENDING_REVIEW | CANCELLED | DONE | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Application Status (required) | |
| extension:outcome |
0..1 | Extension | APPROVED | INVALID | DECLINED - present only where status is DONE | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "outcome" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Application Outcome (required) | |
| extension:outcomeCode |
0..1 | Extension | Machine readable reason, from the Error Code Catalogue | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "outcomeCode" | |
| value[x] |
0..1 | Coding | Value of extension Binding: SA Outcome Code (extensible) | |
| extension:outcomeReason |
0..1 | Extension | Human readable reason | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "outcomeReason" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: The HSAAP status and outcome of a Special Authority Application. The same shape is returned whether the status
arrives synchronously from $submit or later through Application Enquiry (D22).
Carried on ClaimResponse. It may also be carried on Claim in Application Enquiry results so that the
application-status search parameter on Claim has an element to evaluate (see Design Notes).
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
C | 0..* | Extension | Application Status Constraints: sa-appstatus-1 |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:status |
1..1 | Extension | SUBMITTED | PENDING_REVIEW | CANCELLED | DONE | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Application Status (required) | |
| extension:outcome |
0..1 | Extension | APPROVED | INVALID | DECLINED - present only where status is DONE | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "outcome" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Application Outcome (required) | |
| extension:outcomeCode |
0..1 | Extension | Machine readable reason, from the Error Code Catalogue | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "outcomeCode" | |
| value[x] |
0..1 | Coding | Value of extension Binding: SA Outcome Code (extensible) | |
| extension:outcomeReason |
0..1 | Extension | Human readable reason | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "outcomeReason" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
C | 0..* | Extension | Application Status Constraints: sa-appstatus-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:status |
1..1 | Extension | SUBMITTED | PENDING_REVIEW | CANCELLED | DONE | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Application Status (required) | |
| extension:outcome |
0..1 | Extension | APPROVED | INVALID | DECLINED - present only where status is DONE | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "outcome" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Application Outcome (required) | |
| extension:outcomeCode |
0..1 | Extension | Machine readable reason, from the Error Code Catalogue | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "outcomeCode" | |
| value[x] |
0..1 | Coding | Value of extension Binding: SA Outcome Code (extensible) | |
| extension:outcomeReason |
0..1 | Extension | Human readable reason | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "outcomeReason" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: The HSAAP status and outcome of a Special Authority Application. The same shape is returned whether the status
arrives synchronously from $submit or later through Application Enquiry (D22).
Carried on ClaimResponse. It may also be carried on Claim in Application Enquiry results so that the
application-status search parameter on Claim has an element to evaluate (see Design Notes).
Other representations of profile: CSV, Excel, Schematron
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:status.value[x] | Base | required | SA Application Status | 📦0.1.1 | This IG |
| Extension.extension:outcome.value[x] | Base | required | SA Application Outcome | 📦0.1.1 | This IG |
| Extension.extension:outcomeCode.value[x] | Base | extensible | SA Outcome Code | 📦0.1.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| sa-appstatus-1 | error | Extension | An outcome is present if, and only if, status is DONE. |
extension('outcome').exists() = extension('status').where(value = 'DONE').exists()
|