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/sa-outcome-operationoutcome | Version: 0.1.1 | |||
| Draft as of 2026-10-16 | Computable Name: SAOutcomeOperationOutcome | |||
Renders the single business outcome of a Special Authority Application (D9) in a $submit response. The machine readable
reason (outcomeCode) is carried in issue.details.coding and the human readable reason (outcomeReason) in
issue.diagnostics.
This profile does not apply to OperationOutcomes returned with HTTP 4xx/5xx for requests rejected by the API before reaching the service (e.g. profile validation failures), which may carry several issues.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | BackboneElement | A single issue associated with the action | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | |
![]() ![]() ![]() |
1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Binding: SA Outcome Code (extensible) | |
![]() ![]() ![]() |
0..1 | string | Additional diagnostic information about the issue | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.issue.severity | Base | required | IssueSeverity | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.code | Base | required | IssueType | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.details | Base | example | Operation Outcome Codes | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.details.coding | Base | extensible | SA Outcome Code | 📦0.1.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from OperationOutcome
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |
![]() ![]() |
1..1 | BackboneElement | A single issue associated with the action | |
![]() ![]() ![]() |
1..1 | code | fatal | error | warning | information | |
![]() ![]() ![]() |
1..1 | code | Error or warning code | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Additional details about the error | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Binding: SA Outcome Code (extensible) | |
![]() ![]() ![]() |
0..1 | string | Additional diagnostic information about the issue | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.issue.details.coding | Base | extensible | SA Outcome Code | 📦0.1.1 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..1 | BackboneElement | A single issue associated with the action | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | |||||
![]() ![]() ![]() |
1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Binding: SA Outcome Code (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
0..1 | string | Additional diagnostic information about the issue | |||||
![]() ![]() ![]() |
0..* | string | Deprecated: Path of element(s) related to issue | |||||
![]() ![]() ![]() |
0..* | string | FHIRPath of element(s) related to issue | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.severity | Base | required | IssueSeverity | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.code | Base | required | IssueType | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.details | Base | example | Operation Outcome Codes | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.details.coding | Base | extensible | SA Outcome Code | 📦0.1.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from OperationOutcome
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | BackboneElement | A single issue associated with the action | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | |
![]() ![]() ![]() |
1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Binding: SA Outcome Code (extensible) | |
![]() ![]() ![]() |
0..1 | string | Additional diagnostic information about the issue | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.issue.severity | Base | required | IssueSeverity | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.code | Base | required | IssueType | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.details | Base | example | Operation Outcome Codes | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.details.coding | Base | extensible | SA Outcome Code | 📦0.1.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from OperationOutcome
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |
![]() ![]() |
1..1 | BackboneElement | A single issue associated with the action | |
![]() ![]() ![]() |
1..1 | code | fatal | error | warning | information | |
![]() ![]() ![]() |
1..1 | code | Error or warning code | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Additional details about the error | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Binding: SA Outcome Code (extensible) | |
![]() ![]() ![]() |
0..1 | string | Additional diagnostic information about the issue | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.issue.details.coding | Base | extensible | SA Outcome Code | 📦0.1.1 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..1 | BackboneElement | A single issue associated with the action | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | |||||
![]() ![]() ![]() |
1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Binding: SA Outcome Code (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
0..1 | string | Additional diagnostic information about the issue | |||||
![]() ![]() ![]() |
0..* | string | Deprecated: Path of element(s) related to issue | |||||
![]() ![]() ![]() |
0..* | string | FHIRPath of element(s) related to issue | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.severity | Base | required | IssueSeverity | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.code | Base | required | IssueType | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.details | Base | example | Operation Outcome Codes | 📍4.0.1 | FHIR Std. |
| OperationOutcome.issue.details.coding | Base | extensible | SA Outcome Code | 📦0.1.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from OperationOutcome
Other representations of profile: CSV, Excel, Schematron