DK MedCom acknowledgement
2.0.3 - Release Denmark flag

DK MedCom acknowledgement, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 2.0.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk-medcom-acknowledgement/ and changes regularly. See the Directory of published versions

Resource Profile: MedComAcknowledgementMessageHeader

Official URL: http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader Version: 2.0.3
Active as of 2024-09-25 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..* MedComMessagingMessageHeader A resource that describes a message that is exchanged between systems
... Slices for destination Content/Rules for all slices
.... destination:cc 0..0
... source 1..1 BackboneElement Contains information about the sender of the Acknowledgement message
... response S 1..1 BackboneElement If this is a reply to prior message
.... identifier S 1..1 id Id of original message
.... code S 1..1 code ok | transient-error | fatal-error
.... details S 0..1 Reference(MedComAcknowledgementOperationOutcome) Specific list of hints/warnings/errors

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MedComMessagingMessageHeader 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.
... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... endpoint Σ 1..1 url Actual destination address or id
.... destination:primary Σ 1..1 BackboneElement Message destination application(s)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... use S 1..1 (Complex) 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
... sender SΣ 1..1 Reference(MedComMessagingOrganization) {b} The actual sender of the message
... source SΣ 1..1 BackboneElement Contains information about the sender of 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
... response SΣ 1..1 BackboneElement If this is a reply to prior message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ 0..1 Reference(MedComAcknowledgementOperationOutcome) Specific list of hints/warnings/errors
... definition SΣ 1..1 canonical(MessageDefinition) Link to the definition for this message
Required Pattern: http://medcomfhir.dk/ig/acknowledgement/medcom-acknowledgement-message-definition|2.0.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]requiredMedComMessagingMessageTypes
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..* MedComMessagingMessageHeader 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
... 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
..... 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
..... 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 Σ 1..1 BackboneElement Message destination application(s)
..... 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 (Complex) 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
... 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 information about the sender of 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 SΣ 1..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 SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ 0..1 Reference(MedComAcknowledgementOperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* Reference(Resource) The actual content of the message
... definition SΣ 1..1 canonical(MessageDefinition) Link to the definition for this message
Required Pattern: http://medcomfhir.dk/ig/acknowledgement/medcom-acknowledgement-message-definition|2.0.0

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]requiredMedComMessagingMessageTypes
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: 2 elements
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..* MedComMessagingMessageHeader A resource that describes a message that is exchanged between systems
... Slices for destination Content/Rules for all slices
.... destination:cc 0..0
... source 1..1 BackboneElement Contains information about the sender of the Acknowledgement message
... response S 1..1 BackboneElement If this is a reply to prior message
.... identifier S 1..1 id Id of original message
.... code S 1..1 code ok | transient-error | fatal-error
.... details S 0..1 Reference(MedComAcknowledgementOperationOutcome) Specific list of hints/warnings/errors

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MedComMessagingMessageHeader 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.
... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... endpoint Σ 1..1 url Actual destination address or id
.... destination:primary Σ 1..1 BackboneElement Message destination application(s)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... use S 1..1 (Complex) 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
... sender SΣ 1..1 Reference(MedComMessagingOrganization) {b} The actual sender of the message
... source SΣ 1..1 BackboneElement Contains information about the sender of 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
... response SΣ 1..1 BackboneElement If this is a reply to prior message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ 0..1 Reference(MedComAcknowledgementOperationOutcome) Specific list of hints/warnings/errors
... definition SΣ 1..1 canonical(MessageDefinition) Link to the definition for this message
Required Pattern: http://medcomfhir.dk/ig/acknowledgement/medcom-acknowledgement-message-definition|2.0.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]requiredMedComMessagingMessageTypes
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..* MedComMessagingMessageHeader 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
... 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
..... 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
..... 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 Σ 1..1 BackboneElement Message destination application(s)
..... 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 (Complex) 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
... 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 information about the sender of 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 SΣ 1..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 SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details SΣ 0..1 Reference(MedComAcknowledgementOperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* Reference(Resource) The actual content of the message
... definition SΣ 1..1 canonical(MessageDefinition) Link to the definition for this message
Required Pattern: http://medcomfhir.dk/ig/acknowledgement/medcom-acknowledgement-message-definition|2.0.0

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]requiredMedComMessagingMessageTypes
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: 2 elements
Must-Support: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron