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

Resource Profile: SA Outcome OperationOutcome

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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
OperationOutcome.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
OperationOutcome.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
OperationOutcome.issue This element must be supported. This element is included in summaries. 1..1 BackboneElement A single issue associated with the action
OperationOutcome.issue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationOutcome.issue.severity This element must be supported. This element is included in summaries. 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
OperationOutcome.issue.code This element must be supported. This element is included in summaries. 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
OperationOutcome.issue.details This element must be supported. This element is included in summaries. 1..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
OperationOutcome.issue.details.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
Binding: SA Outcome Code (extensible)
OperationOutcome.issue.diagnostics This element must be supported. This element is included in summaries. 0..1 string Additional diagnostic information about the issue

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
OperationOutcome.issue This element must be supported. 1..1 BackboneElement A single issue associated with the action
OperationOutcome.issue.severity This element must be supported. 1..1 code fatal | error | warning | information
OperationOutcome.issue.code This element must be supported. 1..1 code Error or warning code
OperationOutcome.issue.details This element must be supported. 1..1 CodeableConcept Additional details about the error
OperationOutcome.issue.details.coding This element must be supported. 1..* Coding Code defined by a terminology system
Binding: SA Outcome Code (extensible)
OperationOutcome.issue.diagnostics This element must be supported. 0..1 string Additional diagnostic information about the issue

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
OperationOutcome.issue.​details.coding Base extensible SA Outcome Code 📦0.1.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
OperationOutcome.id This element is included in summaries. 0..1 id Logical id of this artifact
OperationOutcome.meta This element is included in summaries. 0..1 Meta Metadata about the resource
OperationOutcome.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
OperationOutcome.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
OperationOutcome.text 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
OperationOutcome.contained 0..* Resource Contained, inline Resources
OperationOutcome.extension 0..* Extension Additional content defined by implementations
OperationOutcome.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
OperationOutcome.issue This element must be supported. This element is included in summaries. 1..1 BackboneElement A single issue associated with the action
OperationOutcome.issue.id 0..1 string Unique id for inter-element referencing
OperationOutcome.issue.extension 0..* Extension Additional content defined by implementations
OperationOutcome.issue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationOutcome.issue.severity This element must be supported. This element is included in summaries. 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
OperationOutcome.issue.code This element must be supported. This element is included in summaries. 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
OperationOutcome.issue.details This element must be supported. This element is included in summaries. 1..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
OperationOutcome.issue.details.id 0..1 string Unique id for inter-element referencing
OperationOutcome.issue.details.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
OperationOutcome.issue.details.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
Binding: SA Outcome Code (extensible)
OperationOutcome.issue.details.text This element is included in summaries. 0..1 string Plain text representation of the concept
OperationOutcome.issue.diagnostics This element must be supported. This element is included in summaries. 0..1 string Additional diagnostic information about the issue
OperationOutcome.issue.location This element is included in summaries. 0..* string Deprecated: Path of element(s) related to issue
OperationOutcome.issue.expression This element is included in summaries. 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression

This structure is derived from OperationOutcome

Summary

Mandatory: 2 elements
Must-Support: 6 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
OperationOutcome.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
OperationOutcome.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
OperationOutcome.issue This element must be supported. This element is included in summaries. 1..1 BackboneElement A single issue associated with the action
OperationOutcome.issue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationOutcome.issue.severity This element must be supported. This element is included in summaries. 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
OperationOutcome.issue.code This element must be supported. This element is included in summaries. 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
OperationOutcome.issue.details This element must be supported. This element is included in summaries. 1..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
OperationOutcome.issue.details.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
Binding: SA Outcome Code (extensible)
OperationOutcome.issue.diagnostics This element must be supported. This element is included in summaries. 0..1 string Additional diagnostic information about the issue

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
OperationOutcome.issue This element must be supported. 1..1 BackboneElement A single issue associated with the action
OperationOutcome.issue.severity This element must be supported. 1..1 code fatal | error | warning | information
OperationOutcome.issue.code This element must be supported. 1..1 code Error or warning code
OperationOutcome.issue.details This element must be supported. 1..1 CodeableConcept Additional details about the error
OperationOutcome.issue.details.coding This element must be supported. 1..* Coding Code defined by a terminology system
Binding: SA Outcome Code (extensible)
OperationOutcome.issue.diagnostics This element must be supported. 0..1 string Additional diagnostic information about the issue

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
OperationOutcome.issue.​details.coding Base extensible SA Outcome Code 📦0.1.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
OperationOutcome.id This element is included in summaries. 0..1 id Logical id of this artifact
OperationOutcome.meta This element is included in summaries. 0..1 Meta Metadata about the resource
OperationOutcome.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
OperationOutcome.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
OperationOutcome.text 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
OperationOutcome.contained 0..* Resource Contained, inline Resources
OperationOutcome.extension 0..* Extension Additional content defined by implementations
OperationOutcome.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
OperationOutcome.issue This element must be supported. This element is included in summaries. 1..1 BackboneElement A single issue associated with the action
OperationOutcome.issue.id 0..1 string Unique id for inter-element referencing
OperationOutcome.issue.extension 0..* Extension Additional content defined by implementations
OperationOutcome.issue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationOutcome.issue.severity This element must be supported. This element is included in summaries. 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
OperationOutcome.issue.code This element must be supported. This element is included in summaries. 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
OperationOutcome.issue.details This element must be supported. This element is included in summaries. 1..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
OperationOutcome.issue.details.id 0..1 string Unique id for inter-element referencing
OperationOutcome.issue.details.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
OperationOutcome.issue.details.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
Binding: SA Outcome Code (extensible)
OperationOutcome.issue.details.text This element is included in summaries. 0..1 string Plain text representation of the concept
OperationOutcome.issue.diagnostics This element must be supported. This element is included in summaries. 0..1 string Additional diagnostic information about the issue
OperationOutcome.issue.location This element is included in summaries. 0..* string Deprecated: Path of element(s) related to issue
OperationOutcome.issue.expression This element is included in summaries. 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression

This structure is derived from OperationOutcome

Summary

Mandatory: 2 elements
Must-Support: 6 elements

 

Other representations of profile: CSV, Excel, Schematron