DK MedCom Messaging
2.1.0 - release
This page is part of the DK MedCom Messaging (v2.1.0: Release) based on FHIR R4. The current version which supercedes this version is 1.0.3. For a full list of available versions, see the Directory of published versions
Official URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-messageHeader | Version: 2.1.0 | |||
Active as of 2023-10-31 | Computable Name: MedComMessagingMessageHeader |
MessageHeader for MedCom messages
This profile describes the MessageHeader resource that shall be used in all MedCom FHIR Messages. A MedComMessagingMessageHeader shall include a sender and receiver and it may include a carbon-copy receiver, however this is depended on type of standard. Each MedComMessagingMessageHeader shall include a globally unique id, which is used to describe the message history from the MedComMessagingProvenance profile.
The element event shall be defined in accordance with the type of standard the message concerns e.g., HospitalNotification and CareCommunication. Due to the different requirements for each standard, it should be expected that the MedComMessagingMessageHeader is inherited in each standard.
Please refer to the tab “Snapshot Table(Must support)” below for the definition of the required content of a MedComMessagingMessageHeader.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
id | S | 1..1 | id | Each message shall include a globally unique id. |
text | S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. |
event[x] | S | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (required) |
code | 1..1 | code | Symbol in syntax defined by the system | |
Slices for destination | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value | |
destination:All Slices | Content/Rules for all slices | |||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
destination:primary | S | 1..1 | BackboneElement | Message destination application(s) |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |
endpoint | S | 1..1 | url | Actual destination address or id |
receiver | S | 1..1 | Reference(MedComMessagingOrganization) {b} | The primary reciever of the message |
destination:cc | 0..* | BackboneElement | Message destination application(s) | |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cc | |
endpoint | S | 1..1 | url | Actual destination address or id |
receiver | S | 1..1 | Reference(MedComMessagingOrganization) {b} | The carbon copy reciever of the message. Is only used when a message has multiple recievers. |
sender | S | 1..1 | Reference(MedComMessagingOrganization) {b} | The actual sender of the message |
source | S | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. |
endpoint | S | 1..1 | url | Actual message source address or id |
Documentation for this format |
Path | Conformance | ValueSet |
MessageHeader.event[x] | required | MedComMessagingMessageTypes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
id | SΣ | 1..1 | id | Each message shall include a globally unique id. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
text | S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
event[x] | SΣ | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (required) |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
Slices for destination | Σ | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value |
destination:All Slices | Content/Rules for all slices | |||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
endpoint | Σ | 1..1 | url | Actual destination address or id |
destination:primary | SΣ | 1..1 | BackboneElement | Message destination application(s) |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
extension | 0..0 | |||
url | 1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
endpoint | SΣ | 1..1 | url | Actual destination address or id |
receiver | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The primary reciever of the message |
destination:cc | Σ | 0..* | BackboneElement | Message destination application(s) |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
extension | 0..0 | |||
url | 1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cc | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
endpoint | SΣ | 1..1 | url | Actual destination address or id |
receiver | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The carbon copy reciever of the message. Is only used when a message has multiple recievers. |
sender | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The actual sender of the message |
source | SΣ | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
endpoint | SΣ | 1..1 | url | Actual message source address or id |
Documentation for this format |
Path | Conformance | ValueSet |
MessageHeader.event[x] | required | MedComMessagingMessageTypes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | 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 | ||||
---|---|---|---|---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
id | SΣ | 1..1 | id | Each message shall include a globally unique id. | ||||
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 | S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
event[x] | SΣ | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (required) | ||||
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 | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
Slices for destination | Σ | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value | ||||
destination:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 0..1 | string | Name of system | ||||
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
endpoint | Σ | 1..1 | url | Actual destination address or id | ||||
receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
destination:primary | SΣ | 1..1 | BackboneElement | Message destination application(s) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |||||
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 0..1 | string | Name of system | ||||
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
endpoint | SΣ | 1..1 | url | Actual destination address or id | ||||
receiver | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The primary reciever of the message | ||||
destination:cc | Σ | 0..* | BackboneElement | Message destination application(s) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |||||
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cc | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 0..1 | string | Name of system | ||||
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
endpoint | SΣ | 1..1 | url | Actual destination address or id | ||||
receiver | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The carbon copy reciever of the message. Is only used when a message has multiple recievers. | ||||
sender | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The actual sender of the message | ||||
enterer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
source | SΣ | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. | ||||
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 | ||||
name | Σ | 0..1 | string | Name of system | ||||
software | Σ | 0..1 | string | Name of software running the system | ||||
version | Σ | 0..1 | string | Version of software running | ||||
contact | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
endpoint | SΣ | 1..1 | url | Actual message source address or id | ||||
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
response | Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
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 | ||||
identifier | Σ | 1..1 | id | Id of original message | ||||
code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
focus | Σ | 0..* | Reference(Resource) | The actual content of the message | ||||
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
MessageHeader.language | preferred | CommonLanguages
| ||||
MessageHeader.event[x] | required | MedComMessagingMessageTypes | ||||
MessageHeader.reason | example | ExampleMessageReasonCodes | ||||
MessageHeader.response.code | required | ResponseType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | 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 MessageHeader
Summary
Mandatory: 9 elements (2 nested mandatory elements)
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
id | S | 1..1 | id | Each message shall include a globally unique id. |
text | S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. |
event[x] | S | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (required) |
code | 1..1 | code | Symbol in syntax defined by the system | |
Slices for destination | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value | |
destination:All Slices | Content/Rules for all slices | |||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
destination:primary | S | 1..1 | BackboneElement | Message destination application(s) |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |
endpoint | S | 1..1 | url | Actual destination address or id |
receiver | S | 1..1 | Reference(MedComMessagingOrganization) {b} | The primary reciever of the message |
destination:cc | 0..* | BackboneElement | Message destination application(s) | |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cc | |
endpoint | S | 1..1 | url | Actual destination address or id |
receiver | S | 1..1 | Reference(MedComMessagingOrganization) {b} | The carbon copy reciever of the message. Is only used when a message has multiple recievers. |
sender | S | 1..1 | Reference(MedComMessagingOrganization) {b} | The actual sender of the message |
source | S | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. |
endpoint | S | 1..1 | url | Actual message source address or id |
Documentation for this format |
Path | Conformance | ValueSet |
MessageHeader.event[x] | required | MedComMessagingMessageTypes |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
id | SΣ | 1..1 | id | Each message shall include a globally unique id. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
text | S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
event[x] | SΣ | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (required) |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
Slices for destination | Σ | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value |
destination:All Slices | Content/Rules for all slices | |||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
endpoint | Σ | 1..1 | url | Actual destination address or id |
destination:primary | SΣ | 1..1 | BackboneElement | Message destination application(s) |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
extension | 0..0 | |||
url | 1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
endpoint | SΣ | 1..1 | url | Actual destination address or id |
receiver | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The primary reciever of the message |
destination:cc | Σ | 0..* | BackboneElement | Message destination application(s) |
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
extension | 0..0 | |||
url | 1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cc | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
endpoint | SΣ | 1..1 | url | Actual destination address or id |
receiver | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The carbon copy reciever of the message. Is only used when a message has multiple recievers. |
sender | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The actual sender of the message |
source | SΣ | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
endpoint | SΣ | 1..1 | url | Actual message source address or id |
Documentation for this format |
Path | Conformance | ValueSet |
MessageHeader.event[x] | required | MedComMessagingMessageTypes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | 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 | ||||
---|---|---|---|---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
id | SΣ | 1..1 | id | Each message shall include a globally unique id. | ||||
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 | S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
event[x] | SΣ | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (required) | ||||
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 | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
Slices for destination | Σ | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value | ||||
destination:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 0..1 | string | Name of system | ||||
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
endpoint | Σ | 1..1 | url | Actual destination address or id | ||||
receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
destination:primary | SΣ | 1..1 | BackboneElement | Message destination application(s) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |||||
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 0..1 | string | Name of system | ||||
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
endpoint | SΣ | 1..1 | url | Actual destination address or id | ||||
receiver | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The primary reciever of the message | ||||
destination:cc | Σ | 0..* | BackboneElement | Message destination application(s) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | S | 1..1 | Coding | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |||||
value[x] | 1..1 | Coding | Value of extension Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cc | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 0..1 | string | Name of system | ||||
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
endpoint | SΣ | 1..1 | url | Actual destination address or id | ||||
receiver | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The carbon copy reciever of the message. Is only used when a message has multiple recievers. | ||||
sender | SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | The actual sender of the message | ||||
enterer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
source | SΣ | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. | ||||
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 | ||||
name | Σ | 0..1 | string | Name of system | ||||
software | Σ | 0..1 | string | Name of software running the system | ||||
version | Σ | 0..1 | string | Version of software running | ||||
contact | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
endpoint | SΣ | 1..1 | url | Actual message source address or id | ||||
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
response | Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
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 | ||||
identifier | Σ | 1..1 | id | Id of original message | ||||
code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
focus | Σ | 0..* | Reference(Resource) | The actual content of the message | ||||
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
MessageHeader.language | preferred | CommonLanguages
| ||||
MessageHeader.event[x] | required | MedComMessagingMessageTypes | ||||
MessageHeader.reason | example | ExampleMessageReasonCodes | ||||
MessageHeader.response.code | required | ResponseType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | 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 MessageHeader
Summary
Mandatory: 9 elements (2 nested mandatory elements)
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron