Others titles
- FHIR Operation Outcome Resource
- Electronic Health Records Exchange Through FHIR
Keywords
- FHIR
- HL7
- Medical Terminology
- Processes Data
- Processes Information
- Processes Documentation
- Health Information Exchange
- Electronic Health Records
- FHIR Smart
- Smart on FHIR
Operation Outcome
Operation outcomes are sets of error, warning and information messages that provide detailed information about the outcome of an attempted system operation. They are provided as a direct system response, or component of one, and provide information about the outcome of the operation.
Get The Data
- ResearchNon-Commercial, Share-Alike, Attribution Free Forever
- CommercialCommercial Use, Remix & Adapt, White Label Log in to download
Description
The Operation Outcome resource is used in the following circumstances:
– When a RESTful interaction or operation fails
– As the response on a validation operation to provide information about the outcome
– As part of a message response, usually when the message has not been processed correctly
– As the response to a batch/transaction, when requested
– As part of a search’s Bundle response containing information about the search
This resource is not used for reporting clinical or workflow issues associated with a proposed or ongoing action; these would be handled using Detected Issue or other resources. Operation Outcome is not designed to be persisted or referenced from other parts of the workflow. It is possible to have both Operation Outcome and Detected Issue together, where the Operation Outcome might indicate that a requested action was rejected due to a clinical issue and the Detected Issue provides the details of the issue.
About this Dataset
Data Info
Date Created | 2018-09-20 |
---|---|
Last Modified | 2022-05-28 |
Version | 4.3.0 |
Update Frequency |
Annual |
Temporal Coverage |
N/A |
Spatial Coverage |
United States |
Source | John Snow Labs; Health Level Seven International; |
Source License URL | |
Source License Requirements |
N/A |
Source Citation |
N/A |
Keywords | FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR |
Other Titles | FHIR Operation Outcome Resource, Electronic Health Records Exchange Through FHIR |
Data Fields
Name | Description | Type | Constraints |
---|---|---|---|
Concept_Name | Name of the concept in the FHIR structure. | string | required : 1 |
Computer_Ready_Name | A Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this. | string | - |
Type | The type the structure describes. | string | - |
Dollar_Ref | The "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced. | string | - |
Description | A free text natural language description of the structure and its use. | string | - |
Items | The value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value. | string | - |
Enum | The enum is used to restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique. | string | - |
Required | The value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value. | string | - |
Const | The value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword. | string | - |
Data Preview
Concept Name | Computer Ready Name | Type | Dollar Ref | Description | Items | Enum | Required | Const |
OperationOutcome | resourceType | This is a OperationOutcome resource | OperationOutcome | |||||
OperationOutcome | id | #/definitions/string | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||||
OperationOutcome | meta | #/definitions/Meta | 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. | |||||
OperationOutcome | implicitRules | #/definitions/uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||||
OperationOutcome | _implicitRules | #/definitions/Element | Extensions for implicitRules | |||||
OperationOutcome | language | #/definitions/code | The base language in which the resource is written. | |||||
OperationOutcome | _language | #/definitions/Element | Extensions for language | |||||
OperationOutcome | text | #/definitions/Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |||||
OperationOutcome | contained | array | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | {'$ref': '#/definitions/ResourceList'} | ||||
OperationOutcome | extension | array | 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. | {'$ref': '#/definitions/Extension'} |