Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core OperationOutcome

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-operationoutcome-core-1 Version: 0.0.2
Draft as of 2024-12-19 Computable Name: ADHAOperationOutcomeCore

Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO.

The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted.

All copies of this resource must include this copyright statement and all information contained in this statement.

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

This profile may be referred to by APIs, which will be listed here when available.

Boundaries and relationships

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

Usage:

Formal Views of Profile Content

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

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... issue S 1..* BackboneElement A single issue associated with the action
.... severity S 1..1 code fatal | error | warning | information
.... code S 1..1 code Error or warning code
.... details S 1..1 CodeableConcept Additional details about the error
.... diagnostics S 0..1 string Additional diagnostic information about the issue

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... issue SΣ 1..* BackboneElement A single issue associated with the action
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.


ele-1: All FHIR elements must have a @value or children
.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.


ele-1: All FHIR elements must have a @value or children
.... details SΣ 1..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.


ele-1: All FHIR elements must have a @value or children
.... diagnostics SΣ 0..1 string Additional diagnostic information about the issue
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OperationOutcome.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
from the FHIR Standard
OperationOutcome.issue.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
from the FHIR Standard
OperationOutcome.issue.detailsexampleOperationOutcomeCodes
http://hl7.org/fhir/ValueSet/operation-outcome
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... issue SΣ 1..* BackboneElement A single issue associated with the action
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

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

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

.... diagnostics SΣ 0..1 string Additional diagnostic information about the issue
.... location Σ 0..* string Deprecated: Path of element(s) related to issue
.... expression Σ 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OperationOutcome.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
from the FHIR Standard
OperationOutcome.issue.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
from the FHIR Standard
OperationOutcome.issue.detailsexampleOperationOutcomeCodes
http://hl7.org/fhir/ValueSet/operation-outcome
from the FHIR Standard

This structure is derived from OperationOutcome

Summary

Mandatory: 1 element
Must-Support: 5 elements

Differential View

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... issue S 1..* BackboneElement A single issue associated with the action
.... severity S 1..1 code fatal | error | warning | information
.... code S 1..1 code Error or warning code
.... details S 1..1 CodeableConcept Additional details about the error
.... diagnostics S 0..1 string Additional diagnostic information about the issue

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... issue SΣ 1..* BackboneElement A single issue associated with the action
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.


ele-1: All FHIR elements must have a @value or children
.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.


ele-1: All FHIR elements must have a @value or children
.... details SΣ 1..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.


ele-1: All FHIR elements must have a @value or children
.... diagnostics SΣ 0..1 string Additional diagnostic information about the issue
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OperationOutcome.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
from the FHIR Standard
OperationOutcome.issue.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
from the FHIR Standard
OperationOutcome.issue.detailsexampleOperationOutcomeCodes
http://hl7.org/fhir/ValueSet/operation-outcome
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... issue SΣ 1..* BackboneElement A single issue associated with the action
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

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

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

.... diagnostics SΣ 0..1 string Additional diagnostic information about the issue
.... location Σ 0..* string Deprecated: Path of element(s) related to issue
.... expression Σ 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OperationOutcome.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
from the FHIR Standard
OperationOutcome.issue.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
from the FHIR Standard
OperationOutcome.issue.detailsexampleOperationOutcomeCodes
http://hl7.org/fhir/ValueSet/operation-outcome
from the FHIR Standard

This structure is derived from OperationOutcome

Summary

Mandatory: 1 element
Must-Support: 5 elements

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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.