Tiro.health Implementation Guide
0.1.0 - ci-build
Tiro.health Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.tiro.health/StructureDefinition/tiro-operation-outcome | Version: 0.1.0 | |||
| Draft as of 2026-06-09 | Computable Name: TiroOperationOutcome | |||
The OperationOutcome returned by the Tiro.health FHIR API for error responses (and some validation outcomes). Every issue carries a human-readable details.text and a standard FHIR issue.code; some issues additionally carry a Tiro detail code in issue.details.coding (see the OperationOutcomeIssueDetail code system). Branch on issue.code and the coded issue.details.coding, never on details.text. Documentation: https://docs.tiro.health/fhir/errors
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | BackboneElement | A single issue associated with the action |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | code | fatal | error | warning | information | success Binding: IssueSeverity (required): How the issue affects the success of the action. |
![]() ![]() ![]() |
SΣ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Additional details about the error Binding: Operation Outcome Issue Detail (example) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.issue.severity | Base | required | Issue Severity | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.code | Base | required | Issue Type | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.details | Base | example | Operation Outcome Issue Detail | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |
![]() ![]() |
S | 1..* | BackboneElement | A single issue associated with the action |
![]() ![]() ![]() |
S | 1..1 | code | fatal | error | warning | information | success |
![]() ![]() ![]() |
S | 1..1 | code | Error or warning code |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Additional details about the error Binding: Operation Outcome Issue Detail (example) |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Plain text representation of the concept |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.issue.details | Base | example | Operation Outcome Issue Detail | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | BackboneElement | A single issue associated with the action | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | fatal | error | warning | information | success Binding: IssueSeverity (required): How the issue affects the success of the action. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Additional details about the error Binding: Operation Outcome Issue Detail (example) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Additional diagnostic information about the issue | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Deprecated: Path of element(s) related to issue | ||||
![]() ![]() ![]() |
Σ | 0..* | string | FHIRPath of element(s) related to issue | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.severity | Base | required | Issue Severity | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.code | Base | required | Issue Type | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.details | Base | example | Operation Outcome Issue Detail | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | BackboneElement | A single issue associated with the action |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | code | fatal | error | warning | information | success Binding: IssueSeverity (required): How the issue affects the success of the action. |
![]() ![]() ![]() |
SΣ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Additional details about the error Binding: Operation Outcome Issue Detail (example) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.issue.severity | Base | required | Issue Severity | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.code | Base | required | Issue Type | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.details | Base | example | Operation Outcome Issue Detail | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |
![]() ![]() |
S | 1..* | BackboneElement | A single issue associated with the action |
![]() ![]() ![]() |
S | 1..1 | code | fatal | error | warning | information | success |
![]() ![]() ![]() |
S | 1..1 | code | Error or warning code |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Additional details about the error Binding: Operation Outcome Issue Detail (example) |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Plain text representation of the concept |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.issue.details | Base | example | Operation Outcome Issue Detail | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | OperationOutcome | Information about the success/failure of an action | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | BackboneElement | A single issue associated with the action | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | fatal | error | warning | information | success Binding: IssueSeverity (required): How the issue affects the success of the action. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Additional details about the error Binding: Operation Outcome Issue Detail (example) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Additional diagnostic information about the issue | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Deprecated: Path of element(s) related to issue | ||||
![]() ![]() ![]() |
Σ | 0..* | string | FHIRPath of element(s) related to issue | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationOutcome.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.severity | Base | required | Issue Severity | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.code | Base | required | Issue Type | 📍5.0.0 | FHIR Std. |
| OperationOutcome.issue.details | Base | example | Operation Outcome Issue Detail | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Other representations of profile: CSV, Excel, Schematron