DK MedCom Messaging
2.0.0 - Build CI Denmark flag

This page is part of the DK MedCom Messaging (v2.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: MedComMessagingMessageHeader

Official URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-messageHeader Version: 2.0.0
Active as of 2024-02-15 Computable Name: MedComMessagingMessageHeader

MessageHeader for MedCom messages

Scope and usage

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.

Shows the MedComMessageHeader, which references the MedComMessagingOrganization as a sender, reciever and carbon-copy.

Please refer to the tab “Snapshot Table(Must support)” below for the definition of the required content of a MedComMessagingMessageHeader.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id S1..1idEach message shall include a globally unique id.
... text S0..1NarrativeA 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] S1..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Binding: http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes (required)
.... code 1..1codeSymbol in syntax defined by the system
.... destination:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
.... destination:primary S1..1BackboneElementMessage destination application(s)
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: primary
..... endpoint S1..1urlActual destination address or id
..... receiver S1..1Reference(MedComMessagingOrganization) {b}The primary reciever of the message
.... destination:cc 0..*BackboneElementMessage destination application(s)
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: cc
..... endpoint S1..1urlActual destination address or id
..... receiver S1..1Reference(MedComMessagingOrganization) {b}The carbon copy reciever of the message. Is only used when a message has multiple recievers.
... sender S1..1Reference(MedComMessagingOrganization) {b}The actual sender of the message
... source S1..1BackboneElementContains the information about the target for the Acknowledgement message.
.... endpoint S1..1urlActual message source address or id

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MessageHeader.event[x]requiredhttp://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id SΣ1..1idEach message shall include a globally unique id.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S0..1NarrativeA 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..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Binding: http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes (required)
.... code Σ1..1codeSymbol in syntax defined by the system
... Slices for destination Σ1..*BackboneElementMessage destination application(s)
Slice: Unordered, Closed by value:$this.extension.value
.... destination:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... endpoint Σ1..1urlActual destination address or id
.... destination:primary SΣ1..1BackboneElementMessage destination application(s)
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... extension 0..0
...... url 1..1uri"http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension"
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: primary
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... endpoint SΣ1..1urlActual destination address or id
..... receiver SΣ1..1Reference(MedComMessagingOrganization) {b}The primary reciever of the message
.... destination:cc Σ0..*BackboneElementMessage destination application(s)
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... extension 0..0
...... url 1..1uri"http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension"
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: cc
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... endpoint SΣ1..1urlActual destination address or id
..... receiver SΣ1..1Reference(MedComMessagingOrganization) {b}The carbon copy reciever of the message. Is only used when a message has multiple recievers.
... sender SΣ1..1Reference(MedComMessagingOrganization) {b}The actual sender of the message
... source SΣ1..1BackboneElementContains the information about the target for the Acknowledgement message.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual message source address or id

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]requiredhttp://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id SΣ1..1idEach message shall include a globally unique id.
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S0..1NarrativeA 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..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Binding: http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ0..1uriIdentity of the terminology system
.... version Σ0..1stringVersion of the system - if relevant
.... code Σ1..1codeSymbol in syntax defined by the system
.... display Σ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... Slices for destination Σ1..*BackboneElementMessage destination application(s)
Slice: Unordered, Closed by value:$this.extension.value
.... destination:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ0..1stringName of system
..... target Σ0..1Reference(Device)Particular delivery destination within the destination
..... endpoint Σ1..1urlActual destination address or id
..... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
.... destination:primary SΣ1..1BackboneElementMessage destination application(s)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension"
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: primary
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Required Pattern: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ0..1stringName of system
..... target Σ0..1Reference(Device)Particular delivery destination within the destination
..... endpoint SΣ1..1urlActual destination address or id
..... receiver SΣ1..1Reference(MedComMessagingOrganization) {b}The primary reciever of the message
.... destination:cc Σ0..*BackboneElementMessage destination application(s)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension"
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: cc
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Required Pattern: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ0..1stringName of system
..... target Σ0..1Reference(Device)Particular delivery destination within the destination
..... endpoint SΣ1..1urlActual destination address or id
..... receiver SΣ1..1Reference(MedComMessagingOrganization) {b}The carbon copy reciever of the message. Is only used when a message has multiple recievers.
... sender SΣ1..1Reference(MedComMessagingOrganization) {b}The actual sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source SΣ1..1BackboneElementContains the information about the target for the Acknowledgement message.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint SΣ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus Σ0..*Reference(Resource)The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]requiredhttp://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element MessageHeader.destination is sliced based on the value of value:$this.extension.value (Closed)

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id S1..1idEach message shall include a globally unique id.
... text S0..1NarrativeA 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] S1..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Binding: http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes (required)
.... code 1..1codeSymbol in syntax defined by the system
.... destination:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
.... destination:primary S1..1BackboneElementMessage destination application(s)
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: primary
..... endpoint S1..1urlActual destination address or id
..... receiver S1..1Reference(MedComMessagingOrganization) {b}The primary reciever of the message
.... destination:cc 0..*BackboneElementMessage destination application(s)
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: cc
..... endpoint S1..1urlActual destination address or id
..... receiver S1..1Reference(MedComMessagingOrganization) {b}The carbon copy reciever of the message. Is only used when a message has multiple recievers.
... sender S1..1Reference(MedComMessagingOrganization) {b}The actual sender of the message
... source S1..1BackboneElementContains the information about the target for the Acknowledgement message.
.... endpoint S1..1urlActual message source address or id

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MessageHeader.event[x]requiredhttp://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id SΣ1..1idEach message shall include a globally unique id.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S0..1NarrativeA 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..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Binding: http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes (required)
.... code Σ1..1codeSymbol in syntax defined by the system
... Slices for destination Σ1..*BackboneElementMessage destination application(s)
Slice: Unordered, Closed by value:$this.extension.value
.... destination:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... endpoint Σ1..1urlActual destination address or id
.... destination:primary SΣ1..1BackboneElementMessage destination application(s)
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... extension 0..0
...... url 1..1uri"http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension"
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: primary
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... endpoint SΣ1..1urlActual destination address or id
..... receiver SΣ1..1Reference(MedComMessagingOrganization) {b}The primary reciever of the message
.... destination:cc Σ0..*BackboneElementMessage destination application(s)
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... extension 0..0
...... url 1..1uri"http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension"
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: cc
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... endpoint SΣ1..1urlActual destination address or id
..... receiver SΣ1..1Reference(MedComMessagingOrganization) {b}The carbon copy reciever of the message. Is only used when a message has multiple recievers.
... sender SΣ1..1Reference(MedComMessagingOrganization) {b}The actual sender of the message
... source SΣ1..1BackboneElementContains the information about the target for the Acknowledgement message.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual message source address or id

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]requiredhttp://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id SΣ1..1idEach message shall include a globally unique id.
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text S0..1NarrativeA 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..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... event[x] SΣ1..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Binding: http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ0..1uriIdentity of the terminology system
.... version Σ0..1stringVersion of the system - if relevant
.... code Σ1..1codeSymbol in syntax defined by the system
.... display Σ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... Slices for destination Σ1..*BackboneElementMessage destination application(s)
Slice: Unordered, Closed by value:$this.extension.value
.... destination:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ0..1stringName of system
..... target Σ0..1Reference(Device)Particular delivery destination within the destination
..... endpoint Σ1..1urlActual destination address or id
..... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
.... destination:primary SΣ1..1BackboneElementMessage destination application(s)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension"
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: primary
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Required Pattern: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ0..1stringName of system
..... target Σ0..1Reference(Device)Particular delivery destination within the destination
..... endpoint SΣ1..1urlActual destination address or id
..... receiver SΣ1..1Reference(MedComMessagingOrganization) {b}The primary reciever of the message
.... destination:cc Σ0..*BackboneElementMessage destination application(s)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use S1..1CodingMedComDestinationUseExtension
URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension"
...... value[x] 1..1CodingValue of extension
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: cc
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Required Pattern: http://medcomfhir.dk/fhir/dk-medcom-terminology/CodeSystem/medcom-messaging-destinationUse
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ0..1stringName of system
..... target Σ0..1Reference(Device)Particular delivery destination within the destination
..... endpoint SΣ1..1urlActual destination address or id
..... receiver SΣ1..1Reference(MedComMessagingOrganization) {b}The carbon copy reciever of the message. Is only used when a message has multiple recievers.
... sender SΣ1..1Reference(MedComMessagingOrganization) {b}The actual sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source SΣ1..1BackboneElementContains the information about the target for the Acknowledgement message.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint SΣ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus Σ0..*Reference(Resource)The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]requiredhttp://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-messaging-messageTypes
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element MessageHeader.destination is sliced based on the value of value:$this.extension.value (Closed)

 

Other representations of profile: CSV, Excel, Schematron