Shared Health Specification and Guide Version 5.0

 

Definitions for the profile-operationoutcome Profile.

1. OperationOutcome
Definition

A collection of error, warning or information messages that result from a system action.

Control0..*
Must Supporttrue
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.

Max Length0
2. OperationOutcome.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control1..1
Typeid
Must Supporttrue
Comments

Usage Note: This will usually be a GUID and is assigned by the sending application.

Max Length0
3. 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.

Control0..1
TypeMeta
Max Length0
4. 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.

Control0..1
Typeuri
Is Modifiertrue
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 as much as possible.

Max Length0
5. OperationOutcome.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
Typecode
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).

Max Length0
6. 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Max Length0
7. 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.

Control0..*
TypeResource
Alternate Namesinline 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.

Max Length0
8. 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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
9. 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Max Length0
10. OperationOutcome.issue
Definition

An error, warning or information message that results from a system action.

Control1..*
TypeBackboneElement
Must Supporttrue
Comments

Conformance Rule: We are currently only returning a single issue element at this time.

Max Length0
11. OperationOutcome.issue.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
12. OperationOutcome.issue.extension
Definition

An Extension

Control0..*
TypeExtension
Max Length0
SlicingThis element introduces a set of slices on OperationOutcome.issue.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
13. OperationOutcome.issue.extension:referenceNum
SliceNamereferenceNum
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.

Control0..1
TypeExtension(Issue reference number) (Extension Type: string)
Must Supporttrue
Max Length0
14. OperationOutcome.issue.extension:userText
SliceNameuserText
Definition

Provides the user-friendly description associated with an OperationOutcome issue

Control0..1
TypeExtension(User-friendly issue text) (Extension Type: string)
Must Supporttrue
Max Length0
15. OperationOutcome.issue.extension:userText.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
16. OperationOutcome.issue.extension:userText.extension
Definition

An Extension

Control0..0
TypeExtension
17. OperationOutcome.issue.extension:userText.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Must Supporttrue
Comments

none Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext

Fixed Valuehttp://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext
18. OperationOutcome.issue.extension:userText.value[x]
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).

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
19. OperationOutcome.issue.extension:userText.value[x].id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
20. OperationOutcome.issue.extension:userText.value[x].extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on OperationOutcome.issue.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
21. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation
SliceNameuserText-translation
Definition

An expression of the original string in an alternate language.

Control0..1
TypeExtension(translation) (Extension Type: string)
Must Supporttrue
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.

Max Length0
22. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
23. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.extension
Definition

An Extension

Control0..0
TypeExtension
Max Length0
24. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Max Length0
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
25. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x]
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).

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Max Length0
26. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
27. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on OperationOutcome.issue.extension.value[x].extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].extension:userText-translation-language
SliceNameuserText-translation-language
Definition

The language in which the string is expressed.

Control1..1
TypeExtension(language) (Extension Type: code)
Must Supporttrue
Max Length0
29. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].extension:userText-translation-language.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
30. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].extension:userText-translation-language.extension
Definition

An Extension

Control0..0
TypeExtension
Max Length0
31. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].extension:userText-translation-language.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Must Supporttrue
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Max Length0
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ST-language
32. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].extension:userText-translation-language.value[x]
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).

Control1..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Max Length0
33. OperationOutcome.issue.extension:userText.value[x].extension:userText-translation.value[x].value
Definition

The actual value

Control0..1
Typestring
Max Length1048576
34. OperationOutcome.issue.extension:userText.value[x].value
Definition

The actual value

Control0..1
Typestring
Max Length1048576
35. 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Max Length0
36. OperationOutcome.issue.severity
Definition

Indicates whether the issue indicates a variation from successful processing.

Control1..1
BindingThe codes SHALL be taken from IssueSeverity (20190415)
Typecode
Is Modifiertrue
Must Supporttrue
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.

Max Length0
37. 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.

Control1..1
BindingThe codes SHALL be taken from IssueType (20190415)
Typecode
Must Supporttrue
Requirements

Different types of messages have substantially different ramifications.

Max Length0
38. OperationOutcome.issue.details
Definition

Indicates the specific issue represented by this message.

Control0..1
BindingThe codes SHALL be taken from SharedIssueDetails; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

By providing coded identification of issues and errors, allows applications to have logic that manages particular errors and warnings automatically. However in some circumstances, a code may not be available. The text element may be used alone in this situation

Comments

Conformance Rules: Details should be available to users if they wish to link to this information

Max Length0
39. OperationOutcome.issue.details.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
40. OperationOutcome.issue.details.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
41. OperationOutcome.issue.details.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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.

Max Length0
42. OperationOutcome.issue.details.coding.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
43. OperationOutcome.issue.details.coding.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
44. OperationOutcome.issue.details.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Max Length0
45. OperationOutcome.issue.details.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
46. OperationOutcome.issue.details.coding.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).

Control0..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Max Length0
47. OperationOutcome.issue.details.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Max Length0
48. OperationOutcome.issue.details.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
49. OperationOutcome.issue.details.text
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.

Control1..1
Typestring
Must Supporttrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Conformance Rule: This MUST be populated with a description of the issue.

Max Length0
50. OperationOutcome.issue.details.text.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
51. OperationOutcome.issue.details.text.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on OperationOutcome.issue.details.text.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
52. OperationOutcome.issue.details.text.extension:details-translation
SliceNamedetails-translation
Definition

An expression of the original string in an alternate language.

Control0..1
TypeExtension(translation) (Extension Type: string)
Must Supporttrue
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.

Max Length0
53. OperationOutcome.issue.details.text.extension:details-translation.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
54. OperationOutcome.issue.details.text.extension:details-translation.extension
Definition

An Extension

Control0..0
TypeExtension
Max Length0
55. OperationOutcome.issue.details.text.extension:details-translation.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Max Length0
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
56. OperationOutcome.issue.details.text.extension:details-translation.value[x]
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).

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Max Length0
57. OperationOutcome.issue.details.text.extension:details-translation.value[x].id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
58. OperationOutcome.issue.details.text.extension:details-translation.value[x].extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on OperationOutcome.issue.details.text.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
59. OperationOutcome.issue.details.text.extension:details-translation.value[x].extension:details-translation-language
SliceNamedetails-translation-language
Definition

The language in which the string is expressed.

Control1..1
TypeExtension(language) (Extension Type: code)
Must Supporttrue
Max Length0
60. OperationOutcome.issue.details.text.extension:details-translation.value[x].extension:details-translation-language.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
61. OperationOutcome.issue.details.text.extension:details-translation.value[x].extension:details-translation-language.extension
Definition

An Extension

Control0..0
TypeExtension
Max Length0
62. OperationOutcome.issue.details.text.extension:details-translation.value[x].extension:details-translation-language.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Must Supporttrue
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Max Length0
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ST-language
63. OperationOutcome.issue.details.text.extension:details-translation.value[x].extension:details-translation-language.value[x]
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).

Control1..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Max Length0
64. OperationOutcome.issue.details.text.extension:details-translation.value[x].value
Definition

The actual value

Control0..1
Typestring
Max Length1048576
65. OperationOutcome.issue.details.text.value
Definition

The actual value

Control0..1
Typestring
Max Length1048576
66. 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.

Control0..1
Typestring
Must Supporttrue
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.

Max Length0
67. OperationOutcome.issue.location
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.

Control0..*
Typestring
Must Supporttrue
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.

Max Length0
68. OperationOutcome.issue.expression
Definition

A simple FluentPath 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.

Control0..*
Typestring
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 FluentPath is the resource or bundle that generated OperationOutcome. Each FluentPath SHALL resolve to a single node.

Max Length0