DK MedCom acknowledgement
2.0.3 - Release
DK MedCom acknowledgement
2.0.3 - Release
DK MedCom acknowledgement, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 2.0.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk-medcom-acknowledgement/ and changes regularly. See the Directory of published versions
| Official URL: http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-acknowledgement-operationoutcome | Version: 2.0.3 | |||
| Active as of 2024-09-25 | Computable Name: MedComAcknowledgementOperationOutcome | |||
This profile provides detailed information about the outcome of an attempted system operation, such as delivering a message. It shall only be used when the attempt fails.
This profile is called MedComAcknowledgementOperationOutcome and is used to give a detailed describtion of errors occuring when exchanging FHIR messages. Succes or fail in message exchange can be found in the element MessageHeader.response.code. MedComAcknowledgementOperationOutcome can be seen as a help for IT-vendors to identify potential errors in their systems, as it least shall contain a description of the issue, including a severity and an error or warning code. It may include several issues.
Please refer to the tab "Snapshot Table(Must support)" below for the definition of the required content of a MedComAcknowledgementMessage.
MedComAcknowledgementOperationOutcome should not be included when the message exchange goes well, corresponding to the value 'ok' in MessageHeader.response.code. However, may be included when the MessageHeader.response.code is 'ok', e.g. in cases where the received message is valid, but it is a dublet of a previous sent message. In this case an OperationOutcome with a value of OperationOutcome.issue.severity 'information' and a relevant code could be included. An OperationOutcome resource shall be included when the element MessageHeader.response.code is different from 'ok'.
The CodeSystem MedComAcknowledgementIssueDetailsand ValueSetMedComAcknowledgementIssueDetailValues used in the element OperationOutCome.issue.details.coding are used to describe the issue of receiving a message more detailed. Currently, the two terminologies are fairly empty, as MedCom wants input from IT-vendors on which issue codes provide value in IT-systems. Across sectors there must be an agreed list of codes. Therefore, the ValueSet has a status as 'draft' and vendors should expect the CodeSystem and ValueSet to be extended. For relevant input regarding the issue codes, please contact MedCom.
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 | |
  issue |
S | 1..* | BackboneElement | A single issue associated with the action |
  severity |
S | 1..1 | code | fatal | error | warning | information |
| code |
S | 1..1 | code | Error or warning code |
| details |
S | 0..1 | CodeableConcept | Additional details about the error |
| coding |
S | 0..* | Coding | Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required) |
 text |
S | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| OperationOutcome.issue.details.coding | required | MedComAcknowledgementIssueDetailValueshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-acknowledgement-issue-details |
| 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 |
 issue |
SΣ | 1..* | BackboneElement | A single issue associated with the action |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| severity |
SΣ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. |
| code |
SΣ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. |
| details |
SΣ | 0..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required) |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | 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.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | |
| OperationOutcome.issue.details.coding | required | MedComAcknowledgementIssueDetailValueshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-acknowledgement-issue-details |
| 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 | ||||
| issue |
SΣ | 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 |
SΣ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | ||||
| code |
SΣ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | ||||
 details |
SΣ | 0..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 | |||||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required) | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | 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.details.coding | required | MedComAcknowledgementIssueDetailValueshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-acknowledgement-issue-details |
| 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
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 | |
| issue |
S | 1..* | BackboneElement | A single issue associated with the action |
| severity |
S | 1..1 | code | fatal | error | warning | information |
| code |
S | 1..1 | code | Error or warning code |
| details |
S | 0..1 | CodeableConcept | Additional details about the error |
| coding |
S | 0..* | Coding | Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required) |
| text |
S | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| OperationOutcome.issue.details.coding | required | MedComAcknowledgementIssueDetailValueshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-acknowledgement-issue-details |
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 |
| issue |
SΣ | 1..* | BackboneElement | A single issue associated with the action |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| severity |
SΣ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. |
| code |
SΣ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. |
| details |
SΣ | 0..1 | CodeableConcept | Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue. |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required) |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | 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.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | |
| OperationOutcome.issue.details.coding | required | MedComAcknowledgementIssueDetailValueshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-acknowledgement-issue-details |
| 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 | ||||
| issue |
SΣ | 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 |
SΣ | 1..1 | code | fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action. | ||||
| code |
SΣ | 1..1 | code | Error or warning code Binding: IssueType (required): A code that describes the type of issue. | ||||
| details |
SΣ | 0..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 | |||||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required) | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | 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.details.coding | required | MedComAcknowledgementIssueDetailValueshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-acknowledgement-issue-details |
| 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
Other representations of profile: CSV, Excel, Schematron