Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG
1.0.0 - STU1
Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG
1.0.0 - STU1
Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG, published by HL7 International / Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/HL7/fhir-registry-protocols-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/registry-protocols/StructureDefinition/CREDSOperationOutcome | Version: 1.0.0 | |||
| Active as of 2023-11-14 | Computable Name: CREDSOperationOutcome | |||
The Profile for validation responses for CREDS submitted bundles.
Each Operation Outcome begins with the Submission identifier as the first issue entry. Each following issue element contains a single validation message
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 | 2..* | BackboneElement | A single issue associated with the action Slice: Ordered, Closed by pattern:code | |
   issue:Submission | 1..1 | BackboneElement | A single issue associated with the action | |
   severity | 1..1 | code | fatal | error | warning | information Fixed Value: information | |
| code | 1..1 | code | Error or warning code Fixed Value: informational | |
| details | 0..0 | |||
| diagnostics | 0..1 | string | Additional diagnostic information about the issue | |
| location | 0..0 | |||
 expression | 0..0 | |||
 issue:Validation | 1..* | BackboneElement | A single issue associated with the action | |
| code | 1..1 | code | Error or warning code Fixed Value: processing | |
| details | 0..1 | CodeableConcept | Additional details about the error | |
| diagnostics | 0..1 | string | Additional diagnostic information about the issue | |
| location | 0..0 | |||
| expression | 1..* | string | FHIRPath of element(s) related to issue | |
| 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 | Σ | 2..* | BackboneElement | A single issue associated with the action Slice: Ordered, Closed by pattern: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:Submission | Σ | 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. Fixed Value: information |
| code | Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. Fixed Value: informational |
| diagnostics | Σ | 0..1 | string | Additional diagnostic information about the issue |
| issue:Validation | Σ | 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. Fixed Value: processing |
 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 |
| expression | Σ | 1..* | string | FHIRPath of element(s) related to issue |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| OperationOutcome.issue.severity | required | IssueSeverity |
| OperationOutcome.issue.code | required | IssueType |
| OperationOutcome.issue:Submission.severity | required | Fixed Value: information |
| OperationOutcome.issue:Submission.code | required | Fixed Value: informational |
| OperationOutcome.issue:Validation.severity | required | IssueSeverity |
| OperationOutcome.issue:Validation.code | required | Fixed Value: processing |
| OperationOutcome.issue:Validation.details | example | OperationOutcomeCodes |
| 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 | Σ | 2..* | BackboneElement | A single issue associated with the action Slice: Ordered, Closed by pattern: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:Submission | Σ | 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. Fixed Value: information | ||||
| code | Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. Fixed Value: informational | ||||
| diagnostics | Σ | 0..1 | string | Additional diagnostic information about the issue | ||||
| issue:Validation | Σ | 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. Fixed Value: processing | ||||
| 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 | ||||
| expression | Σ | 1..* | string | FHIRPath of element(s) related to issue | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| OperationOutcome.language | preferred | CommonLanguages
| ||||
| OperationOutcome.issue.severity | required | IssueSeverity | ||||
| OperationOutcome.issue.code | required | IssueType | ||||
| OperationOutcome.issue.details | example | OperationOutcomeCodes | ||||
| OperationOutcome.issue:Submission.severity | required | Fixed Value: information | ||||
| OperationOutcome.issue:Submission.code | required | Fixed Value: informational | ||||
| OperationOutcome.issue:Validation.severity | required | IssueSeverity | ||||
| OperationOutcome.issue:Validation.code | required | Fixed Value: processing | ||||
| OperationOutcome.issue:Validation.details | example | OperationOutcomeCodes |
This structure is derived from OperationOutcome
Summary
Mandatory: 3 elements
Fixed Value: 3 elements
Prohibited: 4 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 | 2..* | BackboneElement | A single issue associated with the action Slice: Ordered, Closed by pattern:code | |
| issue:Submission | 1..1 | BackboneElement | A single issue associated with the action | |
| severity | 1..1 | code | fatal | error | warning | information Fixed Value: information | |
| code | 1..1 | code | Error or warning code Fixed Value: informational | |
| details | 0..0 | |||
| diagnostics | 0..1 | string | Additional diagnostic information about the issue | |
| location | 0..0 | |||
| expression | 0..0 | |||
| issue:Validation | 1..* | BackboneElement | A single issue associated with the action | |
| code | 1..1 | code | Error or warning code Fixed Value: processing | |
| details | 0..1 | CodeableConcept | Additional details about the error | |
| diagnostics | 0..1 | string | Additional diagnostic information about the issue | |
| location | 0..0 | |||
| expression | 1..* | string | FHIRPath of element(s) related to issue | |
| 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 | Σ | 2..* | BackboneElement | A single issue associated with the action Slice: Ordered, Closed by pattern: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:Submission | Σ | 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. Fixed Value: information |
| code | Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. Fixed Value: informational |
| diagnostics | Σ | 0..1 | string | Additional diagnostic information about the issue |
| issue:Validation | Σ | 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. Fixed Value: processing |
| 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 |
| expression | Σ | 1..* | string | FHIRPath of element(s) related to issue |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| OperationOutcome.issue.severity | required | IssueSeverity |
| OperationOutcome.issue.code | required | IssueType |
| OperationOutcome.issue:Submission.severity | required | Fixed Value: information |
| OperationOutcome.issue:Submission.code | required | Fixed Value: informational |
| OperationOutcome.issue:Validation.severity | required | IssueSeverity |
| OperationOutcome.issue:Validation.code | required | Fixed Value: processing |
| OperationOutcome.issue:Validation.details | example | OperationOutcomeCodes |
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 | Σ | 2..* | BackboneElement | A single issue associated with the action Slice: Ordered, Closed by pattern: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:Submission | Σ | 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. Fixed Value: information | ||||
| code | Σ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. Fixed Value: informational | ||||
| diagnostics | Σ | 0..1 | string | Additional diagnostic information about the issue | ||||
| issue:Validation | Σ | 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. Fixed Value: processing | ||||
| 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 | ||||
| expression | Σ | 1..* | string | FHIRPath of element(s) related to issue | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| OperationOutcome.language | preferred | CommonLanguages
| ||||
| OperationOutcome.issue.severity | required | IssueSeverity | ||||
| OperationOutcome.issue.code | required | IssueType | ||||
| OperationOutcome.issue.details | example | OperationOutcomeCodes | ||||
| OperationOutcome.issue:Submission.severity | required | Fixed Value: information | ||||
| OperationOutcome.issue:Submission.code | required | Fixed Value: informational | ||||
| OperationOutcome.issue:Validation.severity | required | IssueSeverity | ||||
| OperationOutcome.issue:Validation.code | required | Fixed Value: processing | ||||
| OperationOutcome.issue:Validation.details | example | OperationOutcomeCodes |
This structure is derived from OperationOutcome
Summary
Mandatory: 3 elements
Fixed Value: 3 elements
Prohibited: 4 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Interoperability Council. Package hl7.fhir.us.registry-protocols#1.0.0 based on FHIR 4.0.1. Generated 2023-11-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change