Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

StructureDefinition: ADHA Core OperationOutcome [Active]

The purpose of this profile is to define a representation of the outcome of an attempted system operation for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend OperationOutcome that are supported.

This profile is designed to set an OperationOutcome standard for:

  • all FHIR system responses

Boundaries and relationships

This profile is not referenced by another profile in this implementation guide.

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-operationoutcome-core-1

The purpose of this profile is to define a representation of the outcome of an attempted system operation for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile builds on OperationOutcome.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... issue S1..*BackboneElementA single issue associated with the action
.... severity S1..1codefatal | error | warning | information
.... code S1..1codeError or warning code
.... details S1..1CodeableConceptAdditional details about the error
.... diagnostics S0..1stringAdditional diagnostic information about the issue

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... issue SΣ1..*BackboneElementA single issue associated with the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... severity SΣ1..1codefatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

.... code SΣ1..1codeError or warning code
Binding: IssueType (required): A code that describes the type of issue.

.... details SΣ1..1CodeableConceptAdditional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.

.... diagnostics SΣ0..1stringAdditional diagnostic information about the issue
.... location Σ0..*stringDeprecated: Path of element(s) related to issue
.... expression Σ0..*stringFHIRPath of element(s) related to issue

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... issue S1..*BackboneElementA single issue associated with the action
.... severity S1..1codefatal | error | warning | information
.... code S1..1codeError or warning code
.... details S1..1CodeableConceptAdditional details about the error
.... diagnostics S0..1stringAdditional diagnostic information about the issue

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... issue SΣ1..*BackboneElementA single issue associated with the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... severity SΣ1..1codefatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

.... code SΣ1..1codeError or warning code
Binding: IssueType (required): A code that describes the type of issue.

.... details SΣ1..1CodeableConceptAdditional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.

.... diagnostics SΣ0..1stringAdditional diagnostic information about the issue
.... location Σ0..*stringDeprecated: Path of element(s) related to issue
.... expression Σ0..*stringFHIRPath of element(s) related to issue

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
OperationOutcome.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
OperationOutcome.issue.coderequiredIssueType
OperationOutcome.issue.detailsexampleOperationOutcomeCodes

Search Parameters

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.