Profiles & Operations > Structure Definition: OperationOutcome Profile
Profile: OperationOutcome
Canonical URL: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-operationoutcome
Simplifier project page: MHA OperationOutcome
Derived from: OperationOutcome (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
| OperationOutcome | C | OperationOutcome | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| issue | S Σ | 1..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| severity | S Σ | 1..1 | codeBinding |
| code | S Σ | 1..1 | codeBinding |
| details | S Σ | 0..1 | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ | 0..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 0..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ | 0..1 | code |
| display | S Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| diagnostics | S Σ | 0..1 | string |
| location | Σ | 0..* | string |
| expression | S Σ | 0..* | string |
Hybrid View
| OperationOutcome | C | OperationOutcome | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| issue | S Σ | 1..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| severity | S Σ | 1..1 | codeBinding |
| code | S Σ | 1..1 | codeBinding |
| details | S Σ | 0..1 | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ | 0..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 0..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ | 0..1 | code |
| display | S Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| diagnostics | S Σ | 0..1 | string |
| location | Σ | 0..* | string |
| expression | S Σ | 0..* | string |
Snapshot View
| OperationOutcome | C | OperationOutcome | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| issue | S Σ | 1..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| severity | S Σ | 1..1 | codeBinding |
| code | S Σ | 1..1 | codeBinding |
| details | S Σ | 0..1 | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ | 0..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 0..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ | 0..1 | code |
| display | S Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| diagnostics | S Σ | 0..1 | string |
| location | Σ | 0..* | string |
| expression | S Σ | 0..* | string |
Table View
| OperationOutcome | 0..* | |
| OperationOutcome.id | string | 0..1 |
| OperationOutcome.meta | Meta | 0..1 |
| OperationOutcome.implicitRules | uri | 0..1 |
| OperationOutcome.language | code | 0..1 |
| OperationOutcome.text | Narrative | 0..1 |
| OperationOutcome.contained | Resource | 0..* |
| OperationOutcome.extension | Extension | 0..* |
| OperationOutcome.modifierExtension | Extension | 0..* |
| OperationOutcome.issue | BackboneElement | 1..* |
| OperationOutcome.issue.id | string | 0..1 |
| OperationOutcome.issue.extension | Extension | 0..* |
| OperationOutcome.issue.modifierExtension | Extension | 0..* |
| OperationOutcome.issue.severity | code | 1..1 |
| OperationOutcome.issue.code | code | 1..1 |
| OperationOutcome.issue.details | CodeableConcept | 0..1 |
| OperationOutcome.issue.details.id | string | 0..1 |
| OperationOutcome.issue.details.extension | Extension | 0..* |
| OperationOutcome.issue.details.coding | Coding | 0..1 |
| OperationOutcome.issue.details.coding.id | string | 0..1 |
| OperationOutcome.issue.details.coding.extension | Extension | 0..* |
| OperationOutcome.issue.details.coding.system | uri | 0..1 |
| OperationOutcome.issue.details.coding.version | string | 0..1 |
| OperationOutcome.issue.details.coding.code | code | 0..1 |
| OperationOutcome.issue.details.coding.display | string | 0..1 |
| OperationOutcome.issue.details.coding.userSelected | boolean | 0..1 |
| OperationOutcome.issue.details.text | string | 0..1 |
| OperationOutcome.issue.diagnostics | string | 0..1 |
| OperationOutcome.issue.location | string | 0..* |
| OperationOutcome.issue.expression | string | 0..* |
JSON View
{
{
"definition": "A collection of error, warning, or information messages that result from a system action.",
"comment": "Can result from the failure of a REST call or be part of the response message returned from a request message.",
},
{
},
{
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
},
{
"human": "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",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
},
{
{
},
{
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
},
{
}
],
{
},
{
"map": "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"
}
]
},
{
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
},
{
{
}
],
}
],
},
{
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
},
],
"ele-1"
],
{
}
],
]
},
{
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
},
],
"ele-1"
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
]
},
{
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
},
],
"ele-1"
],
{
}
],
{
},
{
}
],
},
]
},
{
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"narrative",
"html",
"xhtml",
"display"
],
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"inline resources",
"anonymous resources",
"contained resources"
],
},
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
]
},
{
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
"ele-1"
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
"comment": "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.",
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
"map": "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]"
}
]
},
{
"definition": "Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.",
"requirements": "Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.\n\nThe required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.",
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "Additional details about the error. This may be a text description of the error or a system code that identifies the error.",
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
{
}
],
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
}
]
},
{
{
}
],
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"comment": "This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name.",
"comment": "The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.",
"requirements": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.",
"comment": "The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.",
"requirements": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
}
]
}
]
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
}
]
}
}
Usage
The OperationOutcome resource is returned if an error or warning is generated when processing the query. It contains information that user can use to troubleshoot. For this project, the OperationOutcome profile is designed exclusively for validation and processing errors encountered during POST requests (data submission). Servers must return an OperationOutcome conforming to this profile whenever a submission fails validation.
See Response Handling for more information.
Notes
.issue.severity
- SHALL contain a code indicating the severity of the issue, e.g. error, fatal, warning, etc
.issue.code
- SHALL contain a code indicating the nature of the issue. Systems MAY create logic based on the specific code returned.
.issue.details.text
- SHALL contain a detailed description of the issue. This content should always be displayed to the user.