Profiles & Operations Index > Profile: OperationOutcome

Profile: OperationOutcome

Canonical URL: http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-operationOutcome

Simplifier project page: Operation Outcome EHR

Derived from: OperationOutcome (R4)

Formal Views of Profile Content

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

Differential View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
severityS Σ1..1codeBinding
codeS Σ1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
diagnosticsS Σ0..1string
locationΣ0..*string
expressionS Σ0..*string

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
severityS Σ1..1codeBinding
codeS Σ1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
diagnosticsS Σ0..1string
locationΣ0..*string
expressionS Σ0..*string

Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
severityS Σ1..1codeBinding
codeS Σ1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
diagnosticsS Σ0..1string
locationΣ0..*string
expressionS Σ0..*string

Table View

OperationOutcome..
OperationOutcome.issue..
OperationOutcome.issue.severity..
OperationOutcome.issue.code..
OperationOutcome.issue.details..
OperationOutcome.issue.details.coding..1
OperationOutcome.issue.details.coding.system..
OperationOutcome.issue.details.coding.code..
OperationOutcome.issue.details.coding.display..
OperationOutcome.issue.diagnostics..
OperationOutcome.issue.expression..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "OperationOutcome",
    "url": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-operationOutcome",
    "version": "1.0.0",
    "name": "OperationOutcomeEHR",
    "title": "Operation Outcome EHR",
    "status": "active",
    "description": "Operation Outcomes are sets of error, warning and information messages that provide detailed information about the outcome of some attempted system operation. They are provided as a direct system response, or component of one, where they provide information about the outcome of the operation.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "OperationOutcome",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/OperationOutcome",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "OperationOutcome.issue",
                "path": "OperationOutcome.issue",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.severity",
                "path": "OperationOutcome.issue.severity",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.code",
                "path": "OperationOutcome.issue.code",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.details",
                "path": "OperationOutcome.issue.details",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.details.coding",
                "path": "OperationOutcome.issue.details.coding",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ontariohealth.ca/fhir/ehr/ValueSet/error-code"
                }
            },
            {
                "id": "OperationOutcome.issue.details.coding.system",
                "path": "OperationOutcome.issue.details.coding.system",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.details.coding.code",
                "path": "OperationOutcome.issue.details.coding.code",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.details.coding.display",
                "path": "OperationOutcome.issue.details.coding.display",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.diagnostics",
                "path": "OperationOutcome.issue.diagnostics",
                "mustSupport": true
            },
            {
                "id": "OperationOutcome.issue.expression",
                "path": "OperationOutcome.issue.expression",
                "mustSupport": true
            }
        ]
    }
}

Usage

The OperationOutcome resource is returned if an error or warning is generated when processing the FHIR payload or query. It contains information that user can use to troubleshoot.

Notes

.issue.severity

  • SHALL contain a code indicating the severity of the issue, e.g. error, warning, etc

.issue.code

  • SHALL contain a code indicating the nature of the issue.

.issue.details.coding.system

  • SHOULD contain a system URI indicating the assigning authority of the internal MI error code

.issue.details.coding.code

  • SHOULD contain a code indicating the internal MI error code

.issue.details.coding.code

  • SHOULD contain the textual description of the internal MI error code

.issue.details.text

  • SHALL contain a detailed description of the issue

.issue.details.diagnostics

  • SHOULD contain additional diagnostic information about the issue, such as validation error message, etc.