Shared Health Specification and Guide Version 2.0 Revision F

 

3.44 StructureDefinition: Shared Health Operation Outcome

The official URL for this profile is: 

http://sharedhealth.exchange/fhir/StructureDefinition/profile-operationoutcome

3.44.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

NameCard.TypeConstraints and Usage
.  OperationOutcome 0..*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..1idDefinition:
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

..  issue 1..*BackboneElementDefinition:
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..*Issue reference numberDefinition:
This reference number acts as a transaction locator number and may be provided to the PrescribeIT™ support team for troubleshooting purposes. Vendors may wish to make this visible to users for this purpose.

...  extension
       (userText) 		0..*User-friendly issue textDefinition:
Provides the user-friendly description associated with an OperationOutcome issue

....  url 1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext"
....  valueString 1..1stringDefinition:
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..1translationDefinition:
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.

......  valueString 1..1stringDefinition:
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..1languageDefinition:
The language in which the string is expressed.

...  severity 1..1codeBinding: IssueSeverity (required)
Definition:
Indicates whether the issue indicates a variation from successful processing.


Comments:
Codes are from HL7. Binding value set defined.

...  code 1..1codeBinding: IssueType (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..1CodeableConcept​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

....  text 1..1stringMax Length: 1000
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.

Conformance Rule: Maximum character length set to ‘1000’.

.....  extension
           (details-translation) 		0..1translationDefinition:
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.

......  valueString 1..1stringDefinition:
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..1languageDefinition:
The language in which the string is expressed.

...  diagnostics 0..1stringDefinition:
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..*stringDefinition:
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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome SΣ0..*Information about the success/failure of an action
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... issue SΣ1..*BackboneElementA single issue associated with the action
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-operationoutcome-referencenum S0..*stringIssue reference number
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-referencenum
.... ext-operationoutcome-usertext S0..*stringUser-friendly issue text
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext
..... id 0..1idxml:id (or equivalent in JSON)
..... url S1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext"
..... valueString S1..1stringValue of extension
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
....... id 0..1idxml:id (or equivalent in JSON)
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
....... valueString S1..1stringValue of extension
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required)
........ value 0..1Primitive value for string
Max Length: 1048576
...... value 0..1Primitive value for string
Max Length: 1048576
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... severity ?!SΣ1..1codefatal | error | warning | information
Binding: IssueSeverity (required)
.... code SΣ1..1codeError or warning code
Binding: IssueType (required)
.... details SΣ0..1CodeableConcept​Additional details about the error
Binding: SharedIssueDetails (extensible)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding Σ0..*CodingCode defined by a terminology system
..... text SΣ1..1stringPlain text representation of the concept
Max Length: 1000
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
....... id 0..1idxml:id (or equivalent in JSON)
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
....... valueString S1..1stringValue of extension
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required)
........ value 0..1Primitive value for string
Max Length: 1048576
...... value 0..1Primitive value for string
Max Length: 1048576
.... diagnostics SΣ0..1stringAdditional diagnostic information about the issue
.... location SΣ0..*stringXPath of element(s) related to issue
.... expression Σ0..*stringFluentPath of element(s) related to issue

doco Documentation for this format

Grid View

This structure is derived from OperationOutcome

NameCard.TypeConstraints and Usage
.  OperationOutcome 0..*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..1idDefinition:
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

..  issue 1..*BackboneElementDefinition:
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..*Issue reference numberDefinition:
This reference number acts as a transaction locator number and may be provided to the PrescribeIT™ support team for troubleshooting purposes. Vendors may wish to make this visible to users for this purpose.

...  extension
       (userText) 		0..*User-friendly issue textDefinition:
Provides the user-friendly description associated with an OperationOutcome issue

....  url 1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext"
....  valueString 1..1stringDefinition:
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..1translationDefinition:
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.

......  valueString 1..1stringDefinition:
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..1languageDefinition:
The language in which the string is expressed.

...  severity 1..1codeBinding: IssueSeverity (required)
Definition:
Indicates whether the issue indicates a variation from successful processing.


Comments:
Codes are from HL7. Binding value set defined.

...  code 1..1codeBinding: IssueType (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..1CodeableConcept​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

....  text 1..1stringMax Length: 1000
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.

Conformance Rule: Maximum character length set to ‘1000’.

.....  extension
           (details-translation) 		0..1translationDefinition:
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.

......  valueString 1..1stringDefinition:
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..1languageDefinition:
The language in which the string is expressed.

...  diagnostics 0..1stringDefinition:
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..*stringDefinition:
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.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome SΣ0..*Information about the success/failure of an action
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... issue SΣ1..*BackboneElementA single issue associated with the action
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-operationoutcome-referencenum S0..*stringIssue reference number
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-referencenum
.... ext-operationoutcome-usertext S0..*stringUser-friendly issue text
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext
..... id 0..1idxml:id (or equivalent in JSON)
..... url S1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext"
..... valueString S1..1stringValue of extension
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
....... id 0..1idxml:id (or equivalent in JSON)
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
....... valueString S1..1stringValue of extension
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required)
........ value 0..1Primitive value for string
Max Length: 1048576
...... value 0..1Primitive value for string
Max Length: 1048576
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... severity ?!SΣ1..1codefatal | error | warning | information
Binding: IssueSeverity (required)
.... code SΣ1..1codeError or warning code
Binding: IssueType (required)
.... details SΣ0..1CodeableConcept​Additional details about the error
Binding: SharedIssueDetails (extensible)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding Σ0..*CodingCode defined by a terminology system
..... text SΣ1..1stringPlain text representation of the concept
Max Length: 1000
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
....... id 0..1idxml:id (or equivalent in JSON)
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
....... valueString S1..1stringValue of extension
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required)
........ value 0..1Primitive value for string
Max Length: 1048576
...... value 0..1Primitive value for string
Max Length: 1048576
.... diagnostics SΣ0..1stringAdditional diagnostic information about the issue
.... location SΣ0..*stringXPath of element(s) related to issue
.... expression Σ0..*stringFluentPath of element(s) related to issue

doco Documentation for this format

 

Other representations of profile: Schematron

3.44.3 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
OperationOutcome.language?extrequiredhttp://tools.ietf.org/html/bcp47
OperationOutcome.issue.severityIssueSeverityrequiredIssueSeverity
OperationOutcome.issue.codeIssueTyperequiredIssueType
OperationOutcome.issue.detailsSharedIssueDetailsextensible​SharedIssueDetails

3.44.4 Constraints

Constraints

IdPathDetailsRequirements