Implementation Guide
23.0.0 - R4 APIs
Publish Box goes here
| Active as of 2023-03-01 |
Definitions for the athena-operationOutcome-profile logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. athena-operationOutcome-profile | |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. athena-operationOutcome-profile.id | |
| Definition | The external reference id of the attachment |
| Short | External reference id |
| Comments | The external reference id of the attachment |
| Control | 1..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| 4. athena-operationOutcome-profile.issue | |
| Definition | Contains the detailed error information related to the failure of the copy of external attachments |
| Short | Issue Details |
| Comments | Contains the detailed error information related to the failure of the copy of external attachments |
| Control | 0..2 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. athena-operationOutcome-profile.issue.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 8. athena-operationOutcome-profile.issue.details | |
| Definition | Additional details about the error |
| Short | Issue Details |
| Comments | Additional details about the error |
| Control | 0..1 |
| Type | CodeableConcept |
| 10. athena-operationOutcome-profile.issue.coding | |
| Definition | Code defined by a terminology system |
| Short | Operation outcome codes |
| Comments | Code defined by a terminology system |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. athena-operationOutcome-profile.issue.system | |
| Definition | Identity of the terminology system |
| Short | Identity of the terminology system |
| Comments | Identity of the terminology system |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. athena-operationOutcome-profile.issue.code | |
| Definition | Code relevant to the nature of the error |
| Short | Symbol in syntax defined by the system |
| Comments | Symbol in syntax defined by the system |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. athena-operationOutcome-profile.issue.display | |
| Definition | Representation defined by the system |
| Short | Representation defined by the system |
| Comments | Location of the external attachment which could not be copied. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. athena-operationOutcome-profile.issue.text | |
| Definition | Plain text representation of the concept |
| Short | Plain text representation of the concept |
| Comments | Resolution comments |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. athena-operationOutcome-profile.issue.severity | |
| Definition | Severity of the issue |
| Short | Severity of the issue |
| Comments | fatal | error | warning | information |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. athena-operationOutcome-profile.issue.diagnostics | |
| Definition | Additional diagnostic information about the issue |
| Short | Diagnostic information |
| Comments | Detailed description of the cause of the error |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. athena-operationOutcome-profile | |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. athena-operationOutcome-profile.id | |
| Definition | The external reference id of the attachment |
| Short | External reference id |
| Comments | The external reference id of the attachment |
| Control | 1..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 4. athena-operationOutcome-profile.issue | |
| Definition | Contains the detailed error information related to the failure of the copy of external attachments |
| Short | Issue Details |
| Comments | Contains the detailed error information related to the failure of the copy of external attachments |
| Control | 0..2 |
| Type | BackboneElement |
| 6. athena-operationOutcome-profile.issue.details | |
| Definition | Additional details about the error |
| Short | Issue Details |
| Comments | Additional details about the error |
| Control | 0..1 |
| Type | CodeableConcept |
| 8. athena-operationOutcome-profile.issue.coding | |
| Definition | Code defined by a terminology system |
| Short | Operation outcome codes |
| Comments | Code defined by a terminology system |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. athena-operationOutcome-profile.issue.system | |
| Definition | Identity of the terminology system |
| Short | Identity of the terminology system |
| Comments | Identity of the terminology system |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. athena-operationOutcome-profile.issue.code | |
| Definition | Code relevant to the nature of the error |
| Short | Symbol in syntax defined by the system |
| Comments | Symbol in syntax defined by the system |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. athena-operationOutcome-profile.issue.display | |
| Definition | Representation defined by the system |
| Short | Representation defined by the system |
| Comments | Location of the external attachment which could not be copied. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. athena-operationOutcome-profile.issue.text | |
| Definition | Plain text representation of the concept |
| Short | Plain text representation of the concept |
| Comments | Resolution comments |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. athena-operationOutcome-profile.issue.severity | |
| Definition | Severity of the issue |
| Short | Severity of the issue |
| Comments | fatal | error | warning | information |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. athena-operationOutcome-profile.issue.diagnostics | |
| Definition | Additional diagnostic information about the issue |
| Short | Diagnostic information |
| Comments | Detailed description of the cause of the error |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. athena-operationOutcome-profile | |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. athena-operationOutcome-profile.id | |
| Definition | The external reference id of the attachment |
| Short | External reference id |
| Comments | The external reference id of the attachment |
| Control | 1..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| 4. athena-operationOutcome-profile.issue | |
| Definition | Contains the detailed error information related to the failure of the copy of external attachments |
| Short | Issue Details |
| Comments | Contains the detailed error information related to the failure of the copy of external attachments |
| Control | 0..2 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. athena-operationOutcome-profile.issue.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 8. athena-operationOutcome-profile.issue.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on athena-operationOutcome-profile.issue.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. athena-operationOutcome-profile.issue.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. athena-operationOutcome-profile.issue.details | |
| Definition | Additional details about the error |
| Short | Issue Details |
| Comments | Additional details about the error |
| Control | 0..1 |
| Type | CodeableConcept |
| 14. athena-operationOutcome-profile.issue.coding | |
| Definition | Code defined by a terminology system |
| Short | Operation outcome codes |
| Comments | Code defined by a terminology system |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. athena-operationOutcome-profile.issue.system | |
| Definition | Identity of the terminology system |
| Short | Identity of the terminology system |
| Comments | Identity of the terminology system |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. athena-operationOutcome-profile.issue.code | |
| Definition | Code relevant to the nature of the error |
| Short | Symbol in syntax defined by the system |
| Comments | Symbol in syntax defined by the system |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. athena-operationOutcome-profile.issue.display | |
| Definition | Representation defined by the system |
| Short | Representation defined by the system |
| Comments | Location of the external attachment which could not be copied. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. athena-operationOutcome-profile.issue.text | |
| Definition | Plain text representation of the concept |
| Short | Plain text representation of the concept |
| Comments | Resolution comments |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. athena-operationOutcome-profile.issue.severity | |
| Definition | Severity of the issue |
| Short | Severity of the issue |
| Comments | fatal | error | warning | information |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. athena-operationOutcome-profile.issue.diagnostics | |
| Definition | Additional diagnostic information about the issue |
| Short | Diagnostic information |
| Comments | Detailed description of the cause of the error |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |