Status: DRAFT: For Review

Introduction

This profile sets minimum expectations for the OperationOutcome resource. We use the OperationOutcome structure definition as a base to this profile. 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.FHIR R4 guidance notes that are more informative. See also Design Paper 17 on “Data Impairments – Reporting and Interpretaion” https://www.interweavedigital.com/technical/

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.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from OperationOutcome

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
tag:RequestId		0..1	Coding	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/RequestId
code		1..1	code	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - 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	S	1..*	BackboneElement	A single issue associated with the action
severity	S	1..1	code	fatal | error | warning | information
code	S	1..1	code	Error or warning code
details	S	1..1	CodeableConcept	Additional details about the error
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
text	S	1..1	string	Description of the error suitable for displaying to a user
diagnostics	S	0..1	string	Additional diagnostic information about the issue
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - 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..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
tag:RequestId	Σ	0..1	Coding	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes. Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/RequestId
code	Σ	1..1	code	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - 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..*	Extension	Extensions that cannot be ignored
issue	SΣ	1..*	BackboneElement	A single issue associated with the action
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
severity	SΣ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	SΣ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	SΣ	1..1	CodeableConcept	Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
text	SΣ	1..1	string	Description of the error suitable for displaying to a user
diagnostics	SΣ	0..1	string	Additional diagnostic information about the issue
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationOutcome.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
OperationOutcome.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:RequestId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
OperationOutcome.issue.severity	required	IssueSeverity http://hl7.org/fhir/ValueSet/issue-severity|4.0.1 from the FHIR Standard
OperationOutcome.issue.code	required	IssueType http://hl7.org/fhir/ValueSet/issue-type|4.0.1 from the FHIR Standard
OperationOutcome.issue.details	example	OperationOutcomeCodes http://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	OperationOutcome	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	OperationOutcome	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	OperationOutcome	If 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()
dom-5	error	OperationOutcome	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	OperationOutcome	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - 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..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:RequestId	Σ	0..1	Coding	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes. Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/RequestId
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - 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..*	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	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
severity	SΣ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	SΣ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	SΣ	1..1	CodeableConcept	Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..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	Description of the error suitable for displaying to a user
diagnostics	SΣ	0..1	string	Additional diagnostic information about the issue
location	Σ	0..*	string	Deprecated: Path of element(s) related to issue
expression	Σ	0..*	string	FHIRPath of element(s) related to issue
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationOutcome.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
OperationOutcome.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:RequestId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
OperationOutcome.issue.severity	required	IssueSeverity http://hl7.org/fhir/ValueSet/issue-severity|4.0.1 from the FHIR Standard
OperationOutcome.issue.code	required	IssueType http://hl7.org/fhir/ValueSet/issue-type|4.0.1 from the FHIR Standard
OperationOutcome.issue.details	example	OperationOutcomeCodes http://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	OperationOutcome	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	OperationOutcome	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	OperationOutcome	If 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()
dom-5	error	OperationOutcome	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	OperationOutcome	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from OperationOutcome

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
tag:RequestId		0..1	Coding	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/RequestId
code		1..1	code	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - 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	S	1..*	BackboneElement	A single issue associated with the action
severity	S	1..1	code	fatal | error | warning | information
code	S	1..1	code	Error or warning code
details	S	1..1	CodeableConcept	Additional details about the error
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
text	S	1..1	string	Description of the error suitable for displaying to a user
diagnostics	S	0..1	string	Additional diagnostic information about the issue
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - 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..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
tag:RequestId	Σ	0..1	Coding	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes. Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/RequestId
code	Σ	1..1	code	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - 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..*	Extension	Extensions that cannot be ignored
issue	SΣ	1..*	BackboneElement	A single issue associated with the action
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
severity	SΣ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	SΣ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	SΣ	1..1	CodeableConcept	Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
text	SΣ	1..1	string	Description of the error suitable for displaying to a user
diagnostics	SΣ	0..1	string	Additional diagnostic information about the issue
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationOutcome.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
OperationOutcome.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:RequestId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
OperationOutcome.issue.severity	required	IssueSeverity http://hl7.org/fhir/ValueSet/issue-severity|4.0.1 from the FHIR Standard
OperationOutcome.issue.code	required	IssueType http://hl7.org/fhir/ValueSet/issue-type|4.0.1 from the FHIR Standard
OperationOutcome.issue.details	example	OperationOutcomeCodes http://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	OperationOutcome	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	OperationOutcome	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	OperationOutcome	If 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()
dom-5	error	OperationOutcome	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	OperationOutcome	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - 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..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:RequestId	Σ	0..1	Coding	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes. Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/RequestId
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Auto-populated by Exchange. An id which links to Exchange diagnostic logs for troubleshooting purposes.
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - 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..*	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	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
severity	SΣ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	SΣ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	SΣ	1..1	CodeableConcept	Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..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	Description of the error suitable for displaying to a user
diagnostics	SΣ	0..1	string	Additional diagnostic information about the issue
location	Σ	0..*	string	Deprecated: Path of element(s) related to issue
expression	Σ	0..*	string	FHIRPath of element(s) related to issue
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationOutcome.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
OperationOutcome.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.meta.tag:RequestId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
OperationOutcome.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
OperationOutcome.issue.severity	required	IssueSeverity http://hl7.org/fhir/ValueSet/issue-severity|4.0.1 from the FHIR Standard
OperationOutcome.issue.code	required	IssueType http://hl7.org/fhir/ValueSet/issue-type|4.0.1 from the FHIR Standard
OperationOutcome.issue.details	example	OperationOutcomeCodes http://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	OperationOutcome	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	OperationOutcome	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	OperationOutcome	If 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()
dom-5	error	OperationOutcome	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	OperationOutcome	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from OperationOutcome

Summary

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

Slices

This structure defines the following Slices:

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

Differences between Interweave STU3 and R4 profiles