DK MedCom acknowledgement
2.0.1 - Release Denmark flag

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

Resource Profile: MedComAcknowledgementMessage

Official URL: http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgement Version: 2.0.1
Active as of 2023-03-10 Computable Name: MedComAcknowledgementMessage

Base resource for all MedCom Acknowledgement messages.

Scope and usage

This profile is the root profile of MedCom Acknowledgement message. Constraint and rules from MedComMessagingMessage are inherited to this profile. The only change is that the MessageHeader shall be a MedComAcknowledgementMessageHeader.

Note: Be aware that entries in a message in general are unordered. Recipients of a message can therefore not assume any particular sequences of elements.

Below can the structure of a MedCom Acknowledgement message be seen.

MedComAcknowledgementMessage is the root profile. From this is the MedComMessagingProvenance and MedComAcknowledgementMessageHeader referenced. 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 MedComAcknowledgementMessage.

Usage:

Formal Views of Profile Content

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

This structure is derived from MedComMessagingMessage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-messaging-3: The message header shall conform to medcom-messaging-acknowledgementHeader profile
medcom-messaging-4: The Acknowledgement entry shall contain at least one Provenance resource
medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
... entry 0..*BackboneElementMessage content (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - Open

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
medcom-acknowledgement-1errorBundleIf the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
: iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists())
medcom-messaging-3errorBundleThe message header shall conform to medcom-messaging-acknowledgementHeader profile
: entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader'))
medcom-messaging-4errorBundleThe Acknowledgement entry shall contain at least one Provenance resource
: entry.resource.ofType(Provenance).count() >0
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-messaging-4: The Acknowledgement entry shall contain at least one Provenance resource
medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
... id SΣ1..1idLogical id of this artifact
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... type SΣ1..1codeAlways message
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... entry SΣC0..*BackboneElementMessage content (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - Open
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... resource SΣ0..1ResourceEach MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredPattern: message

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
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()
medcom-acknowledgement-1errorBundleIf the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
: iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists())
medcom-messaging-1errorBundleThe MessageHeader resource shall conform to medcom-messaging-messageHeader profile
: entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/messaging/StructureDefinition/medcom-messaging-messageHeader'))
medcom-messaging-2errorBundleThere shall be at least one Provenance resource in a MedCom message
: entry.resource.ofType(Provenance).exists()
medcom-messaging-3errorBundleAll Provenance resources shall conform to medcom-core-provenance profile
: entry.ofType(Provenance).all(resource.conformsTo('http://medcomfhir.dk/fhir/messaging/StructureDefinition/medcom-messaging-provenance'))
medcom-messaging-4errorBundleThe Acknowledgement entry shall contain at least one Provenance resource
: entry.resource.ofType(Provenance).count() >0
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-messaging-4: The Acknowledgement entry shall contain at least one Provenance resource
medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codeAlways message
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp SΣ1..1instantWhen the bundle was assembled
... total ΣC0..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... 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
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry SΣC0..*BackboneElementMessage content (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - Open
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... 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
.... link Σ0..*See link (Bundle)Links related to this entry
.... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SΣ0..1ResourceEach MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3.
.... search ΣC0..1BackboneElementSearch related information
..... 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
..... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
..... 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
..... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing cache currency
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
..... 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
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location (if the operation returns a location)
..... etag Σ0..1stringThe Etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣTU0..1SignatureDigital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredPattern: message
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb

Constraints

IdGradePath(s)DetailsRequirements
bdl-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
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 MedComMessagingMessage

Summary

Differential View

This structure is derived from MedComMessagingMessage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-messaging-3: The message header shall conform to medcom-messaging-acknowledgementHeader profile
medcom-messaging-4: The Acknowledgement entry shall contain at least one Provenance resource
medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
... entry 0..*BackboneElementMessage content (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - Open

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
medcom-acknowledgement-1errorBundleIf the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
: iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists())
medcom-messaging-3errorBundleThe message header shall conform to medcom-messaging-acknowledgementHeader profile
: entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader'))
medcom-messaging-4errorBundleThe Acknowledgement entry shall contain at least one Provenance resource
: entry.resource.ofType(Provenance).count() >0

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-messaging-4: The Acknowledgement entry shall contain at least one Provenance resource
medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
... id SΣ1..1idLogical id of this artifact
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... type SΣ1..1codeAlways message
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... entry SΣC0..*BackboneElementMessage content (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - Open
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... resource SΣ0..1ResourceEach MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredPattern: message

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
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()
medcom-acknowledgement-1errorBundleIf the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
: iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists())
medcom-messaging-1errorBundleThe MessageHeader resource shall conform to medcom-messaging-messageHeader profile
: entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/messaging/StructureDefinition/medcom-messaging-messageHeader'))
medcom-messaging-2errorBundleThere shall be at least one Provenance resource in a MedCom message
: entry.resource.ofType(Provenance).exists()
medcom-messaging-3errorBundleAll Provenance resources shall conform to medcom-core-provenance profile
: entry.ofType(Provenance).all(resource.conformsTo('http://medcomfhir.dk/fhir/messaging/StructureDefinition/medcom-messaging-provenance'))
medcom-messaging-4errorBundleThe Acknowledgement entry shall contain at least one Provenance resource
: entry.resource.ofType(Provenance).count() >0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-messaging-4: The Acknowledgement entry shall contain at least one Provenance resource
medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included.
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codeAlways message
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp SΣ1..1instantWhen the bundle was assembled
... total ΣC0..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... 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
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry SΣC0..*BackboneElementMessage content (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - Open
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... 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
.... link Σ0..*See link (Bundle)Links related to this entry
.... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SΣ0..1ResourceEach MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3.
.... search ΣC0..1BackboneElementSearch related information
..... 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
..... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
..... 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
..... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing cache currency
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
..... 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
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location (if the operation returns a location)
..... etag Σ0..1stringThe Etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣTU0..1SignatureDigital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredPattern: message
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb

Constraints

IdGradePath(s)DetailsRequirements
bdl-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
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 MedComMessagingMessage

Summary

 

Other representations of profile: CSV, Excel, Schematron