| OperationOutcome | I | | OperationOutcome | There are no (further) constraints on this element Element IdShort description Information about the success/failure of an action Definition A collection of error, warning, or information messages that result from a system action.
Can result from the failure of a REST call or be part of the response message returned from a request message.
OperationOutcome Constraints- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4: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-3: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-6:A resource should have narrative for robust management
text.`div`.exists() - dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
- rim:Entity. Role, or Act
- rim:Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)
|
| id | Σ | 0..1 | System.String | Element IdShort description uniqueRequestID Definition Internal Apigee messageID
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
System.String |
| meta | S Σ | 1..1 | Meta | Element IdShort description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
"meta" : {
"lastUpdated" : "2021-04-21T16:58:00+00:00"
}
Meta Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdOperationOutcome.meta.versionId Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
id Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| lastUpdated | Σ | 1..1 | instant | There are no (further) constraints on this element Element IdOperationOutcome.meta.lastUpdated When the resource version last changed Definition When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
instant Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdOperationOutcome.meta.source Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.
This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdOperationOutcome.meta.profile Profiles this resource claims to conform to Definition Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
canonical(StructureDefinition) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdOperationOutcome.meta.security Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdOperationOutcome.meta.tag Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
|
| extension | I | 0..* | Extension | Element IdOperationOutcome.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| supportingInfo | I | 0..* | Extension(Reference(Resource)) | Element IdOperationOutcome.extension:supportingInfo Other information that may be relevant to this event. Alternate names extensions, user content Definition Information relevant to this OperationOutcome. For EPS release rejections this may be the pharmacy which is currently owns the prescription task/order.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension(Reference(Resource)) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-Spine-supportingInfo Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| issue | S Σ I | 1..* | BackboneElement | Element IdShort description A single issue associated with the action Definition An error, warning, or information message that results from a system action.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - nhsd-errrorcode:An NHS Digital error or warning code is required
(severity = 'information') or ((severity != 'information') and details.empty().not())
- rim:n/a
- v2:ERR
- rim:AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
|
| severity | S Σ | 1..1 | codeBinding | Element IdOperationOutcome.issue.severity fatal | error | warning | information Definition Indicates whether the issue indicates a variation from successful processing.
"severity": "error",
Indicates how relevant the issue is to the overall success of the action.
This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.
code Binding How the issue affects the success of the action. IssueSeverity (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:ERR-4
- rim:./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode="OBS" and moodCode="EVN" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type="CD"]
|
| code | S Σ | 1..1 | codeBinding | Element IdOperationOutcome.issue.code Error or warning code Definition Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.
"code": "processing",
Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.
The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Binding A code that describes the type of issue. IssueType (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:ERR-3
- rim:./code
|
| details | S Σ | 0..1 | CodeableConceptBinding | Element IdOperationOutcome.issue.details Additional details about the error Definition Additional details about the error. This may be a text description of the error or a system code that identifies the error.
"details": {
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode",
"code": "INVALID_VALUE",
"display": "Invalid value"
}
]
}
A human readable description of the error issue SHOULD be placed in details.text.
CodeableConcept Binding A set of codes that define details of the exact issue. NHSDigitalOperationOutcomeCodes (preferred)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:ERR-5
- rim:./code
|
| coding | S Σ | 1..1 | CodingBinding | Element IdOperationOutcome.issue.details.coding Code defined by a terminology system Definition A reference to a code defined by a terminology system.
Allows for alternative encodings within a code system, and translations to other code systems.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Coding Binding NHSDigitalOperationOutcomeCodes (extensible) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- v2:C*E.1-8, C*E.10-22
- rim:union(., ./translation)
- orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdOperationOutcome.issue.details.coding.system Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.3
- rim:./codeSystem
- orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdOperationOutcome.issue.details.coding.version Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.7
- rim:./codeSystemVersion
- orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdOperationOutcome.issue.details.coding.code Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdOperationOutcome.issue.details.coding.display Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.2 - but note this is not well followed
- rim:CV.displayName
- orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdOperationOutcome.issue.details.coding.userSelected If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:Sometimes implied by being first
- rim:CD.codingRationale
- orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdOperationOutcome.issue.details.text Plain text representation of the concept 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.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Very often the text is the same as a displayName of one of the codings.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.9. But note many systems use C*E.2 for this
- rim:./originalText[mediaType/code="text/plain"]/data
- orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| diagnostics | S Σ | 0..1 | string | Element IdOperationOutcome.issue.diagnostics Additional diagnostic information about the issue Definition Additional diagnostic information about the issue. User readable version of the message. Include url's for further information or other information helpful for the user to understand the error.
This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:ERR-8
- rim:./text[parent::AcknowledgmentDetail]
|
| location | S Σ | 0..* | string | Element IdOperationOutcome.issue.location Deprecated: Path of element(s) related to issue Definition Use the JSON Pointer standard to describe the source of the error - e.g. parameter, or payload value.
"location": [
"Patient",
"Line 1, Col 37"
]```
Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.
The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:ERR-2
- rim:./location[parent::AcknowledgmentDetail]
|
| expression | S Σ | 0..* | string | Element IdOperationOutcome.issue.expression FHIRPath of element(s) related to issue Definition FHIRPath of element(s) related to issue
Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.
The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:ERR-2
- rim:./location[parent::AcknowledgmentDetail]
|