3.67 StructureDefinition: Shared Health Operation Outcome
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/profile-operationoutcome
3.67.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from OperationOutcome
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 OperationOutcome | 0..* | OperationOutcome | Definition: A collection of error, warning or information messages that result from a system action. Comments: Conformance Rule: If user-friendly issue text is present, it must be displayed to user. The user should also be able to see the more detailed description if they wish. If there is no user-friendly issue text returned, the vendor may present one that is fitting or may present the more detailed description. Conformance Rule: Vendors should not display any Operation Outcomes that are returned with an OperationOutcome.issue.severity = 'Information'. Conformance Rule: If a code is received that is not recognized, please process and display human readable text. |
 id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. |
 issue | 1..* | BackboneElement | Definition: An error, warning or information message that results from a system action. Comments: Conformance Rule: We are currently only returning a single issue element at this time. |
 extension(referenceNum) | 0..1 | Issue reference number | Definition: This reference number acts as a transaction locator number and may be provided to PrescribeIT® support team for troubleshooting purposes. Vendors may wish to make this visible to users for this purpose. |
| extension (userText) | 0..1 | User-friendly issue text | Definition: Provides the user-friendly description associated with an OperationOutcome issue |
  url | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext" |
 value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| extension (userText-translation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing. |
| value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| extension (userText-translation-language) | 1..1 | language | Definition: The language in which the string is expressed. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-language" |
| severity | 1..1 | code | Binding: IssueSeverity (20190415) (required) Definition: Indicates whether the issue indicates a variation from successful processing. Comments: This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors. |
| code | 1..1 | code | Binding: IssueType (20190415) (required) 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. |
| details | 0..1 | CodeableConcept | Binding: SharedIssueDetails (extensible) Definition: Indicates the specific issue represented by this message. Comments: Conformance Rules: Details should be available to users if they wish to link to this information |
| coding | 0..1 | Coding | Definition: A reference to a code defined by a terminology system. Comments: 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 labelled as UserSelected = true. |
| code | 0..1 | code | 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). |
| text | 1..1 | string | 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. Comments: Conformance Rule: This MUST be populated with a description of the issue. |
| extension (details-translation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing. |
| value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| extension (details-translation-language) | 1..1 | language | Definition: The language in which the string is expressed. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-language" |
| diagnostics | 0..1 | string | 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. Comments: Usage Rule: This will contain a detailed technical description of the issue. Conformance Rule: If it is the only piece of error information returned then it must be displayed to the user otherwise display the other error fields and not this one. |
| location | 0..* | string | Definition: The human-readable description of the error, warning or information message. May convey additional details not present in the 'code', but is not intended to be human-processable. 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. |
This structure is derived from OperationOutcome
This structure is derived from OperationOutcome
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 OperationOutcome | SΣ | 0..* | OperationOutcome | Information about the success/failure of an action |
 id | SΣ | 1..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| issue | SΣ | 1..* | BackboneElement | A single issue associated with the action |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 ext-operationoutcome-referencenum | S | 0..1 | string | Issue reference number URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-referencenum |
| ext-operationoutcome-usertext | S | 0..1 | string | User-friendly issue text URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext" |
| value[x] | S | 1..1 | string | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" | |
| value[x] | S | 1..1 | string | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-language" |
| value[x] | 1..1 | code | Value of extension Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| severity | ?!SΣ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (20190415) (required) |
| code | SΣ | 1..1 | code | Error or warning code Binding: IssueType (20190415) (required) |
| details | SΣ | 0..1 | CodeableConcept | Additional details about the error Binding: SharedIssueDetails (extensible) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 0..1 | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" | |
| value[x] | S | 1..1 | string | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-language" |
| value[x] | 1..1 | code | Value of extension Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| diagnostics | SΣ | 0..1 | string | Additional diagnostic information about the issue |
| location | SΣ | 0..* | string | XPath of element(s) related to issue |
| expression | Σ | 0..* | string | FluentPath of element(s) related to issue |
| Documentation for this format | ||||
Grid View
This structure is derived from OperationOutcome
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| OperationOutcome | 0..* | OperationOutcome | Definition: A collection of error, warning or information messages that result from a system action. Comments: Conformance Rule: If user-friendly issue text is present, it must be displayed to user. The user should also be able to see the more detailed description if they wish. If there is no user-friendly issue text returned, the vendor may present one that is fitting or may present the more detailed description. Conformance Rule: Vendors should not display any Operation Outcomes that are returned with an OperationOutcome.issue.severity = 'Information'. Conformance Rule: If a code is received that is not recognized, please process and display human readable text. |
| id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. |
| issue | 1..* | BackboneElement | Definition: An error, warning or information message that results from a system action. Comments: Conformance Rule: We are currently only returning a single issue element at this time. |
| extension (referenceNum) | 0..1 | Issue reference number | Definition: This reference number acts as a transaction locator number and may be provided to PrescribeIT® support team for troubleshooting purposes. Vendors may wish to make this visible to users for this purpose. |
| extension (userText) | 0..1 | User-friendly issue text | Definition: Provides the user-friendly description associated with an OperationOutcome issue |
| url | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext" |
| value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| extension (userText-translation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing. |
| value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| extension (userText-translation-language) | 1..1 | language | Definition: The language in which the string is expressed. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-language" |
| severity | 1..1 | code | Binding: IssueSeverity (20190415) (required) Definition: Indicates whether the issue indicates a variation from successful processing. Comments: This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors. |
| code | 1..1 | code | Binding: IssueType (20190415) (required) 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. |
| details | 0..1 | CodeableConcept | Binding: SharedIssueDetails (extensible) Definition: Indicates the specific issue represented by this message. Comments: Conformance Rules: Details should be available to users if they wish to link to this information |
| coding | 0..1 | Coding | Definition: A reference to a code defined by a terminology system. Comments: 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 labelled as UserSelected = true. |
| code | 0..1 | code | 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). |
| text | 1..1 | string | 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. Comments: Conformance Rule: This MUST be populated with a description of the issue. |
| extension (details-translation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing. |
| value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| extension (details-translation-language) | 1..1 | language | Definition: The language in which the string is expressed. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-language" |
| diagnostics | 0..1 | string | 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. Comments: Usage Rule: This will contain a detailed technical description of the issue. Conformance Rule: If it is the only piece of error information returned then it must be displayed to the user otherwise display the other error fields and not this one. |
| location | 0..* | string | Definition: The human-readable description of the error, warning or information message. May convey additional details not present in the 'code', but is not intended to be human-processable. 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. |
This structure is derived from OperationOutcome
Differential View
This structure is derived from OperationOutcome
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OperationOutcome | SΣ | 0..* | OperationOutcome | Information about the success/failure of an action |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| issue | SΣ | 1..* | BackboneElement | A single issue associated with the action |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-operationoutcome-referencenum | S | 0..1 | string | Issue reference number URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-referencenum |
| ext-operationoutcome-usertext | S | 0..1 | string | User-friendly issue text URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext" |
| value[x] | S | 1..1 | string | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" | |
| value[x] | S | 1..1 | string | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-language" |
| value[x] | 1..1 | code | Value of extension Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| severity | ?!SΣ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (20190415) (required) |
| code | SΣ | 1..1 | code | Error or warning code Binding: IssueType (20190415) (required) |
| details | SΣ | 0..1 | CodeableConcept | Additional details about the error Binding: SharedIssueDetails (extensible) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 0..1 | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" | |
| value[x] | S | 1..1 | string | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-language" |
| value[x] | 1..1 | code | Value of extension Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| diagnostics | SΣ | 0..1 | string | Additional diagnostic information about the issue |
| location | SΣ | 0..* | string | XPath of element(s) related to issue |
| expression | Σ | 0..* | string | FluentPath of element(s) related to issue |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.67.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| OperationOutcome.language | required | http://tools.ietf.org/html/bcp47 |
| OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].extension:userText-translation-language.value[x] | required | http://tools.ietf.org/html/bcp47 |
| OperationOutcome.issue.severity | required | IssueSeverity |
| OperationOutcome.issue.code | required | IssueType |
| OperationOutcome.issue.details | extensible | SharedIssueDetails |
| OperationOutcome.issue.details.text.extension:details-translation.value[x].extension:details-translation-language.value[x] | required | http://tools.ietf.org/html/bcp47 |
3.67.4 Constraints
Constraints
| Id | Path | Details | Requirements |