Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweaveOperationOutcome

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-OperationOutcome Version: 0.1.0
Active as of 2024-06-10 Computable Name: InterweaveOperationOutcome

Interweave Operation Outcome resource profile.

  Status: Active: Approved (STU)

Introduction

This profile sets minimum expectations for the OperationOutcome resource. Note that the OperationOutcome is based around at least one top-level “issue” - and so the points below refer to the fields within the “issue”. Also see further notes on usage below.

Mandatory fields

The following mandatory fields are defined for an OperationOutcome:

  1. Severity - this is mandatory in FHIR, with a short list of required codes provided.

    Note: For any notifications about deficiencies in the content (“Data Impairments”) then a severity of “information” should be used

  2. Code - this is again mandatory in FHIR, with a list of required codes provided. Note that this code list is hierarchical (see “Level”):
    • A Data Provider SHOULD, whenever possible, populate a Level 2 code to provide more granular and detailed categorisation of the error.
    • A Data Consumer MAY wish to use these codes to automate aspects of error handling. The Level 1 codes in particular offer a short list which indicates useful information about whether the error is technical, security-related, retryable, etc
  3. Details.text - This MUST be populated and MUST contain a description of the error that is meaningful to an end-user. This is what will be displayed to the user on the screen.

    Note: An Operation Outcome may be returned as part of a bundle containing multiple FHIR Resources, so the text should be as descriptive and self-contained as possible in terms of contextual information.

    Note: this text does NOT need to include information about the source of the error, as this is already provided by the meta tags for “source” and “provenance”

Must Support fields

In addition the following fields are “Must Support” - ie they must be populated if relevant and known:

  1. Diagnostics - This should be populated with additional technical information about the error. It is anticipated that user interfaces will not display this to the user by default, but will be able to reveal it on request – eg to capture a screenshot for support purposes

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them:

  • Details.coding - The primary mechanism for describing errors is based on the above “issue.code” plus the “details.text” – and for most types of errors this is anticipated to be adequate, with no need for additional detailed coding to be curated or populated.

    However it is also envisaged that in the near future Operation Outcomes may also be used to communicate data-related deficiencies (“Data Impairments”) - and that an additional level of coding will be needed to help identify and classify these. In summary therefore:

    • This field is reserved for future use, please do not use it without further consultation / guidance
    • In the near future it is anticipated that one or more regional code lists will be published. These codes will be linked to a top level issue.code and provide more granular categorisation of particular types of issue.
  • Expression - May be used to provide additional information about which part of the data is at issue. See guidance in FHIR Specification. (Although we are using STU3, the FHIR R4 guidance notes are more informative). See also Design Paper 17 on “Data Impairments” https://yhcr.org/resources/technical-papers/

Discouraged or Removed fields

  • Location - this is an XML-specific field and is deprecated in FHIR R4. Use “expression” instead.

Additional notes

  1. RequestId tag All Operation Outcomes which pass through the Exchange will have a tag automatically added: https://yhcr.nhs.uk/RequestId. The “code” of this tag will contain a request id which can be used to uniquely identify the interaction and thus provide a link to diagnostic logs.

    Please quote this RequestId for troubleshooting purposes

  2. Narrative text

    Some Operation Outcomes have historically populated the resource’s narrative “text” with HTML information about the error. This is discouraged (as per base fields ) and it should not be assumed that the user will be shown this text. This is because it is difficult to predict the effect of this HTML formatting on a Data Consumer screen. Instead simple non-html text should be provided in the “details.text”.

  3. Multiple Issues

    FHIR allows for an OperationOutcome to contain MUTLIPLE “issues”, and this may sometimes be the case. An important example is if a returned resource fails FHIR Profile Validation – in this case the original resource will be replaced with an OperationOutcome containing multiple “issues” to describe each of the validation problems detected.

    The convention in this case is that the FIRST issue in the list must contain a summary suitable for showing to the user.

    Additional issues in the list can provide further detail and MAY be shown to the user if they choose to drill in and view full details of the error.

  4. HTTP error codes

    • When an error occurs then a relevant HTTP failure code should also be returned, thus indicating to a consumer that they should look for an Operation Outcome rather than the originally anticipated response.

    • If an Operation Outcome is returned then it should be expected that consumers will use this (rather than the HTTP response code) as the primary source of information to show users

    • It should be noted that the Exchange middleware may often return a HTTP 200 response (indicating that all central processing has completed successfully) - however the FHIR Bundle returned may still contain one or more Operation Outcomes to capture failures reported by individual Data Providers.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
..... tag:RequestId 0..1CodingAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/RequestId
...... code 1..1codeAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... issue S1..*BackboneElementA single issue associated with the action
.... severity S1..1codefatal | error | warning | information
.... code S1..1codeError or warning code
.... details S1..1CodeableConceptAdditional details about the error
..... coding
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
..... text S1..1stringDescription of the error suitable for displaying to a user
.... diagnostics S0..1stringAdditional diagnostic information about the issue
.... location 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
..... tag:RequestId Σ0..1CodingAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/RequestId
...... code Σ1..1codeAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... issue SΣ1..*BackboneElementA single issue associated with the action
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... severity ?!SΣ1..1codefatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

