FHIRcast
3.0.0-ballot - STU 3 Ballot
FHIRcast
3.0.0-ballot - STU 3 Ballot
This page is part of the FHIRcast (v3.0.0-ballot: STU3 (v3.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/fhircast/StructureDefinition/fhircast-operation-outcome-syncerror | Version: 3.0.0-ballot | |||
| Draft as of 2024-04-10 | Computable Name: FhircastSyncErrorOperationOutcome | |||
Defines the structure of OperationOutcomes to be used in sync-error events. The content of the OperationOutcomes contains information that is used to determine the cause of the sync-error.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from OperationOutcome
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  OperationOutcome |
0..* | OperationOutcome | Information about the success/failure of an action | |
  Slices for issue |
S | 1..* | BackboneElement | A single issue associated with the action Slice: Unordered, Open by value:code |
   issue:fhircast |
1..1 | BackboneElement | A single issue associated with the action | |
  code |
1..1 | code | Error or warning code Required Pattern: processing | |
 details |
S | 1..1 | CodeableConcept | Additional details about the error |
 Slices for coding |
3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
 coding:eventid |
1..1 | Coding | Code defined by a terminology system | |
 system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/eventid | |
 code |
0..1 | code | The event id of the related event. | |
| coding:eventname |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/eventname | |
| code |
0..1 | code | The event eventname of the related event. | |
| coding:subscribername |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/subscribername | |
| code |
0..1 | code | The subscribername of the subscriber causing the event. | |
| diagnostics |
S | 1..1 | string | This field SHALL contain a human readable description of the source and reason for the error. |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OperationOutcome |
0..* | OperationOutcome | Information about the success/failure of an action | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for issue |
SΣ | 1..* | BackboneElement | A single issue associated with the action Slice: Unordered, Open by value:code |
| issue:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| severity |
Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. |
 code |
Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. |
| issue:fhircast |
Σ | 1..1 | BackboneElement | A single issue associated with the action |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| severity |
Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. |
| code |
Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. Required Pattern: processing |
 details |
SΣ | 1..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. |
| Slices for coding |
Σ | 3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:eventid |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/eventid |
| code |
Σ | 0..1 | code | The event id of the related event. |
| coding:eventname |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/eventname |
| code |
Σ | 0..1 | code | The event eventname of the related event. |
| coding:subscribername |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/subscribername |
| code |
Σ | 0..1 | code | The subscribername of the subscriber causing the event. |
| diagnostics |
SΣ | 1..1 | string | This field SHALL contain a human readable description of the source and reason for the error. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| OperationOutcome.issue.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | |
| OperationOutcome.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | |
| OperationOutcome.issue:fhircast.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | |
| OperationOutcome.issue:fhircast.code | required | Pattern: processinghttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | |
| OperationOutcome.issue:fhircast.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard |
| 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 |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for issue |
SΣ | 1..* | BackboneElement | A single issue associated with the action Slice: Unordered, Open by value:code | ||||
| issue:All Slices |
Content/Rules for all slices | |||||||
| 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 |
Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | ||||
| code |
Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | ||||
| details |
Σ | 0..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. | ||||
| diagnostics |
Σ | 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 | ||||
| issue:fhircast |
Σ | 1..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 |
Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | ||||
| code |
Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. Required Pattern: processing | ||||
| 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 | |||||
 Slices for coding |
Σ | 3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
 coding:eventid |
Σ | 1..1 | 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 Required Pattern: https://fhircast.hl7.org/events/syncerror/eventid | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | The event id of the related event. | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:eventname |
Σ | 1..1 | 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 Required Pattern: https://fhircast.hl7.org/events/syncerror/eventname | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | The event eventname of the related event. | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:subscribername |
Σ | 1..1 | 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 Required Pattern: https://fhircast.hl7.org/events/syncerror/subscribername | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | The subscribername of the subscriber causing the event. | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
 text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| diagnostics |
SΣ | 1..1 | string | This field SHALL contain a human readable description of the source and reason for the error. | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| OperationOutcome.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| OperationOutcome.issue.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | ||||
| OperationOutcome.issue:fhircast.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue:fhircast.code | required | Pattern: processinghttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue:fhircast.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard |
| 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: 9 elements
Must-Support: 3 elements
Slices
This structure defines the following Slices:
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 | |
| Slices for issue |
S | 1..* | BackboneElement | A single issue associated with the action Slice: Unordered, Open by value:code |
| issue:fhircast |
1..1 | BackboneElement | A single issue associated with the action | |
| code |
1..1 | code | Error or warning code Required Pattern: processing | |
| details |
S | 1..1 | CodeableConcept | Additional details about the error |
| Slices for coding |
3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:eventid |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/eventid | |
| code |
0..1 | code | The event id of the related event. | |
| coding:eventname |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/eventname | |
| code |
0..1 | code | The event eventname of the related event. | |
| coding:subscribername |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/subscribername | |
| code |
0..1 | code | The subscribername of the subscriber causing the event. | |
| diagnostics |
S | 1..1 | string | This field SHALL contain a human readable description of the source and reason for the error. |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OperationOutcome |
0..* | OperationOutcome | Information about the success/failure of an action | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for issue |
SΣ | 1..* | BackboneElement | A single issue associated with the action Slice: Unordered, Open by value:code |
| issue:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| severity |
Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. |
| code |
Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. |
| issue:fhircast |
Σ | 1..1 | BackboneElement | A single issue associated with the action |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| severity |
Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. |
| code |
Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. Required Pattern: processing |
| details |
SΣ | 1..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. |
| Slices for coding |
Σ | 3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:eventid |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/eventid |
| code |
Σ | 0..1 | code | The event id of the related event. |
| coding:eventname |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/eventname |
| code |
Σ | 0..1 | code | The event eventname of the related event. |
| coding:subscribername |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://fhircast.hl7.org/events/syncerror/subscribername |
| code |
Σ | 0..1 | code | The subscribername of the subscriber causing the event. |
| diagnostics |
SΣ | 1..1 | string | This field SHALL contain a human readable description of the source and reason for the error. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| OperationOutcome.issue.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | |
| OperationOutcome.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | |
| OperationOutcome.issue:fhircast.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | |
| OperationOutcome.issue:fhircast.code | required | Pattern: processinghttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | |
| OperationOutcome.issue:fhircast.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard |
| 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 |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for issue |
SΣ | 1..* | BackboneElement | A single issue associated with the action Slice: Unordered, Open by value:code | ||||
| issue:All Slices |
Content/Rules for all slices | |||||||
| 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 |
Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | ||||
| code |
Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | ||||
| details |
Σ | 0..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. | ||||
| diagnostics |
Σ | 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 | ||||
| issue:fhircast |
Σ | 1..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 |
Σ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | ||||
| code |
Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. Required Pattern: processing | ||||
| 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 | |||||
| Slices for coding |
Σ | 3..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:eventid |
Σ | 1..1 | 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 Required Pattern: https://fhircast.hl7.org/events/syncerror/eventid | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | The event id of the related event. | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:eventname |
Σ | 1..1 | 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 Required Pattern: https://fhircast.hl7.org/events/syncerror/eventname | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | The event eventname of the related event. | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:subscribername |
Σ | 1..1 | 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 Required Pattern: https://fhircast.hl7.org/events/syncerror/subscribername | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | The subscribername of the subscriber causing the event. | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| diagnostics |
SΣ | 1..1 | string | This field SHALL contain a human readable description of the source and reason for the error. | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| OperationOutcome.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| OperationOutcome.issue.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | ||||
| OperationOutcome.issue:fhircast.severity | required | IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue:fhircast.code | required | Pattern: processinghttp://hl7.org/fhir/ValueSet/issue-type|4.0.1from the FHIR Standard | ||||
| OperationOutcome.issue:fhircast.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard |
| 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: 9 elements
Must-Support: 3 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 International / Infrastructure And Messaging. Package hl7.fhir.uv.fhircast#3.0.0-ballot based on FHIR 4.0.1. Generated 2024-04-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change