DK MedCom Messaging
3.0.0 - release Denmark flag

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

Resource Profile: MedComMessagingMessageDefinitionFhir

Official URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-messagedefinition-fhir Version: 3.0.0
Active as of 2025-05-14 Computable Name: MedComMessagingMessageDefinitionFhir

An example profile of the MessageDefinition-fhir resource.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageDefinition C 0..* MedComMessagingMessageDefinition A resource that defines a type of message that can be exchanged between systems
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
msd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id SΣ 0..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 1..1 Identifier Primary key for the message definition on a given server
ele-1: All FHIR elements must have a @value or children
.... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type SΣ 1..1 CodeableConcept Description of identifier
Binding: MedComMessageDefinitionTypeValueset (required)
ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown (FHIR)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..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-message-definition-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: FHIR
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
..... coding Σ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system SΣ 0..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-message-definition-type
...... code SΣ 0..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
.... system SΣ 1..1 uri The namespace for the identifier value
Binding: MessageDefinitionIdentifierSystemValueset (required)
ele-1: All FHIR elements must have a @value or children
Fixed Value: urn:dk:healthcare:medcom:messaging:fhir
.... value SΣ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
ele-1: All FHIR elements must have a @value or children
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
ele-1: All FHIR elements must have a @value or children
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
ele-1: All FHIR elements must have a @value or children
... version SΣ 1..1 string Business version of the message definition
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Name for this message definition (human friendly)
ele-1: All FHIR elements must have a @value or children
... replaces Σ 0..* canonical(MessageDefinition) Takes the place of a MessageDefinition that is superseded by this MessageDefinition.
ele-1: All FHIR elements must have a @value or children
.... value S 0..1 string Primitive value for canonical
... status ?!SΣ 1..1 code Must always be defined in the individual MessageDefinition
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher SΣ 1..1 string Name of the publisher (organization or individual)
ele-1: All FHIR elements must have a @value or children
Required Pattern: MedCom, https://www.medcom.dk
... Slices for contact SΣ 0..* ContactDetail Contact details for the publisher
Slice: Unordered, Open by value:id
ele-1: All FHIR elements must have a @value or children
.... contact:InteroperabilityConsultant SΣ 0..1 ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
..... id S 1..1 string Unique id for inter-element referencing
Required Pattern: InteroperabilityConsultant
..... name SΣ 1..1 string Name of an individual to contact
ele-1: All FHIR elements must have a @value or children
Required Pattern: MedCom FHIR Team
..... telecom SΣ 0..* ContactPoint Contact details for individual or organization
ele-1: All FHIR elements must have a @value or children
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Fixed Value: email
...... value SΣ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
Required Pattern: fhir@medcom.dk
...... use ?!SΣ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Fixed Value: work
.... contact:SubjectMatterExpert SΣ 0..1 ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
..... id S 1..1 string Unique id for inter-element referencing
Required Pattern: SubjectMatterExpert
..... name SΣ 1..1 string Name of an individual to contact
ele-1: All FHIR elements must have a @value or children
..... telecom SΣ 0..* ContactPoint Contact details for individual or organization
ele-1: All FHIR elements must have a @value or children
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Fixed Value: email
...... value SΣ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
...... use ?!SΣ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Fixed Value: work
... description SΣ 0..1 markdown Natural language description of the message definition
ele-1: All FHIR elements must have a @value or children
... useContext SΣ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
.... code SΣ 1..1 Coding Type of context being specified
Binding: UseContextCodeSystemValueset (required)
ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown (Workflow Setting)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: workflow
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
..... system SΣ 0..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://terminology.hl7.org/CodeSystem/usage-context-type
..... code SΣ 0..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
.... Slices for value[x] SΣ 1..1 Value that defines the context
Slice: Unordered, Open by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
..... value[x]:valueCodeableConcept SΣ 0..1 CodeableConcept Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... jurisdiction SΣ 1..1 CodeableConcept Intended jurisdiction for message definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: DK
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... code SΣ 0..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
... purpose SΣ 0..1 markdown Why this message definition is defined
ele-1: All FHIR elements must have a @value or children
... event[x] SΣ 1..1 Event code or link to the EventDefinition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


ele-1: All FHIR elements must have a @value or children
.... eventCoding Coding
.... eventUri uri
... category SΣ 1..1 code consequence | currency | notification
Binding: MessageSignificanceCategory (required): The impact of the content of a message.


ele-1: All FHIR elements must have a @value or children
Fixed Value: notification
... responseRequired S 1..1 code always | on-error | never | on-success
Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.


ele-1: All FHIR elements must have a @value or children
Example General: always

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageDefinition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MessageDefinition.identifier.typerequiredFixed Value: FHIR
http://medcomfhir.dk/ig/terminology/ValueSet/medcom-message-definition-type-valueset
MessageDefinition.identifier.systemrequiredFixed Value: urn:dk:healthcare:medcom:messaging:fhir
http://medcomfhir.dk/ig/terminology/ValueSet/medcom-messagedefinition-identifer-system-valueset
MessageDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
MessageDefinition.contact:InteroperabilityConsultant.telecom.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
MessageDefinition.contact:InteroperabilityConsultant.telecom.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
MessageDefinition.contact:SubjectMatterExpert.telecom.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
MessageDefinition.contact:SubjectMatterExpert.telecom.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
MessageDefinition.useContext.coderequiredFixed Value: workflow
http://medcomfhir.dk/ig/terminology/ValueSet/medcom-messagedefinition-use-context-code-valueset
MessageDefinition.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
MessageDefinition.useContext.value[x]:valueCodeableConceptexampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
MessageDefinition.jurisdictionextensiblePattern: DK
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
MessageDefinition.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageDefinition.categoryrequiredFixed Value: notification
http://hl7.org/fhir/ValueSet/message-significance-category|4.0.1
from the FHIR Standard
MessageDefinition.responseRequiredrequiredmessageheader-response-request
http://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageDefinitionIf 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-4errorMessageDefinitionIf 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-5errorMessageDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageDefinitionA 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()
msd-0warningMessageDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

 

Other representations of profile: CSV, Excel, Schematron