.... code SΣ1..1codeError or warning code
Binding: IssueType (required): A code that describes the type of issue.

.... details SΣ1..1CodeableConceptAdditional details about the error
Binding: Operation Outcome Codes (example): A code that provides details as the exact issue.

..... text SΣ1..1stringDescription of the error suitable for displaying to a user
.... diagnostics SΣ0..1stringAdditional diagnostic information about the issue

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OperationOutcome.meta.securityextensibleAll Security Labels
OperationOutcome.meta.tagexampleCommon Tags
OperationOutcome.meta.tag:SourceexampleCommon Tags
OperationOutcome.meta.tag:ProvenanceexampleCommon Tags
OperationOutcome.meta.tag:RequestIdexampleCommon Tags
OperationOutcome.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
OperationOutcome.issue.coderequiredIssueType
OperationOutcome.issue.detailsexampleOperation Outcome Codes

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorOperationOutcomeIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorOperationOutcomeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationOutcomeIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorOperationOutcomeIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:RequestId Σ0..1CodingAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/RequestId
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... severity ?!SΣ1..1codefatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

.... code SΣ1..1codeError or warning code
Binding: IssueType (required): A code that describes the type of issue.

.... details SΣ1..1CodeableConceptAdditional details about the error
Binding: Operation Outcome Codes (example): A code that provides details as the exact issue.

..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ1..1stringDescription of the error suitable for displaying to a user
.... diagnostics SΣ0..1stringAdditional diagnostic information about the issue
.... expression Σ0..*stringFHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OperationOutcome.meta.securityextensibleAll Security Labels
OperationOutcome.meta.tagexampleCommon Tags
OperationOutcome.meta.tag:SourceexampleCommon Tags
OperationOutcome.meta.tag:ProvenanceexampleCommon Tags
OperationOutcome.meta.tag:RequestIdexampleCommon Tags
OperationOutcome.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
OperationOutcome.issue.coderequiredIssueType
OperationOutcome.issue.detailsexampleOperation Outcome Codes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from OperationOutcome

Summary

Mandatory: 2 elements (11 nested mandatory elements)
Must-Support: 16 elements
Fixed Value: 3 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element OperationOutcome.meta.tag is sliced based on the value of value:system

Differential View

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
..... tag:RequestId 0..1CodingAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/RequestId
...... code 1..1codeAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... issue S1..*BackboneElementA single issue associated with the action
.... severity S1..1codefatal | error | warning | information
.... code S1..1codeError or warning code
.... details S1..1CodeableConceptAdditional details about the error
..... coding
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
..... text S1..1stringDescription of the error suitable for displaying to a user
.... diagnostics S0..1stringAdditional diagnostic information about the issue
.... location 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
..... tag:RequestId Σ0..1CodingAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/RequestId
...... code Σ1..1codeAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... issue SΣ1..*BackboneElementA single issue associated with the action
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... severity ?!SΣ1..1codefatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

.... code SΣ1..1codeError or warning code
Binding: IssueType (required): A code that describes the type of issue.

.... details SΣ1..1CodeableConceptAdditional details about the error
Binding: Operation Outcome Codes (example): A code that provides details as the exact issue.

..... text SΣ1..1stringDescription of the error suitable for displaying to a user
.... diagnostics SΣ0..1stringAdditional diagnostic information about the issue

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OperationOutcome.meta.securityextensibleAll Security Labels
OperationOutcome.meta.tagexampleCommon Tags
OperationOutcome.meta.tag:SourceexampleCommon Tags
OperationOutcome.meta.tag:ProvenanceexampleCommon Tags
OperationOutcome.meta.tag:RequestIdexampleCommon Tags
OperationOutcome.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
OperationOutcome.issue.coderequiredIssueType
OperationOutcome.issue.detailsexampleOperation Outcome Codes

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorOperationOutcomeIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorOperationOutcomeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationOutcomeIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorOperationOutcomeIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..*OperationOutcomeInformation about the success/failure of an action
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:RequestId Σ0..1CodingAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/RequestId
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeAuto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... severity ?!SΣ1..1codefatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

.... code SΣ1..1codeError or warning code
Binding: IssueType (required): A code that describes the type of issue.

.... details SΣ1..1CodeableConceptAdditional details about the error
Binding: Operation Outcome Codes (example): A code that provides details as the exact issue.

..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ1..1stringDescription of the error suitable for displaying to a user
.... diagnostics SΣ0..1stringAdditional diagnostic information about the issue
.... expression Σ0..*stringFHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OperationOutcome.meta.securityextensibleAll Security Labels
OperationOutcome.meta.tagexampleCommon Tags
OperationOutcome.meta.tag:SourceexampleCommon Tags
OperationOutcome.meta.tag:ProvenanceexampleCommon Tags
OperationOutcome.meta.tag:RequestIdexampleCommon Tags
OperationOutcome.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
OperationOutcome.issue.coderequiredIssueType
OperationOutcome.issue.detailsexampleOperation Outcome Codes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from OperationOutcome

Summary

Mandatory: 2 elements (11 nested mandatory elements)
Must-Support: 16 elements
Fixed Value: 3 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element OperationOutcome.meta.tag is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron