eHealth Infrastructure
​11.0.1 - Denmark flag

This page is part of the FUT Infrastructure (v11.0.1: 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: ehealth-message

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message Version: 11.0.1
Active as of 2026-10-23 Computable Name: ehealth-message

Introduction

An ehealth-message defines written communication and comes in four flavours depending on the "category" of the message:

  • Message: For sending user-generated messages from Patients and CareTeams (Practitioners) to Patients or CareTeams. Messages may not be sent between Patients or between Practitioners. When sending a message to a CareTeam, it is possible to narrow the recipient to be of a certain role. This is done by setting the "restriction-category" extension to a specific role value.
  • Notification: Must regard an incident or event that has already occurred, where the sender must be of type Device, and the recipient must be a Patient or CareTeam. These are usually text-based, and may have a temporal validity attached (see "period" extension) to indicate at which point a notification is no longer valid. When sent, a notification may no longer be updated by the sender.
  • Advise: Advise is much like notifications. They may also have a validity period, but they may only concern a future planned event, eg. a measurement or online meeting which is to take place. The sender must be of type Device, and the recipient must be a Patient or CareTeam
  • Note: For personal notes (written by a Patient or Practitioner), which may be shared with a CareTeam. A personal note must be created with sender=recipient. In case a personal note wants to be shared with a CareTeam, the CareTeam must be referred by the recipientCareTeam extension, and the receiver deleted (both can take place in the same PATCH operation). A personal note may be updated by the sender, but not by the recipient.

An ehealth-message may refer related resources (eg. Device, CarePlan, Appointment etc) using the "about" field, no matter which category it is. Different instances of ehealth-message may be logically organized into "threads" by assigning the same thread-id in the provided extension. Similarly, they may be organized in a group (eg. group messages) by assigning the same group-id in that extension. The message subject may be provided in the title extension, and an optional priority may be provided in the ehealth-priority extension.

Remarks about status and administrative-status

The ehealth-message profile contains two status fields:

  • status:
    • For notes (category='note') the status field has no restrictions or implications
    • For messages (category='message') the following status transitions rules are in effect:
      • A message is considered "not yet sent" when it has one of the following status and can freely transition from one to another: 'preparation', 'on-hold', 'not-done', 'entered-in-error'
      • A message is considered "being sent" when created or patched into status 'in-progress' and cannot be patched further or deleted by the sender
        • The server will automatically transition a message from 'in-progress' to 'completed' when it has been sent successfully (happens immediately for non-NemSMS mediums and is reflected in the returned resource)
        • The server will automatically transition a message from 'in-progress' to 'stopped' if it could not be sent (currently only happens if a NemSMS could not be sent)
      • The client can never create or patch a message into status 'completed' or 'stopped'
      • The sender cannot patch, only delete messages with status 'stopped'
      • The sender cannot patch or delete messages with status 'completed'
      • The recipient can patch /received and administrative-status on messages with status 'completed'
  • administrative-status (extension): Makes it possible for the message recipient to indicate the state of a message. A message may hold an administrative status that defines the last action the recipient took on the message in question. At first, the message has administrative-status "activate". The recipient may mark the message as read by setting administrative-status "read". If the recipient considers the message a sort of "task", the message may also be updated with administrative-status "complete" when the task is done, or "reactivate" if the task was not complete anyway.

Fields with auto-assigned values

Some fields are filled in automatically on message creation, eg. if a sound default value makes sense. These fields are:

  • Field "sent": If message state is set to "in-progress" on creation, then the "sent" field will be assigned current date/time.
  • Extension "restriction-category": If not set by the caller, it will be set to value "None"
  • Extension "thread-id": In case a thread-id is not set by the client, it will be generated server-side (random UUID) at message creation.

Search parameters

The following custom search parameters may be used when searching for ehealth-message instances:

  • administrativeStatus: Specify the desired administrative status using system and code (eg. "http://ehealth.sundhed.dk/cs/administrative-status" and "read")
  • careTeamRecipient: Specify an absolute reference to the CareTeam which must be message recipient
  • careTeamSender: Specify an absolute reference to the CareTeam which must be message sender
  • communicationCategory: Specify the desired category using system and code (eg. "http://ehealth.sundhed.dk/message-category/" and "message")
  • period: Use a date-type search to filter messages that must conform to temporal constraints (eg. notifications that are only valid until a specific point in time)
  • threadId: Specify the logical "thread id" used to correlate messages
  • topic: Specify the desired topic using system and code (eg. "http://terminology.hl7.org/CodeSystem/definition-topic" and "Treatment")
  • restrictionCategory: Specify the desired restriction category using system and code (eg. "http://ehealth.sundhed.dk/cs/restriction-category" and "measurement-monitoring")
  • episodeOfCare: Specify the desired episodeOfCare reference (provided in extension http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare)

Scope and Usage

In the eHealth Infrastructure the ehealth-message resource is used in conjunction with the following resources:

  • Patient
    • As sender or recipient of a message
  • Practitioner
    • As sender/recipient of a message (only when category is "note")
  • Device
    • As sender of an ehealth-message (eg. as a result of automatic processing/triage)
  • CareTeam
    • As sender or recipient using the extensions senderCareTeam/recipientCareTeam, respectively

General rules

The following rules apply for the ehealth-message profile:

  • If medium.code is eboks or nemsms, the recipient must be of type Patient
  • Only one of sender or extension senderCareTeam may be filled in
  • Only one of recipient or extension recipientCareTeam may be filled in
  • Medium 'nemsms' may only be used if the Patient allows reception of NemSMS (has telecom with value 'NemSMS'). In that case, a NemSMS message will be sent to the Patient.

NemSMS Notifications

The Patient service will forward ehealth-messages to the public Danish NemSMS service given the following conditions:

  • message.medium.code is 'nemsms' (defined in http://ehealth.sundhed.dk/cs/message-medium)
  • message.status is 'in-progress'

The message is forwarded asynchronously. To track the progress of the NemSMS, the status and statusReason code is used:

  • Initially, a NemSMS is sent like any other message by setting the status to 'in-progress'. The status will remain 'in-progress' while the NemSMS is being dispatched.
  • If the NemSMS dispatch is successful, status is updated to 'completed' by the server.
  • If the NemSMS dispatch fails, status is updated to 'stopped' by the server and statusReason is set to either 'system-error' or 'recipient-unavailable' (defined in http://hl7.org/fhir/R4/valueset-communication-not-done-reason.html)
    • A message.note.text may be added to the message which can contain further information about the reason for dispatch failure in case of 'system-error'

Automatic NemSMS Notifications

Automatic NemSMS notifications is a toggleable feature at the service level. If enabled, the Patient service will generate NemSMS ehealth-messages, notifying the recipient that they have received a message, given the following conditions:

  • message.medium.code is not 'nemsms'
  • message.status is 'completed'
  • message.category is 'message' (defined in http://ehealth.sundhed.dk/cs/message-category)
  • message.recipient is a Patient reference
  • patient.telecom contains ContactPoint 'NemSMS'

The Patient service will generate NemSMS ehealth-messages, notifying patients that they have an appointment or video appointment scheduled for de following day, given the following conditions:

  • appointment.start is current day + 1 day
  • appointment.participant contains one Patient reference
  • patient.telecom contains ContactPoint 'NemSMS'

Update rules

An ehealth-message may not have its category changed, eg. from 'note' to 'message'.
An ehealth-message may be PATCH updated on paths complying with the regular expressions below (provided that security and status transition rules are obeyed)

  • /implicitRules.*
  • /contained.*
  • /recipient.*
  • /definition.*
  • /basedOn.*
  • /partOf.*
  • /topic.*
  • /about.*
  • /context.*
  • /received.*
  • /reasonCode.*
  • /reasonReference.*
  • /payload.*
  • /note.*
  • /status.*
  • /extension.*

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: nemsms-invariant, note-invariant, notification-invariant, message-invariant, advice-invariant
Communication.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Communication.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for extension.extension:episodeOfCare 0..1 (Complex) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
Communication.Slices for extension.extension:episodeOfCare.extension 0..0 Extension
Slice: Unordered, Open by value:url
Communication.Slices for extension.extension:episodeOfCare.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare"
Communication.Slices for extension.extension:episodeOfCare.value[x] 1..1 Reference(EpisodeOfCare) {r} Value of extension
Communication.Slices for extension.extension:recipientCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
Communication.Slices for extension.extension:senderCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
Communication.Slices for extension.extension:restrictionCategory 0..* CodeableConcept Restriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
Communication.Slices for extension.extension:threadId 0..1 string Thread id
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
Communication.Slices for extension.extension:period 0..* Period Specifies the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
Communication.Slices for extension.extension:administrativeStatus 1..1 Coding The administrative status of how a message recipient has handled a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
Binding: Administrative Status (required)
Communication.Slices for extension.extension:title 0..1 string Message title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
Communication.Slices for extension.extension:priority 0..1 code The priority of a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
Binding: Priority (required)
Communication.Slices for extension.extension:groupId 0..1 string Logical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
Communication.Slices for extension.extension:onBehalfOf This element must be supported. 0..1 Reference(ehealth-careteam | ehealth-patient) {r} On behalf of
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of
Communication.Slices for extension.extension:author 0..1 Reference(RelatedPerson) {r} Attorney who authored the message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message-author
Communication.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Communication.partOf This element is included in summaries. 0..* Reference(CarePlan) {r} Part of this action
Communication.status This element is a modifier element. This element is included in summaries. 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
Communication.Slices for category 1..* CodeableConcept Message category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for category.category:DkTmCategory 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
Communication.Slices for medium 0..* CodeableConcept A channel of communication
Slice: Unordered, Open by value:coding.system
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for medium.medium:DkTmMedium 0..1 CodeableConcept A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
Communication.recipient 0..1 Reference(Patient | Practitioner | ehealth-relatedperson) {r} Message recipient
Communication.sender 0..1 Reference(Device | Patient | Practitioner | RelatedPerson) {r, c} Message sender
Communication.reasonCode This element is included in summaries. 0..* CodeableConcept Indication for message
Binding: eHealth Message Reason Code (required)
Communication.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation) {r} Why was communication done?
Communication.payload 0..1 BackboneElement Message payload
Communication.payload.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Communication.payload.Slices for content[x] 1..1 string Message part content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.payload.Slices for content[x].content[x]:contentString 1..1 string Message part content

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍4.0.1 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.category:DkTmCategory Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.medium Base example ParticipationMode 📦3.0.0 THO v7.4
Communication.medium:DkTmMedium Base example ParticipationMode 📦3.0.0 THO v7.4
Communication.reasonCode Base required eHealth Message Reason Code 📦11.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
advice-invariant error Communication Category advice invariant category.coding.code contains 'advice' implies (recipient.reference.contains('Patient/') or recipient.reference.contains('RelatedPerson/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())
message-invariant error Communication Category message invariant category.coding.code contains 'message' implies (recipient.reference.contains('Patient/') and ( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and (sender.reference.contains('Patient/')) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists() )) or (sender.reference.contains('RelatedPerson/') and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of').value.as(Reference).reference.contains('Patient/'))
nemsms-invariant error Communication If communication resource is a NemSMS payload cannot exceed 160 medium.coding.where(code = 'nemsms').exists() implies payload.content.ofType(string).length() <= 160
note-invariant error Communication Category note invariant category.coding.code contains 'note' implies (recipient.reference contains sender.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists())
notification-invariant error Communication Category notification invariant category.coding.code contains 'notification' implies (recipient.reference.contains('Patient/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: nemsms-invariant, note-invariant, notification-invariant, message-invariant, advice-invariant
Communication.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for extension.extension:episodeOfCare 0..1 (Complex) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
Communication.Slices for extension.extension:episodeOfCare.value[x] 1..1 Reference(EpisodeOfCare) {r} Value of extension
Communication.Slices for extension.extension:recipientCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
Communication.Slices for extension.extension:senderCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
Communication.Slices for extension.extension:restrictionCategory 0..* CodeableConcept Restriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
Communication.Slices for extension.extension:threadId 0..1 string Thread id
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
Communication.Slices for extension.extension:period 0..* Period Specifies the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
Communication.Slices for extension.extension:administrativeStatus 1..1 Coding The administrative status of how a message recipient has handled a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
Binding: Administrative Status (required)
Communication.Slices for extension.extension:title 0..1 string Message title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
Communication.Slices for extension.extension:priority 0..1 code The priority of a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
Binding: Priority (required)
Communication.Slices for extension.extension:groupId 0..1 string Logical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
Communication.Slices for extension.extension:onBehalfOf This element must be supported. 0..1 Reference(ehealth-careteam | ehealth-patient) {r} On behalf of
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of
Communication.Slices for extension.extension:author 0..1 Reference(RelatedPerson) {r} Attorney who authored the message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message-author
Communication.partOf 0..* Reference(CarePlan) {r} Part of this action
Communication.Slices for category 1..* CodeableConcept Message category
Slice: Unordered, Open by value:coding.system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for category.category:DkTmCategory 1..1 CodeableConcept Message category
Communication.Slices for category.category:DkTmCategory.coding
Communication.Slices for category.category:DkTmCategory.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://ehealth.sundhed.dk/cs/message-category (extensions allowed)
Communication.Slices for category.category:DkTmCategory.coding.code 0..1 code Symbol in syntax defined by the system
Binding: MessageCategory (required)
Communication.Slices for medium.medium:DkTmMedium 0..1 CodeableConcept A channel of communication
Communication.Slices for medium.medium:DkTmMedium.coding
Communication.Slices for medium.medium:DkTmMedium.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://ehealth.sundhed.dk/cs/message-medium (extensions allowed)
Communication.Slices for medium.medium:DkTmMedium.coding.code 0..1 code Symbol in syntax defined by the system
Binding: MessageMedium (required)
Communication.recipient 0..1 Reference(Patient | Practitioner | ehealth-relatedperson) {r} Message recipient
Communication.sender 0..1 Reference(Device | Patient | Practitioner | RelatedPerson) {r, c} Message sender
Communication.reasonCode 0..* CodeableConcept Indication for message
Binding: eHealth Message Reason Code (required)
Communication.reasonReference 0..* Reference(Condition | Observation) {r} Why was communication done?
Communication.payload 0..1 BackboneElement Message payload
Communication.payload.Slices for content[x] 1..1 string Message part content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.payload.Slices for content[x].content[x]:contentString 1..1 string Message part content
Communication.note
Communication.note.Slices for author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.note.Slices for author[x].author[x]:authorReference 0..1 Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) Individual responsible for the annotation
Communication.note.Slices for author[x].author[x]:authorString 0..1 string Individual responsible for the annotation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Communication.category:DkTmCategory.​coding.code Base required MessageCategory 📦11.0.1 This IG
Communication.medium:DkTmMedium.​coding.code Base required MessageMedium 📦11.0.1 This IG
Communication.reasonCode Base required eHealth Message Reason Code 📦11.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
advice-invariant error Communication Category advice invariant category.coding.code contains 'advice' implies (recipient.reference.contains('Patient/') or recipient.reference.contains('RelatedPerson/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())
message-invariant error Communication Category message invariant category.coding.code contains 'message' implies (recipient.reference.contains('Patient/') and ( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and (sender.reference.contains('Patient/')) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists() )) or (sender.reference.contains('RelatedPerson/') and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of').value.as(Reference).reference.contains('Patient/'))
nemsms-invariant error Communication If communication resource is a NemSMS payload cannot exceed 160 medium.coding.where(code = 'nemsms').exists() implies payload.content.ofType(string).length() <= 160
note-invariant error Communication Category note invariant category.coding.code contains 'note' implies (recipient.reference contains sender.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists())
notification-invariant error Communication Category notification invariant category.coding.code contains 'notification' implies (recipient.reference.contains('Patient/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: nemsms-invariant, note-invariant, notification-invariant, message-invariant, advice-invariant
Communication.id This element is included in summaries. 0..1 id Logical id of this artifact
Communication.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Communication.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Communication.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Communication.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Communication.contained 0..* Resource Contained, inline Resources
Communication.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for extension.extension:episodeOfCare 0..1 (Complex) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
Communication.Slices for extension.extension:episodeOfCare.id 0..1 string Unique id for inter-element referencing
Communication.Slices for extension.extension:episodeOfCare.extension 0..0 Extension
Slice: Unordered, Open by value:url
Communication.Slices for extension.extension:episodeOfCare.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare"
Communication.Slices for extension.extension:episodeOfCare.value[x] 1..1 Reference(EpisodeOfCare) {r} Value of extension
Communication.Slices for extension.extension:recipientCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
Communication.Slices for extension.extension:senderCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
Communication.Slices for extension.extension:restrictionCategory 0..* CodeableConcept Restriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
Communication.Slices for extension.extension:threadId 0..1 string Thread id
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
Communication.Slices for extension.extension:period 0..* Period Specifies the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
Communication.Slices for extension.extension:administrativeStatus 1..1 Coding The administrative status of how a message recipient has handled a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
Binding: Administrative Status (required)
Communication.Slices for extension.extension:title 0..1 string Message title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
Communication.Slices for extension.extension:priority 0..1 code The priority of a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
Binding: Priority (required)
Communication.Slices for extension.extension:groupId 0..1 string Logical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
Communication.Slices for extension.extension:onBehalfOf This element must be supported. 0..1 Reference(ehealth-careteam | ehealth-patient) {r} On behalf of
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of
Communication.Slices for extension.extension:author 0..1 Reference(RelatedPerson) {r} Attorney who authored the message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message-author
Communication.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Communication.identifier This element is included in summaries. 0..* Identifier Unique identifier
Communication.instantiatesCanonical This element is included in summaries. 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
Communication.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
Communication.basedOn This element is included in summaries. 0..* Reference(Resource) Request fulfilled by this communication
Communication.partOf This element is included in summaries. 0..* Reference(CarePlan) {r} Part of this action
Communication.inResponseTo 0..* Reference(Communication) Reply to
Communication.status This element is a modifier element. This element is included in summaries. 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
Communication.statusReason This element is included in summaries. 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
Communication.Slices for category 1..* CodeableConcept Message category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for category.category:DkTmCategory 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
Communication.Slices for category.category:DkTmCategory.id 0..1 string Unique id for inter-element referencing
Communication.Slices for category.category:DkTmCategory.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.Slices for category.category:DkTmCategory.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Communication.Slices for category.category:DkTmCategory.coding.id 0..1 string Unique id for inter-element referencing
Communication.Slices for category.category:DkTmCategory.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.Slices for category.category:DkTmCategory.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://ehealth.sundhed.dk/cs/message-category (extensions allowed)
Communication.Slices for category.category:DkTmCategory.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Communication.Slices for category.category:DkTmCategory.coding.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Binding: MessageCategory (required)
Communication.Slices for category.category:DkTmCategory.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Communication.Slices for category.category:DkTmCategory.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Communication.Slices for category.category:DkTmCategory.text This element is included in summaries. 0..1 string Plain text representation of the concept
Communication.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
Communication.Slices for medium 0..* CodeableConcept A channel of communication
Slice: Unordered, Open by value:coding.system
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for medium.medium:DkTmMedium 0..1 CodeableConcept A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
Communication.Slices for medium.medium:DkTmMedium.id 0..1 string Unique id for inter-element referencing
Communication.Slices for medium.medium:DkTmMedium.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.Slices for medium.medium:DkTmMedium.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Communication.Slices for medium.medium:DkTmMedium.coding.id 0..1 string Unique id for inter-element referencing
Communication.Slices for medium.medium:DkTmMedium.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.Slices for medium.medium:DkTmMedium.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://ehealth.sundhed.dk/cs/message-medium (extensions allowed)
Communication.Slices for medium.medium:DkTmMedium.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Communication.Slices for medium.medium:DkTmMedium.coding.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Binding: MessageMedium (required)
Communication.Slices for medium.medium:DkTmMedium.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Communication.Slices for medium.medium:DkTmMedium.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Communication.Slices for medium.medium:DkTmMedium.text This element is included in summaries. 0..1 string Plain text representation of the concept
Communication.subject This element is included in summaries. 0..1 Reference(Patient | Group) Focus of message
Communication.topic 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
Communication.about 0..* Reference(Resource) Resources that pertain to this communication
Communication.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
Communication.sent 0..1 dateTime When sent
Communication.received 0..1 dateTime When received
Communication.recipient 0..1 Reference(Patient | Practitioner | ehealth-relatedperson) {r} Message recipient
Communication.sender 0..1 Reference(Device | Patient | Practitioner | RelatedPerson) {r, c} Message sender
Communication.reasonCode This element is included in summaries. 0..* CodeableConcept Indication for message
Binding: eHealth Message Reason Code (required)
Communication.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation) {r} Why was communication done?
Communication.payload 0..1 BackboneElement Message payload
Communication.payload.id 0..1 string Unique id for inter-element referencing
Communication.payload.extension 0..* Extension Additional content defined by implementations
Communication.payload.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Communication.payload.Slices for content[x] 1..1 string Message part content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.payload.Slices for content[x].content[x]:contentString 1..1 string Message part content
Communication.note 0..* Annotation Comments made about the communication
Communication.note.id 0..1 string Unique id for inter-element referencing
Communication.note.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.note.Slices for author[x] This element is included in summaries. 0..1 Individual responsible for the annotation
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.note.Slices for author[x].authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
Communication.note.Slices for author[x].authorString string
Communication.note.Slices for author[x].author[x]:authorReference This element is included in summaries. 0..1 Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) Individual responsible for the annotation
Communication.note.Slices for author[x].author[x]:authorString This element is included in summaries. 0..1 string Individual responsible for the annotation
Communication.note.time This element is included in summaries. 0..1 dateTime When the annotation was made
Communication.note.text This element is included in summaries. 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Communication.status Base required EventStatus 📍4.0.1 FHIR Std.
Communication.statusReason Base example CommunicationNotDoneReason 📍4.0.1 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.category:DkTmCategory Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.category:DkTmCategory.​coding.code Base required MessageCategory 📦11.0.1 This IG
Communication.priority Base required Request priority 📍4.0.1 FHIR Std.
Communication.medium Base example ParticipationMode 📦3.0.0 THO v7.4
Communication.medium:DkTmMedium Base example ParticipationMode 📦3.0.0 THO v7.4
Communication.medium:DkTmMedium.​coding.code Base required MessageMedium 📦11.0.1 This IG
Communication.topic Base example CommunicationTopic 📍4.0.1 FHIR Std.
Communication.reasonCode Base required eHealth Message Reason Code 📦11.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
advice-invariant error Communication Category advice invariant category.coding.code contains 'advice' implies (recipient.reference.contains('Patient/') or recipient.reference.contains('RelatedPerson/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())
message-invariant error Communication Category message invariant category.coding.code contains 'message' implies (recipient.reference.contains('Patient/') and ( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and (sender.reference.contains('Patient/')) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists() )) or (sender.reference.contains('RelatedPerson/') and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of').value.as(Reference).reference.contains('Patient/'))
nemsms-invariant error Communication If communication resource is a NemSMS payload cannot exceed 160 medium.coding.where(code = 'nemsms').exists() implies payload.content.ofType(string).length() <= 160
note-invariant error Communication Category note invariant category.coding.code contains 'note' implies (recipient.reference contains sender.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists())
notification-invariant error Communication Category notification invariant category.coding.code contains 'notification' implies (recipient.reference.contains('Patient/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())

Summary

Mandatory: 4 elements(3 nested mandatory elements)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Communication.category
  • The element 1 is sliced based on the value of Communication.medium
  • The element 1 is sliced based on the value of Communication.payload.content[x] (Closed)
  • The element 1 is sliced based on the value of Communication.note.author[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: nemsms-invariant, note-invariant, notification-invariant, message-invariant, advice-invariant
Communication.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Communication.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for extension.extension:episodeOfCare 0..1 (Complex) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
Communication.Slices for extension.extension:episodeOfCare.extension 0..0 Extension
Slice: Unordered, Open by value:url
Communication.Slices for extension.extension:episodeOfCare.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare"
Communication.Slices for extension.extension:episodeOfCare.value[x] 1..1 Reference(EpisodeOfCare) {r} Value of extension
Communication.Slices for extension.extension:recipientCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
Communication.Slices for extension.extension:senderCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
Communication.Slices for extension.extension:restrictionCategory 0..* CodeableConcept Restriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
Communication.Slices for extension.extension:threadId 0..1 string Thread id
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
Communication.Slices for extension.extension:period 0..* Period Specifies the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
Communication.Slices for extension.extension:administrativeStatus 1..1 Coding The administrative status of how a message recipient has handled a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
Binding: Administrative Status (required)
Communication.Slices for extension.extension:title 0..1 string Message title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
Communication.Slices for extension.extension:priority 0..1 code The priority of a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
Binding: Priority (required)
Communication.Slices for extension.extension:groupId 0..1 string Logical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
Communication.Slices for extension.extension:onBehalfOf This element must be supported. 0..1 Reference(ehealth-careteam | ehealth-patient) {r} On behalf of
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of
Communication.Slices for extension.extension:author 0..1 Reference(RelatedPerson) {r} Attorney who authored the message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message-author
Communication.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Communication.partOf This element is included in summaries. 0..* Reference(CarePlan) {r} Part of this action
Communication.status This element is a modifier element. This element is included in summaries. 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
Communication.Slices for category 1..* CodeableConcept Message category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for category.category:DkTmCategory 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
Communication.Slices for medium 0..* CodeableConcept A channel of communication
Slice: Unordered, Open by value:coding.system
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for medium.medium:DkTmMedium 0..1 CodeableConcept A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
Communication.recipient 0..1 Reference(Patient | Practitioner | ehealth-relatedperson) {r} Message recipient
Communication.sender 0..1 Reference(Device | Patient | Practitioner | RelatedPerson) {r, c} Message sender
Communication.reasonCode This element is included in summaries. 0..* CodeableConcept Indication for message
Binding: eHealth Message Reason Code (required)
Communication.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation) {r} Why was communication done?
Communication.payload 0..1 BackboneElement Message payload
Communication.payload.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Communication.payload.Slices for content[x] 1..1 string Message part content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.payload.Slices for content[x].content[x]:contentString 1..1 string Message part content

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍4.0.1 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.category:DkTmCategory Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.medium Base example ParticipationMode 📦3.0.0 THO v7.4
Communication.medium:DkTmMedium Base example ParticipationMode 📦3.0.0 THO v7.4
Communication.reasonCode Base required eHealth Message Reason Code 📦11.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
advice-invariant error Communication Category advice invariant category.coding.code contains 'advice' implies (recipient.reference.contains('Patient/') or recipient.reference.contains('RelatedPerson/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())
message-invariant error Communication Category message invariant category.coding.code contains 'message' implies (recipient.reference.contains('Patient/') and ( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and (sender.reference.contains('Patient/')) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists() )) or (sender.reference.contains('RelatedPerson/') and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of').value.as(Reference).reference.contains('Patient/'))
nemsms-invariant error Communication If communication resource is a NemSMS payload cannot exceed 160 medium.coding.where(code = 'nemsms').exists() implies payload.content.ofType(string).length() <= 160
note-invariant error Communication Category note invariant category.coding.code contains 'note' implies (recipient.reference contains sender.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists())
notification-invariant error Communication Category notification invariant category.coding.code contains 'notification' implies (recipient.reference.contains('Patient/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: nemsms-invariant, note-invariant, notification-invariant, message-invariant, advice-invariant
Communication.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for extension.extension:episodeOfCare 0..1 (Complex) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
Communication.Slices for extension.extension:episodeOfCare.value[x] 1..1 Reference(EpisodeOfCare) {r} Value of extension
Communication.Slices for extension.extension:recipientCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
Communication.Slices for extension.extension:senderCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
Communication.Slices for extension.extension:restrictionCategory 0..* CodeableConcept Restriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
Communication.Slices for extension.extension:threadId 0..1 string Thread id
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
Communication.Slices for extension.extension:period 0..* Period Specifies the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
Communication.Slices for extension.extension:administrativeStatus 1..1 Coding The administrative status of how a message recipient has handled a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
Binding: Administrative Status (required)
Communication.Slices for extension.extension:title 0..1 string Message title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
Communication.Slices for extension.extension:priority 0..1 code The priority of a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
Binding: Priority (required)
Communication.Slices for extension.extension:groupId 0..1 string Logical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
Communication.Slices for extension.extension:onBehalfOf This element must be supported. 0..1 Reference(ehealth-careteam | ehealth-patient) {r} On behalf of
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of
Communication.Slices for extension.extension:author 0..1 Reference(RelatedPerson) {r} Attorney who authored the message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message-author
Communication.partOf 0..* Reference(CarePlan) {r} Part of this action
Communication.Slices for category 1..* CodeableConcept Message category
Slice: Unordered, Open by value:coding.system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for category.category:DkTmCategory 1..1 CodeableConcept Message category
Communication.Slices for category.category:DkTmCategory.coding
Communication.Slices for category.category:DkTmCategory.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://ehealth.sundhed.dk/cs/message-category (extensions allowed)
Communication.Slices for category.category:DkTmCategory.coding.code 0..1 code Symbol in syntax defined by the system
Binding: MessageCategory (required)
Communication.Slices for medium 0..* CodeableConcept A channel of communication
Slice: Unordered, Open by value:coding.system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for medium.medium:DkTmMedium 0..1 CodeableConcept A channel of communication
Communication.Slices for medium.medium:DkTmMedium.coding
Communication.Slices for medium.medium:DkTmMedium.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://ehealth.sundhed.dk/cs/message-medium (extensions allowed)
Communication.Slices for medium.medium:DkTmMedium.coding.code 0..1 code Symbol in syntax defined by the system
Binding: MessageMedium (required)
Communication.recipient 0..1 Reference(Patient | Practitioner | ehealth-relatedperson) {r} Message recipient
Communication.sender 0..1 Reference(Device | Patient | Practitioner | RelatedPerson) {r, c} Message sender
Communication.reasonCode 0..* CodeableConcept Indication for message
Binding: eHealth Message Reason Code (required)
Communication.reasonReference 0..* Reference(Condition | Observation) {r} Why was communication done?
Communication.payload 0..1 BackboneElement Message payload
Communication.payload.Slices for content[x] 1..1 string Message part content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.payload.Slices for content[x].content[x]:contentString 1..1 string Message part content
Communication.note
Communication.note.Slices for author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.note.Slices for author[x].author[x]:authorReference 0..1 Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) Individual responsible for the annotation
Communication.note.Slices for author[x].author[x]:authorString 0..1 string Individual responsible for the annotation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Communication.category:DkTmCategory.​coding.code Base required MessageCategory 📦11.0.1 This IG
Communication.medium:DkTmMedium.​coding.code Base required MessageMedium 📦11.0.1 This IG
Communication.reasonCode Base required eHealth Message Reason Code 📦11.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
advice-invariant error Communication Category advice invariant category.coding.code contains 'advice' implies (recipient.reference.contains('Patient/') or recipient.reference.contains('RelatedPerson/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())
message-invariant error Communication Category message invariant category.coding.code contains 'message' implies (recipient.reference.contains('Patient/') and ( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and (sender.reference.contains('Patient/')) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists() )) or (sender.reference.contains('RelatedPerson/') and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of').value.as(Reference).reference.contains('Patient/'))
nemsms-invariant error Communication If communication resource is a NemSMS payload cannot exceed 160 medium.coding.where(code = 'nemsms').exists() implies payload.content.ofType(string).length() <= 160
note-invariant error Communication Category note invariant category.coding.code contains 'note' implies (recipient.reference contains sender.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists())
notification-invariant error Communication Category notification invariant category.coding.code contains 'notification' implies (recipient.reference.contains('Patient/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Communication C 0..* Communication A record of information transmitted from a sender to a receiver
Constraints: nemsms-invariant, note-invariant, notification-invariant, message-invariant, advice-invariant
Communication.id This element is included in summaries. 0..1 id Logical id of this artifact
Communication.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Communication.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Communication.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Communication.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Communication.contained 0..* Resource Contained, inline Resources
Communication.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for extension.extension:episodeOfCare 0..1 (Complex) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
Communication.Slices for extension.extension:episodeOfCare.id 0..1 string Unique id for inter-element referencing
Communication.Slices for extension.extension:episodeOfCare.extension 0..0 Extension
Slice: Unordered, Open by value:url
Communication.Slices for extension.extension:episodeOfCare.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare"
Communication.Slices for extension.extension:episodeOfCare.value[x] 1..1 Reference(EpisodeOfCare) {r} Value of extension
Communication.Slices for extension.extension:recipientCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
Communication.Slices for extension.extension:senderCareTeam 0..1 Reference(ehealth-careteam) {r} CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
Communication.Slices for extension.extension:restrictionCategory 0..* CodeableConcept Restriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
Communication.Slices for extension.extension:threadId 0..1 string Thread id
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
Communication.Slices for extension.extension:period 0..* Period Specifies the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
Communication.Slices for extension.extension:administrativeStatus 1..1 Coding The administrative status of how a message recipient has handled a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
Binding: Administrative Status (required)
Communication.Slices for extension.extension:title 0..1 string Message title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
Communication.Slices for extension.extension:priority 0..1 code The priority of a message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
Binding: Priority (required)
Communication.Slices for extension.extension:groupId 0..1 string Logical id identifying a set of messages with the same recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
Communication.Slices for extension.extension:onBehalfOf This element must be supported. 0..1 Reference(ehealth-careteam | ehealth-patient) {r} On behalf of
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of
Communication.Slices for extension.extension:author 0..1 Reference(RelatedPerson) {r} Attorney who authored the message
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message-author
Communication.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Communication.identifier This element is included in summaries. 0..* Identifier Unique identifier
Communication.instantiatesCanonical This element is included in summaries. 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
Communication.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
Communication.basedOn This element is included in summaries. 0..* Reference(Resource) Request fulfilled by this communication
Communication.partOf This element is included in summaries. 0..* Reference(CarePlan) {r} Part of this action
Communication.inResponseTo 0..* Reference(Communication) Reply to
Communication.status This element is a modifier element. This element is included in summaries. 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
Communication.statusReason This element is included in summaries. 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
Communication.Slices for category 1..* CodeableConcept Message category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for category.category:DkTmCategory 1..1 CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
Communication.Slices for category.category:DkTmCategory.id 0..1 string Unique id for inter-element referencing
Communication.Slices for category.category:DkTmCategory.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.Slices for category.category:DkTmCategory.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Communication.Slices for category.category:DkTmCategory.coding.id 0..1 string Unique id for inter-element referencing
Communication.Slices for category.category:DkTmCategory.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.Slices for category.category:DkTmCategory.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://ehealth.sundhed.dk/cs/message-category (extensions allowed)
Communication.Slices for category.category:DkTmCategory.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Communication.Slices for category.category:DkTmCategory.coding.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Binding: MessageCategory (required)
Communication.Slices for category.category:DkTmCategory.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Communication.Slices for category.category:DkTmCategory.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Communication.Slices for category.category:DkTmCategory.text This element is included in summaries. 0..1 string Plain text representation of the concept
Communication.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
Communication.Slices for medium 0..* CodeableConcept A channel of communication
Slice: Unordered, Open by value:coding.system
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.Slices for medium.medium:DkTmMedium 0..1 CodeableConcept A channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.
Communication.Slices for medium.medium:DkTmMedium.id 0..1 string Unique id for inter-element referencing
Communication.Slices for medium.medium:DkTmMedium.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.Slices for medium.medium:DkTmMedium.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Communication.Slices for medium.medium:DkTmMedium.coding.id 0..1 string Unique id for inter-element referencing
Communication.Slices for medium.medium:DkTmMedium.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.Slices for medium.medium:DkTmMedium.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://ehealth.sundhed.dk/cs/message-medium (extensions allowed)
Communication.Slices for medium.medium:DkTmMedium.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Communication.Slices for medium.medium:DkTmMedium.coding.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Binding: MessageMedium (required)
Communication.Slices for medium.medium:DkTmMedium.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Communication.Slices for medium.medium:DkTmMedium.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Communication.Slices for medium.medium:DkTmMedium.text This element is included in summaries. 0..1 string Plain text representation of the concept
Communication.subject This element is included in summaries. 0..1 Reference(Patient | Group) Focus of message
Communication.topic 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
Communication.about 0..* Reference(Resource) Resources that pertain to this communication
Communication.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
Communication.sent 0..1 dateTime When sent
Communication.received 0..1 dateTime When received
Communication.recipient 0..1 Reference(Patient | Practitioner | ehealth-relatedperson) {r} Message recipient
Communication.sender 0..1 Reference(Device | Patient | Practitioner | RelatedPerson) {r, c} Message sender
Communication.reasonCode This element is included in summaries. 0..* CodeableConcept Indication for message
Binding: eHealth Message Reason Code (required)
Communication.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation) {r} Why was communication done?
Communication.payload 0..1 BackboneElement Message payload
Communication.payload.id 0..1 string Unique id for inter-element referencing
Communication.payload.extension 0..* Extension Additional content defined by implementations
Communication.payload.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Communication.payload.Slices for content[x] 1..1 string Message part content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.payload.Slices for content[x].content[x]:contentString 1..1 string Message part content
Communication.note 0..* Annotation Comments made about the communication
Communication.note.id 0..1 string Unique id for inter-element referencing
Communication.note.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Communication.note.Slices for author[x] This element is included in summaries. 0..1 Individual responsible for the annotation
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Communication.note.Slices for author[x].authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
Communication.note.Slices for author[x].authorString string
Communication.note.Slices for author[x].author[x]:authorReference This element is included in summaries. 0..1 Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) Individual responsible for the annotation
Communication.note.Slices for author[x].author[x]:authorString This element is included in summaries. 0..1 string Individual responsible for the annotation
Communication.note.time This element is included in summaries. 0..1 dateTime When the annotation was made
Communication.note.text This element is included in summaries. 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Communication.status Base required EventStatus 📍4.0.1 FHIR Std.
Communication.statusReason Base example CommunicationNotDoneReason 📍4.0.1 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.category:DkTmCategory Base example CommunicationCategory 📍4.0.1 FHIR Std.
Communication.category:DkTmCategory.​coding.code Base required MessageCategory 📦11.0.1 This IG
Communication.priority Base required Request priority 📍4.0.1 FHIR Std.
Communication.medium Base example ParticipationMode 📦3.0.0 THO v7.4
Communication.medium:DkTmMedium Base example ParticipationMode 📦3.0.0 THO v7.4
Communication.medium:DkTmMedium.​coding.code Base required MessageMedium 📦11.0.1 This IG
Communication.topic Base example CommunicationTopic 📍4.0.1 FHIR Std.
Communication.reasonCode Base required eHealth Message Reason Code 📦11.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
advice-invariant error Communication Category advice invariant category.coding.code contains 'advice' implies (recipient.reference.contains('Patient/') or recipient.reference.contains('RelatedPerson/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())
message-invariant error Communication Category message invariant category.coding.code contains 'message' implies (recipient.reference.contains('Patient/') and ( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and (sender.reference.contains('Patient/')) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').value.as(Reference).exists() )) or (sender.reference.contains('RelatedPerson/') and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-on-behalf-of').value.as(Reference).reference.contains('Patient/'))
nemsms-invariant error Communication If communication resource is a NemSMS payload cannot exceed 160 medium.coding.where(code = 'nemsms').exists() implies payload.content.ofType(string).length() <= 160
note-invariant error Communication Category note invariant category.coding.code contains 'note' implies (recipient.reference contains sender.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists())
notification-invariant error Communication Category notification invariant category.coding.code contains 'notification' implies (recipient.reference.contains('Patient/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').value.as(Reference).exists()) and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not())

Summary

Mandatory: 4 elements(3 nested mandatory elements)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Communication.category
  • The element 1 is sliced based on the value of Communication.medium
  • The element 1 is sliced based on the value of Communication.payload.content[x] (Closed)
  • The element 1 is sliced based on the value of Communication.note.author[x]

 

Other representations of profile: CSV, Excel, Schematron