OperationOutcome
Operation outcomes are sets of error, warning and information messages that provide detailed information about the outcome of an attempted system operation. They are provided as a direct system response or component of one and provide information about the outcome of the operation.
The OperationOutcome resource is used in the following circumstances:
Overview
This is the tree for the Operation Outcome resource in the RDC EMR Implementation project. You can find the resource on https://simplifier.net/rdcemrintegrations/operation-outcome. Notice that the path in the URL is exactly the same as the placeholder.
OperationOutcome | I | OperationOutcome | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | I | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
issue | Σ | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
severity | Σ ?! | 1..1 | codeBinding |
code | Σ | 1..1 | codeBinding |
details | Σ | 0..1 | CodeableConcept |
diagnostics | Σ | 0..1 | string |
location | Σ | 0..* | string |
expression | Σ | 0..* | string |
Details
OperationOutcome | |
Definition | A collection of error, warning or information messages that result from a system action. |
Cardinality | 0...* |
Comments | Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message. |
Invariants |
|
Mappings |
|
OperationOutcome.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Invariants |
|
Mappings |
|
OperationOutcome.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
OperationOutcome.implicitRules | |
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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Invariants |
|
Mappings |
|
OperationOutcome.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. Common Languages (extensible) |
Comments | 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). |
Invariants |
|
Mappings |
|
OperationOutcome.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | 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 in formation is added later. |
Invariants |
|
Mappings |
|
OperationOutcome.contained | |
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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | 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. |
Mappings |
|
OperationOutcome.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OperationOutcome.modifierExtension | |
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. Usually modifier elements provide negation or qualification. In order 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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OperationOutcome.issue | |
Definition | An error, warning or information message that results from a system action. |
Cardinality | 1...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
OperationOutcome.issue.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
OperationOutcome.issue.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OperationOutcome.issue.modifierExtension | |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Comments | 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. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.severity | |
Definition | Indicates whether the issue indicates a variation from successful processing. |
Cardinality | 1...1 |
Type | code |
Binding | How the issue affects the success of the action. IssueSeverity (required) |
Modifier | True |
Summary | True |
Requirements | Indicates how relevant the issue is to the overall success of the action. |
Comments | This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.code | |
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. |
Cardinality | 1...1 |
Type | code |
Binding | A code that describes the type of issue. IssueType (required) |
Summary | True |
Requirements | Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details | |
Definition | Additional details about the error. This may be a text description of the error, or a system code that identifies the error. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A code that provides details as the exact issue. Operation Outcome Codes (example) |
Summary | True |
Comments | A human readable description of the error issue SHOULD be placed in details.text. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.diagnostics | |
Definition | Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Typically this field is used to provide troubleshooting information about the error. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.location | |
Definition | For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child access 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. |
Cardinality | 0...* |
Type | string |
Summary | True |
Requirements | Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. |
Comments | The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON. Note that expression is being trialed as an alternative to XPath. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.expression | |
Definition | A simple FHIRPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised. |
Cardinality | 0...* |
Type | string |
Summary | True |
Requirements | Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. |
Comments | The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node. |
Invariants |
|
Mappings |
|
Table
This is the table for the Operation Outcome resource in the RDC EMR Implementation project. You can find the resource on https://simplifier.net/rdcemrintegrations/operation-outcome. Notice that the path in the URL is exactly the same as the placeholder.
OperationOutcome | 0..* | |
OperationOutcome.id | id | 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.diagnostics | string | 0..1 |
OperationOutcome.issue.location | string | 0..* |
OperationOutcome.issue.expression | string | 0..* |
XML
<StructureDefinition xmlns="http://hl7.org/fhir"> <url value="http://roche.com/fhir/rdc/StructureDefinition/OperationOutcome" /> <name value="OperationOutcome" /> <status value="active" /> <fhirVersion value="3.0.2" /> <kind value="resource" /> <abstract value="false" /> <type value="OperationOutcome" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/OperationOutcome" /> <derivation value="constraint" /> <snapshot> <element id="OperationOutcome"> <path value="OperationOutcome" /> <short value="Information about the success/failure of an action" /> <definition value="A collection of error, warning or information messages that result from a system action." /> <comment value="Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message." /> <min value="0" /> <max value="*" /> <base> <path value="Resource" /> <min value="0" /> <max value="*" /> </base> <constraint> <key value="dom-2" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" /> <expression value="contained.contained.empty()" /> <xpath value="not(parent::f:contained and f:contained)" /> </constraint> <constraint> <key value="dom-1" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative" /> <expression value="contained.text.empty()" /> <xpath value="not(parent::f:contained and f:text)" /> </constraint> <constraint> <key value="dom-4" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" /> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" /> </constraint> <constraint> <key value="dom-3" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource" /> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()" /> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))" /> </constraint> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)" /> </mapping> <mapping> <identity value="w5" /> <map value="infrastructure.exchange" /> </mapping> </element> <element id="OperationOutcome.id"> <path value="OperationOutcome.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <code value="id" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="OperationOutcome.meta"> <path value="OperationOutcome.meta" /> <short value="Metadata about the resource" /> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="OperationOutcome.implicitRules"> <path value="OperationOutcome.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content." /> <comment value="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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isModifier value="true" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="OperationOutcome.language"> <path value="OperationOutcome.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="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)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages" /> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="extensible" /> <description value="A human language." /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="OperationOutcome.text"> <path value="OperationOutcome.text" /> <short value="Text summary of the resource, for human interpretation" /> <definition value="A human-readable narrative that contains a summary of the resource, and may 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 value="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 in formation is added later." /> <alias value="narrative" /> <alias value="html" /> <alias value="xhtml" /> <alias value="display" /> <min value="0" /> <max value="1" /> <base> <path value="DomainResource.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Narrative" /> </type> <condition value="ele-1" /> <condition value="dom-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act.text?" /> </mapping> </element> <element id="OperationOutcome.contained"> <path value="OperationOutcome.contained" /> <short value="Contained, inline Resources" /> <definition value="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 value="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." /> <alias value="inline resources" /> <alias value="anonymous resources" /> <alias value="contained resources" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.contained" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Resource" /> </type> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="OperationOutcome.extension"> <path value="OperationOutcome.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional Content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order 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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="OperationOutcome.modifierExtension"> <path value="OperationOutcome.modifierExtension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Extensions that cannot be ignored" /> <definition value="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. Usually modifier elements provide negation or qualification. In order 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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <isModifier value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="OperationOutcome.issue"> <path value="OperationOutcome.issue" /> <short value="A single issue associated with the action" /> <definition value="An error, warning or information message that results from a system action." /> <min value="1" /> <max value="*" /> <base> <path value="OperationOutcome.issue" /> <min value="1" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="ERR" /> </mapping> <mapping> <identity value="rim" /> <map value="AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]" /> </mapping> </element> <element id="OperationOutcome.issue.id"> <path value="OperationOutcome.issue.id" /> <representation value="xmlAttr" /> <short value="xml:id (or equivalent in JSON)" /> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="OperationOutcome.issue.extension"> <path value="OperationOutcome.issue.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional Content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="OperationOutcome.issue.modifierExtension"> <path value="OperationOutcome.issue.modifierExtension" /> <short value="Extensions that cannot be ignored" /> <definition value="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 that contains it. Usually modifier elements provide negation or qualification. In order 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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <isModifier value="true" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="OperationOutcome.issue.severity"> <path value="OperationOutcome.issue.severity" /> <short value="fatal | error | warning | information" /> <definition value="Indicates whether the issue indicates a variation from successful processing." /> <comment value="This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors." /> <requirements value="Indicates how relevant the issue is to the overall success of the action." /> <min value="1" /> <max value="1" /> <base> <path value="OperationOutcome.issue.severity" /> <min value="1" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isModifier value="true" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="IssueSeverity" /> </extension> <strength value="required" /> <description value="How the issue affects the success of the action." /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/issue-severity" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="ERR-4" /> </mapping> <mapping> <identity value="rim" /> <map value="./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"]" /> </mapping> </element> <element id="OperationOutcome.issue.code"> <path value="OperationOutcome.issue.code" /> <short value="Error or warning code" /> <definition value="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." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <requirements value="Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue." /> <min value="1" /> <max value="1" /> <base> <path value="OperationOutcome.issue.code" /> <min value="1" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="IssueType" /> </extension> <strength value="required" /> <description value="A code that describes the type of issue." /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/issue-type" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="ERR-3" /> </mapping> <mapping> <identity value="rim" /> <map value="./code" /> </mapping> </element> <element id="OperationOutcome.issue.details"> <path value="OperationOutcome.issue.details" /> <short value="Additional details about the error" /> <definition value="Additional details about the error. This may be a text description of the error, or a system code that identifies the error." /> <comment value="A human readable description of the error issue SHOULD be placed in details.text." /> <min value="0" /> <max value="1" /> <base> <path value="OperationOutcome.issue.details" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="IssueDetails" /> </extension> <strength value="example" /> <description value="A code that provides details as the exact issue." /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/operation-outcome" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="v2" /> <map value="ERR-5" /> </mapping> <mapping> <identity value="rim" /> <map value="./code" /> </mapping> </element> <element id="OperationOutcome.issue.diagnostics"> <path value="OperationOutcome.issue.diagnostics" /> <short value="Additional diagnostic information about the issue" /> <definition value="Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue." /> <comment value="Typically this field is used to provide troubleshooting information about the error." /> <min value="0" /> <max value="1" /> <base> <path value="OperationOutcome.issue.diagnostics" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="ERR-8" /> </mapping> <mapping> <identity value="rim" /> <map value="./text[parent::AcknowledgmentDetail]" /> </mapping> </element> <element id="OperationOutcome.issue.location"> <path value="OperationOutcome.issue.location" /> <short value="Path of element(s) related to issue" /> <definition value="For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child access 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 value="The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON. Note that expression is being trialed as an alternative to XPath." /> <requirements value="Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily." /> <min value="0" /> <max value="*" /> <base> <path value="OperationOutcome.issue.location" /> <min value="0" /> <max value="*" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="ERR-2" /> </mapping> <mapping> <identity value="rim" /> <map value="./location[parent::AcknowledgmentDetail]" /> </mapping> </element> <element id="OperationOutcome.issue.expression"> <path value="OperationOutcome.issue.expression" /> <short value="FHIRPath of element(s) related to issue" /> <definition value="A simple FHIRPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised." /> <comment value="The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node." /> <requirements value="Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily." /> <min value="0" /> <max value="*" /> <base> <path value="OperationOutcome.issue.expression" /> <min value="0" /> <max value="*" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="ERR-2" /> </mapping> <mapping> <identity value="rim" /> <map value="./location[parent::AcknowledgmentDetail]" /> </mapping> </element> </snapshot> </StructureDefinition>
JSON
{ "resourceType": "StructureDefinition", "url": "http://roche.com/fhir/rdc/StructureDefinition/OperationOutcome", "name": "OperationOutcome", "status": "active", "fhirVersion": "3.0.2", "kind": "resource", "abstract": false, "type": "OperationOutcome", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/OperationOutcome", "derivation": "constraint", "snapshot": { "element": [ { "id": "OperationOutcome", "path": "OperationOutcome", "short": "Information about the success/failure of an action", "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. If sent with extensions overriding particular issues, might even appear as part of a request message.", "min": 0, "max": "*", "base": { "path": "Resource", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)" }, { "identity": "w5", "map": "infrastructure.exchange" } ] }, { "id": "OperationOutcome.id", "path": "OperationOutcome.id", "short": "Logical id of this artifact", "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.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "OperationOutcome.meta", "path": "OperationOutcome.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "OperationOutcome.implicitRules", "path": "OperationOutcome.implicitRules", "short": "A set of rules under which this content was created", "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.", "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "OperationOutcome.language", "path": "OperationOutcome.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "OperationOutcome.text", "path": "OperationOutcome.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1", "dom-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "OperationOutcome.contained", "path": "OperationOutcome.contained", "short": "Contained, inline Resources", "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "OperationOutcome.extension", "path": "OperationOutcome.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "OperationOutcome.modifierExtension", "path": "OperationOutcome.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "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. Usually modifier elements provide negation or qualification. In order 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "OperationOutcome.issue", "path": "OperationOutcome.issue", "short": "A single issue associated with the action", "definition": "An error, warning or information message that results from a system action.", "min": 1, "max": "*", "base": { "path": "OperationOutcome.issue", "min": 1, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ERR" }, { "identity": "rim", "map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]" } ] }, { "id": "OperationOutcome.issue.id", "path": "OperationOutcome.issue.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "OperationOutcome.issue.extension", "path": "OperationOutcome.issue.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "OperationOutcome.issue.modifierExtension", "path": "OperationOutcome.issue.modifierExtension", "short": "Extensions that cannot be ignored", "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "OperationOutcome.issue.severity", "path": "OperationOutcome.issue.severity", "short": "fatal | error | warning | information", "definition": "Indicates whether the issue indicates a variation from successful processing.", "comment": "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.", "requirements": "Indicates how relevant the issue is to the overall success of the action.", "min": 1, "max": "1", "base": { "path": "OperationOutcome.issue.severity", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IssueSeverity" } ], "strength": "required", "description": "How the issue affects the success of the action.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/issue-severity" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ERR-4" }, { "identity": "rim", "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\"]" } ] }, { "id": "OperationOutcome.issue.code", "path": "OperationOutcome.issue.code", "short": "Error or warning code", "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.", "comment": "Note that FHIR strings may not exceed 1MB in size", "requirements": "Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.", "min": 1, "max": "1", "base": { "path": "OperationOutcome.issue.code", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IssueType" } ], "strength": "required", "description": "A code that describes the type of issue.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/issue-type" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ERR-3" }, { "identity": "rim", "map": "./code" } ] }, { "id": "OperationOutcome.issue.details", "path": "OperationOutcome.issue.details", "short": "Additional details about the error", "definition": "Additional details about the error. This may be a text description of the error, or a system code that identifies the error.", "comment": "A human readable description of the error issue SHOULD be placed in details.text.", "min": 0, "max": "1", "base": { "path": "OperationOutcome.issue.details", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IssueDetails" } ], "strength": "example", "description": "A code that provides details as the exact issue.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/operation-outcome" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "ERR-5" }, { "identity": "rim", "map": "./code" } ] }, { "id": "OperationOutcome.issue.diagnostics", "path": "OperationOutcome.issue.diagnostics", "short": "Additional diagnostic information about the issue", "definition": "Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.", "comment": "Typically this field is used to provide troubleshooting information about the error.", "min": 0, "max": "1", "base": { "path": "OperationOutcome.issue.diagnostics", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ERR-8" }, { "identity": "rim", "map": "./text[parent::AcknowledgmentDetail]" } ] }, { "id": "OperationOutcome.issue.location", "path": "OperationOutcome.issue.location", "short": "Path of element(s) related to issue", "definition": "For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child access 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. The XPath syntax is used whether the referenced instance is expressed in XML or JSON. Note that expression is being trialed as an alternative to XPath.", "requirements": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.", "min": 0, "max": "*", "base": { "path": "OperationOutcome.issue.location", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ERR-2" }, { "identity": "rim", "map": "./location[parent::AcknowledgmentDetail]" } ] }, { "id": "OperationOutcome.issue.expression", "path": "OperationOutcome.issue.expression", "short": "FHIRPath of element(s) related to issue", "definition": "A simple FHIRPath limited to element names, repetition indicators and the default child access 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.", "min": 0, "max": "*", "base": { "path": "OperationOutcome.issue.expression", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ERR-2" }, { "identity": "rim", "map": "./location[parent::AcknowledgmentDetail]" } ] } ] } }