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/existing-approval | Version: 0.1.1 | |||
| Draft as of 2026-10-16 | Computable Name: ExistingApproval | |||
Detail of a conflicting Approval, returned only on the synchronous $submit response where the Application was
declined because a conflicting Approval exists. Not returned on Application Enquiry (D22).
Context of Use
This extension may be used on the following element(s)
ClaimResponse
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 |
0..* | Extension | Existing Approval | |
  extension |
2..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:approvalType |
1..1 | Extension | Extension | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "approvalType" | |
  value[x] |
0..1 | code | Value of extension Binding: SA Approval Type (extensible) | |
| extension:approvalNumber |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "approvalNumber" | |
  value[x] |
0..1 | Identifier | Value of extension | |
 system |
0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir-ig.digital.health.nz/special-authority/ns/approval-number (extensions allowed) | |
 value |
1..1 | string | The value that is unique | |
| extension:effectiveDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "effectiveDate" | |
| value[x] |
0..1 | date | Value of extension | |
 extension:expiryDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "expiryDate" | |
| value[x] |
0..1 | date | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/existing-approval" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Existing Approval | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
2..* | 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:approvalType |
1..1 | Extension | Extension | |
| 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 | "approvalType" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Approval Type (extensible) | |
| extension:approvalNumber |
1..1 | Extension | Extension | |
| 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 | "approvalNumber" | |
| value[x] |
0..1 | Identifier | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir-ig.digital.health.nz/special-authority/ns/approval-number (extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
 assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| extension:effectiveDate |
0..1 | Extension | Extension | |
| 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 | "effectiveDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:expiryDate |
0..1 | Extension | Extension | |
| 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 | "expiryDate" | |
| value[x] |
0..1 | date | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/existing-approval" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: Detail of a conflicting Approval, returned only on the synchronous $submit response where the Application was
declined because a conflicting Approval exists. Not returned on Application Enquiry (D22).
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Existing Approval | |
| extension |
2..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:approvalType |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "approvalType" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Approval Type (extensible) | |
| extension:approvalNumber |
1..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "approvalNumber" | |
| value[x] |
0..1 | Identifier | Value of extension | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir-ig.digital.health.nz/special-authority/ns/approval-number (extensions allowed) | |
| value |
1..1 | string | The value that is unique | |
| extension:effectiveDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "effectiveDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:expiryDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "expiryDate" | |
| value[x] |
0..1 | date | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/existing-approval" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Existing Approval | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
2..* | 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:approvalType |
1..1 | Extension | Extension | |
| 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 | "approvalType" | |
| value[x] |
0..1 | code | Value of extension Binding: SA Approval Type (extensible) | |
| extension:approvalNumber |
1..1 | Extension | Extension | |
| 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 | "approvalNumber" | |
| value[x] |
0..1 | Identifier | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir-ig.digital.health.nz/special-authority/ns/approval-number (extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| extension:effectiveDate |
0..1 | Extension | Extension | |
| 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 | "effectiveDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:expiryDate |
0..1 | Extension | Extension | |
| 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 | "expiryDate" | |
| value[x] |
0..1 | date | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/existing-approval" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: Detail of a conflicting Approval, returned only on the synchronous $submit response where the Application was
declined because a conflicting Approval exists. Not returned on Application Enquiry (D22).
Other representations of profile: CSV, Excel, Schematron
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:approvalType.value[x] | Base | extensible | SA Approval Type | 📦0.1.1 | This IG |
| Extension.extension:approvalNumber.value[x].use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Extension.extension:approvalNumber.value[x].type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |