Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
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
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-operationoutcome-core-1 | Version: 0.0.2 | |||
| Draft as of 2024-09-12 | 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:
This profile may be referred to by APIs, which will be listed here when available.
This profile is not referenced by another profile in this implementation guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from OperationOutcome
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OperationOutcome |
0..* | OperationOutcome | Information about the success/failure of an action | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 issue |
SΣ | 1..* | BackboneElement | A single issue associated with the action |
| 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| OperationOutcome.issue.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | |
| OperationOutcome.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | |
| OperationOutcome.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| OperationOutcome.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| OperationOutcome.issue.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard |
This structure is derived from OperationOutcome
Differential View
This structure is derived from OperationOutcome
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OperationOutcome |
0..* | OperationOutcome | Information about the success/failure of an action | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| issue |
SΣ | 1..* | BackboneElement | A single issue associated with the action |
| 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| OperationOutcome.issue.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | |
| OperationOutcome.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | |
| OperationOutcome.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| OperationOutcome.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| OperationOutcome.issue.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard |
This structure is derived from OperationOutcome
Other representations of profile: CSV, Excel, Schematron
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.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-09-12
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
