eHealth Infrastructure (v2020.4)

StructureDefinition: ehealth-message

Introduction

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

  • Message: For sending messages from Patients, CareTeams (Practitioners), and Devices 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. When sent (by setting status “completed”), a message may no longer be updated by the sender. A recipient may update the “received” time and the “administrative-status” (eg. “read”) on a message.
  • Notification: For sending notification from Practitioners to Patients. 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 can be seen as reminders caused by a planned event, eg. a measurement or online meeting which is to take place.
  • 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 “topic” 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: Makes it possible for the message sender to create a draft message by specifying status “preparation”, and to cancel the message by setting status “aborted”. When the message is ready to be sent, specify status “completed”. Then the platform will handle any necessary forwarding. As long as the status is “preparation”, the message may be updated as desired, but not after the status is set to “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.

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
  • restrictionCategory: Specify the desired restriction category using system and code (eg. “http://ehealth.sundhed.dk/cs/restriction-category” and “measurement-monitoring”)

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 (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.

Notifications

The following rules apply to ehealth-message resources with status ‘completed’, given the recipient is a Patient who allows reception of NemSMS (has telecom with value ‘NemSMS’):

  • the payload of a ehealth-message resource with medium.code ‘nemsms’ is sent to the Patient as a NemSMS.
  • a ehealth-message resource with medium.code not equal to ‘nemsms’ triggers a notification message to the Patient, sent as a NemSMS.

Update rules

An ehealth-message may not have its category changed, eg. from ‘note’ to ‘message’.

When status is “preparation”, message contents may be updated, but not after status has been set to “completed”.

An ehealth-message may be PATCH updated on paths complying with the regular expressions below.

Path Description
/implicitRules.* For category ‘note’ or status ‘preparation’
/category.* For category ‘note’ or status ‘preparation’
/contained.* For category ‘note’ or status ‘preparation’
/recipient.* For category ‘note’ or status ‘preparation’
/definition.* For category ‘note’ or status ‘preparation’
/basedOn.* For category ‘note’ or status ‘preparation’
/partOf.* For category ‘note’ or status ‘preparation’
/topic.* For category ‘note’ or status ‘preparation’
/notDone.* For category ‘note’ or status ‘preparation’
/notDoneReason.* For category ‘note’ or status ‘preparation’
/context.* For category ‘note’ or status ‘preparation’
/received.* For all values of category
/reasonCode.* For category ‘note’ or status ‘preparation’
/reasonReference.* For category ‘note’ or status ‘preparation’
/payload.* For category ‘note’ or status ‘preparation’
/note.* For category ‘note’ or status ‘preparation’
/status.* For category ‘note’ or status ‘preparation’
/extension.* For category ‘note’ or status ‘preparation’

Formal Views of Profile Content

The official URL for this profile is:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message

This is the profile for general messaging in the eHealth platform. It covers four different message types: messages, notifications, advice, and notes. This is specified using the message category (value set "Message category"). When needed, message medium NemSMS may also be specified (value set "Message medium").

Message-related state, such as whether a message has been read etc, is handled through the use of the administrative-status extension.

This profile builds on Communication.

This profile was published on Fri May 22 12:11:22 UTC 2020 as a draft by ehealth.sundhed.dk.

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

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
nemsms-1: If communication resource is a NemSMS payload cannot exceed 160
note-invariant: Category note invariant
notification-invariant: Category notification invariant
message-invariant: Category message invariant
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-communication-recipientCareTeam 0..1Reference()CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
... ehealth-communication-senderCareTeam 0..1Reference()CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
... ehealth-restriction-category 0..*CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
.... valueCodeableConcept:valueCodeableConcept 1..1CodeableConceptValue of extension
..... coding 0..*CodingCode defined by a terminology system
... ehealth-thread-id 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
.... valueString:valueString 0..1stringValue of extension
... ehealth-period 0..*PeriodSpecified the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
... ehealth-administrative-status 0..1CodingExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
... ehealth-title 0..1stringMessage title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
... ehealth-priority 0..1codeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
Binding: Priority (required)
.... valueCode:valueCode 0..1codeValue of extension
Binding: Priority (required)
... ehealth-group-id 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... identifier 0..*IdentifierUnique identifier
... definition 0..*Reference(PlanDefinition | ActivityDefinition) {r}Instantiates protocol or definition
... basedOn 0..*Reference(Resource) {r}Request fulfilled by this communication
... partOf 0..*Reference(CarePlan) {r}The CarePlan that this communication relates to
... status 1..1codepreparation | aborted | completed
Binding: EventStatus (required)
... category 1..*(Slice Definition)Message category
Slice: Unordered, Open by value:coding.system
.... category:DkTmCategory 1..1CodeableConceptMessage category
..... coding 0..*CodingCode defined by a terminology system
Binding: MessageCategory (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/cs/message-category
...... code 0..1codeSymbol in syntax defined by the system
Binding: MessageCategory (required)
... medium 0..*(Slice Definition)A channel of communication
Slice: Unordered, Open by value:coding.system
.... medium:DkTmMedium 0..1CodeableConceptA channel of communication
Binding: MessageMedium (example)
..... coding 0..*CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/cs/message-medium
...... code 0..1codeSymbol in syntax defined by the system
Binding: MessageMedium (required)
... subject 0..1Reference(Patient | Group) {r}Focus of message
... recipient 0..1Reference(Patient | Practitioner) {r}Message recipient
... topic 0..*Reference(Resource) {r}Focal resources
... context 0..1Reference(Encounter | EpisodeOfCare) {r}Encounter or episode leading to message
... sender 0..1Reference(Device | Patient | Practitioner) {r}Message sender
... reasonCode
.... coding 0..*CodingCode defined by a terminology system
Binding: eHealth Message Reason Code (required)
... reasonReference 0..*Reference(Condition | Observation) {r}Why was communication done?
... payload 0..1BackboneElementMessage payload
.... contentString:contentString 1..1stringMessage part content
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring

doco Documentation for this format

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
nemsms-1: If communication resource is a NemSMS payload cannot exceed 160
note-invariant: Category note invariant
notification-invariant: Category notification invariant
message-invariant: Category message invariant
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-communication-recipientCareTeam I0..1Reference()CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
... ehealth-communication-senderCareTeam I0..1Reference()CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
... ehealth-restriction-category I0..*CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category"
.... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Restriction Category (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
Binding: Restriction Category (required)
...... text Σ0..1stringPlain text representation of the concept
... ehealth-thread-id I0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueString 0..1stringValue of extension
... ehealth-period I0..*PeriodSpecified the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
... ehealth-administrative-status I0..1CodingExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
... ehealth-title I0..1stringMessage title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
... ehealth-priority I0..1codeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCode 0..1codeValue of extension
Binding: Priority (required)
... ehealth-group-id I0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... definition Σ0..*Reference(PlanDefinition | ActivityDefinition) {r}Instantiates protocol or definition
... basedOn Σ0..*Reference(Resource) {r}Request fulfilled by this communication
... partOf Σ0..*Reference(CarePlan) {r}The CarePlan that this communication relates to
... status ?!Σ1..1codepreparation | aborted | completed
Binding: EventStatus (required)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category 1..*(Slice Definition)Message category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example)
.... category:DkTmCategory 1..1CodeableConceptMessage category
Binding: CommunicationCategory (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
Binding: MessageCategory (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/cs/message-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Binding: MessageCategory (required)
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... medium 0..*(Slice Definition)A channel of communication
Slice: Unordered, Open by value:coding.system
Binding: ParticipationMode (example)
.... medium:DkTmMedium 0..1CodeableConceptA channel of communication
Binding: MessageMedium (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/cs/message-medium
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Binding: MessageMedium (required)
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group) {r}Focus of message
... recipient 0..1Reference(Patient | Practitioner) {r}Message recipient
... topic 0..*Reference(Resource) {r}Focal resources
... context Σ0..1Reference(Encounter | EpisodeOfCare) {r}Encounter or episode leading to message
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... sender 0..1Reference(Device | Patient | Practitioner) {r}Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: eHealth Message Reason Code (required)
.... text Σ0..1stringPlain text representation of the concept
... reasonReference Σ0..*Reference(Condition | Observation) {r}Why was communication done?
... payload I0..1BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1(Slice Definition)Message part content
Slice: Unordered, Closed by type:$this
..... content[x]:contentString 1..1stringMessage part content
... note 0..*AnnotationComments made about the communication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
nemsms-1: If communication resource is a NemSMS payload cannot exceed 160
note-invariant: Category note invariant
notification-invariant: Category notification invariant
message-invariant: Category message invariant
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-communication-recipientCareTeam 0..1Reference()CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
... ehealth-communication-senderCareTeam 0..1Reference()CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
... ehealth-restriction-category 0..*CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
.... valueCodeableConcept:valueCodeableConcept 1..1CodeableConceptValue of extension
..... coding 0..*CodingCode defined by a terminology system
... ehealth-thread-id 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
.... valueString:valueString 0..1stringValue of extension
... ehealth-period 0..*PeriodSpecified the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
... ehealth-administrative-status 0..1CodingExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
... ehealth-title 0..1stringMessage title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
... ehealth-priority 0..1codeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
Binding: Priority (required)
.... valueCode:valueCode 0..1codeValue of extension
Binding: Priority (required)
... ehealth-group-id 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... identifier 0..*IdentifierUnique identifier
... definition 0..*Reference(PlanDefinition | ActivityDefinition) {r}Instantiates protocol or definition
... basedOn 0..*Reference(Resource) {r}Request fulfilled by this communication
... partOf 0..*Reference(CarePlan) {r}The CarePlan that this communication relates to
... status 1..1codepreparation | aborted | completed
Binding: EventStatus (required)
... category 1..*(Slice Definition)Message category
Slice: Unordered, Open by value:coding.system
.... category:DkTmCategory 1..1CodeableConceptMessage category
..... coding 0..*CodingCode defined by a terminology system
Binding: MessageCategory (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/cs/message-category
...... code 0..1codeSymbol in syntax defined by the system
Binding: MessageCategory (required)
... medium 0..*(Slice Definition)A channel of communication
Slice: Unordered, Open by value:coding.system
.... medium:DkTmMedium 0..1CodeableConceptA channel of communication
Binding: MessageMedium (example)
..... coding 0..*CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/cs/message-medium
...... code 0..1codeSymbol in syntax defined by the system
Binding: MessageMedium (required)
... subject 0..1Reference(Patient | Group) {r}Focus of message
... recipient 0..1Reference(Patient | Practitioner) {r}Message recipient
... topic 0..*Reference(Resource) {r}Focal resources
... context 0..1Reference(Encounter | EpisodeOfCare) {r}Encounter or episode leading to message
... sender 0..1Reference(Device | Patient | Practitioner) {r}Message sender
... reasonCode
.... coding 0..*CodingCode defined by a terminology system
Binding: eHealth Message Reason Code (required)
... reasonReference 0..*Reference(Condition | Observation) {r}Why was communication done?
... payload 0..1BackboneElementMessage payload
.... contentString:contentString 1..1stringMessage part content
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
nemsms-1: If communication resource is a NemSMS payload cannot exceed 160
note-invariant: Category note invariant
notification-invariant: Category notification invariant
message-invariant: Category message invariant
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-communication-recipientCareTeam I0..1Reference()CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
... ehealth-communication-senderCareTeam I0..1Reference()CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
... ehealth-restriction-category I0..*CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category"
.... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Restriction Category (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
Binding: Restriction Category (required)
...... text Σ0..1stringPlain text representation of the concept
... ehealth-thread-id I0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-thread-id"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueString 0..1stringValue of extension
... ehealth-period I0..*PeriodSpecified the temporal validity of an ehealth/message instance
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-period
... ehealth-administrative-status I0..1CodingExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-administrative-status
... ehealth-title I0..1stringMessage title
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-title
... ehealth-priority I0..1codeExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-priority"
.... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCode 0..1codeValue of extension
Binding: Priority (required)
... ehealth-group-id I0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-group-id
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... definition Σ0..*Reference(PlanDefinition | ActivityDefinition) {r}Instantiates protocol or definition
... basedOn Σ0..*Reference(Resource) {r}Request fulfilled by this communication
... partOf Σ0..*Reference(CarePlan) {r}The CarePlan that this communication relates to
... status ?!Σ1..1codepreparation | aborted | completed
Binding: EventStatus (required)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category 1..*(Slice Definition)Message category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example)
.... category:DkTmCategory 1..1CodeableConceptMessage category
Binding: CommunicationCategory (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
Binding: MessageCategory (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/cs/message-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Binding: MessageCategory (required)
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... medium 0..*(Slice Definition)A channel of communication
Slice: Unordered, Open by value:coding.system
Binding: ParticipationMode (example)
.... medium:DkTmMedium 0..1CodeableConceptA channel of communication
Binding: MessageMedium (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://ehealth.sundhed.dk/cs/message-medium
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Binding: MessageMedium (required)
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group) {r}Focus of message
... recipient 0..1Reference(Patient | Practitioner) {r}Message recipient
... topic 0..*Reference(Resource) {r}Focal resources
... context Σ0..1Reference(Encounter | EpisodeOfCare) {r}Encounter or episode leading to message
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... sender 0..1Reference(Device | Patient | Practitioner) {r}Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: eHealth Message Reason Code (required)
.... text Σ0..1stringPlain text representation of the concept
... reasonReference Σ0..*Reference(Condition | Observation) {r}Why was communication done?
... payload I0..1BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1(Slice Definition)Message part content
Slice: Unordered, Closed by type:$this
..... content[x]:contentString 1..1stringMessage part content
... note 0..*AnnotationComments made about the communication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

 

Terminology Bindings

PathConformanceValueSet
Communication.languageextensibleCommon Languages
Max Binding: All Languages
Communication.extension:restrictionCategory.value[x]:valueCodeableConceptrequiredRestrictionCategory
Communication.extension:restrictionCategory.value[x]:valueCodeableConcept.codingrequiredRestrictionCategory
Communication.extension:priority.value[x]:valueCoderequiredPriority
Communication.statusrequiredEventStatus
Communication.notDoneReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.category:DkTmCategoryexampleCommunicationCategory
Communication.category:DkTmCategory.codingrequiredMessageCategory
Communication.category:DkTmCategory.coding.coderequiredMessageCategory
Communication.mediumexamplev3 Code System ParticipationMode
Communication.medium:DkTmMediumexampleMessageMedium
Communication.medium:DkTmMedium.coding.coderequiredMessageMedium
Communication.reasonCodeexampleSNOMED CT Clinical Findings
Communication.reasonCode.codingrequiredeHealth Message Reason Code

Constraints

IdPathDetailsRequirements
dom-2CommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1CommunicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4CommunicationIf 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-3CommunicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
com-1CommunicationNot Done Reason can only be specified if NotDone is "true"
: notDone or notDoneReason.exists().not()
nemsms-1CommunicationIf communication resource is a NemSMS payload cannot exceed 160
: medium.coding.where(code = 'nemsms').exists() implies payload.contentString.length() <= 160
note-invariantCommunicationCategory note invariant
: category.coding.code = 'note' implies (sender.reference = recipient.reference) or (recipient.reference.exists().not() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists())
notification-invariantCommunicationCategory notification invariant
: category.coding.code = 'notification' implies recipient.reference.contains('Patient/') and ( sender.reference.contains('Practitioner/') or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists())
message-invariantCommunicationCategory message invariant
: category.coding.code = 'message' implies (recipient.reference.contains('Patient/') and ( sender.reference.contains('Device/') or contained.ofType(Device).where('#' + id = %resource.sender.reference).empty().not() or extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists())) or (( extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists()) and (sender.reference.contains('Patient/') or sender.reference.contains('Device/'))) or (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam').valueReference.exists() and extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam').valueReference.exists() )
ele-1Communication.extension:recipientCareTeamAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:recipientCareTeamMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:senderCareTeamAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:senderCareTeamMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:restrictionCategoryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:restrictionCategoryMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:threadIdAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:threadIdMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:periodAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:periodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:administrativeStatusAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:administrativeStatusMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:titleAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:titleMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:priorityAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:priorityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:groupIdAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Communication.extension:groupIdMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.payloadAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.