DK MedCom acknowledgement
2.0.2 - Release Denmark flag

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

Resource Profile: MedComAcknowledgementMessageHeader

Official URL: http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader Version: 2.0.2
Active as of 2024-02-05 Computable Name: MedComAcknowledgementMessageHeader

A resource that describes a reponse to a message that is exchanged as a MedCom messgage within Danish healthcare

Scope and usage

This profile is used as the MessageHeader resource for the MedCom Acknowledgement message. Constraint and rules from MedComMessagingMessageHeader is inherited to this profile. However, does MedComAcknowledgementMessageHeader not allow for a receiver of the type carbon-copy and the profile requires a response code. This code includes information about the delivery of a message e.g., if the message was delivered without error it would resolve in response code ‘ok’.

Below can the structure of a MedCom AcknowledgementMessageHeader be seen.

The MedComAcknowledgementMessageHeader includes references to the MedComMessagingOrganization. Additionally, it is possible to include an OperationOutCome profile, referenced from MedComAcknowledgementMessageHeader.

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

Respons code

A MedComAcknowledgementMessageHeader is required in MedCom FHIR Messaging and follows the recommandations from HL7 FHIR ValueSet response-code

The codes here are equivalent to HL7 v3.Acknowledgement as described in the table below.

HL7 FHIR Code HL7 FHIR Code Display HL7 FHIR Definition HL7 v3 Code HL7 v3 Code Display HL7 v3 Definition
ok OK The message was accepted and processed without error. AA Application Acknowledgement Accept Receiving application successfully processed message.
fatal-error Fatal Error The message was rejected because of a problem with the content. There is no point in re-sending without change. The response narrative SHALL describe the issue. AE Application Acknowledgement Error Receiving application found error in processing message. Sending error response with additional error detail information.
transient-error Transient Error Some internal unexpected error occurred - wait and try again. Note - this is usually used for things like database unavailable, which may be expected to resolve, though human intervention may be required. AR Application Acknowledgement Reject Receiving application failed to process message for reason unrelated to content or format. Original message sender must decide on whether to automatically send message again.

Please go to this definition of OperationOutcome to get informed how and when to use if the code response is different from “OK”.

Usage:

Formal Views of Profile Content

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

This structure is derived from MedComMessagingMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MedComMessagingMessageHeaderA resource that describes a message that is exchanged between systems
... destination:cc 0..0
... source 1..1BackboneElementContains information about the sender of the Acknowledgement message
... response S1..1BackboneElementIf this is a reply to prior message
.... identifier S1..1idId of original message
.... code S1..1codeok | transient-error | fatal-error
.... details S0..1Reference(MedComAcknowledgementOperationOutcome)Specific list of hints/warnings/errors

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MedComMessagingMessageHeaderA 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.
... Slices for event[x] Σ1..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ1..1CodingCode for the event this message represents or link to event definition
Binding: MedComMessagingMessageTypes (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"
...... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCoding 1..1CodingValue of extension
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/ig/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
... sender SΣ1..1Reference(MedComMessagingOrganization) {b}The actual sender of the message
... source SΣ1..1BackboneElementContains information about the sender of the Acknowledgement message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual message source address or id
... response SΣ1..1BackboneElementIf this is a reply to prior message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier SΣ1..1idId of original message
.... code SΣ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ0..1Reference(MedComAcknowledgementOperationOutcome)Specific list of hints/warnings/errors

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingrequiredMedComMessagingMessageTypes
http://medcomfhir.dk/ig/terminology/ValueSet/medcom-messaging-messageTypes
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MedComMessagingMessageHeaderA 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
... Slices for event[x] Σ1..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ1..1CodingCode for the event this message represents or link to event definition
Binding: MedComMessagingMessageTypes (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
..... 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"
...... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCoding 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/ig/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/ig/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
... 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 information about the sender of 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 SΣ1..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 SΣ1..1idId of original message
.... code SΣ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ0..1Reference(MedComAcknowledgementOperationOutcome)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]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingrequiredMedComMessagingMessageTypes
http://medcomfhir.dk/ig/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 MedComMessagingMessageHeader

Summary

Mandatory: 1 element
Must-Support: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from MedComMessagingMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MedComMessagingMessageHeaderA resource that describes a message that is exchanged between systems
... destination:cc 0..0
... source 1..1BackboneElementContains information about the sender of the Acknowledgement message
... response S1..1BackboneElementIf this is a reply to prior message
.... identifier S1..1idId of original message
.... code S1..1codeok | transient-error | fatal-error
.... details S0..1Reference(MedComAcknowledgementOperationOutcome)Specific list of hints/warnings/errors

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MedComMessagingMessageHeaderA 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.
... Slices for event[x] Σ1..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ1..1CodingCode for the event this message represents or link to event definition
Binding: MedComMessagingMessageTypes (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"
...... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCoding 1..1CodingValue of extension
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: http://medcomfhir.dk/ig/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
... sender SΣ1..1Reference(MedComMessagingOrganization) {b}The actual sender of the message
... source SΣ1..1BackboneElementContains information about the sender of the Acknowledgement message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual message source address or id
... response SΣ1..1BackboneElementIf this is a reply to prior message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier SΣ1..1idId of original message
.... code SΣ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ0..1Reference(MedComAcknowledgementOperationOutcome)Specific list of hints/warnings/errors

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingrequiredMedComMessagingMessageTypes
http://medcomfhir.dk/ig/terminology/ValueSet/medcom-messaging-messageTypes
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MedComMessagingMessageHeaderA 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
... Slices for event[x] Σ1..1CodingThe event element shall contain a value from MedComMessagingMessageTypes
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ1..1CodingCode for the event this message represents or link to event definition
Binding: MedComMessagingMessageTypes (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
..... 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"
...... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCoding 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/ig/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/ig/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
... 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 information about the sender of 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 SΣ1..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 SΣ1..1idId of original message
.... code SΣ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ0..1Reference(MedComAcknowledgementOperationOutcome)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]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingrequiredMedComMessagingMessageTypes
http://medcomfhir.dk/ig/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 MedComMessagingMessageHeader

Summary

Mandatory: 1 element
Must-Support: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron