eHealth Infrastructure (v2019.5.1)

StructureDefinition: ehealth-message

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, a message medium may also be specified: NemSMS or eBoks (value set "Message medium").

Message-related state, such as whether a message has been read or not, or time limited validity on notifications, is handled through the use of the Provenance resource.

This profile builds on Communication.

This profile was published on Thu May 16 12:32:10 UTC 2019 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

Summary

Mandatory: 4 elements (2 nested mandatory elements)
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Communication.category is sliced based on the value of value:coding.system
  • The element Communication.medium is sliced based on the value of value:coding.system

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*
... identifier 0..*Identifier
... definition 0..*Reference(PlanDefinition | ActivityDefinition) {r}
... basedOn 0..*Reference(Resource) {r}
... partOf 0..*Reference(CarePlan) {r}The CarePlan that this communication relates to
... category CodeableConceptSlice: Unordered, Open by value:coding.system
... category 1..1CodeableConcept
.... coding 0..*CodingBinding: MessageCategory (required)
..... system 1..1uriFixed Value: http://ehealth.sundhed.dk/message-category
..... code 0..1codeBinding: MessageCategory (required)
... medium CodeableConceptSlice: Unordered, Open by value:coding.system
... medium 0..1CodeableConceptBinding: MessageMedium (example)
.... coding 0..*Coding
..... system 1..1uriFixed Value: http://ehealth.sundhed.dk/message-medium
..... code 0..1codeBinding: MessageMedium (required)
... subject 0..1Reference(Patient | Group) {r}
... recipient 1..*Reference(Patient | Practitioner | CareTeam) {r}
... topic 0..*Reference(Resource) {r}
... context 0..1Reference(Encounter | EpisodeOfCare) {r}
... sender 1..1Reference(Patient | Practitioner | CareTeam) {r}
... reasonReference 0..*Reference(Condition | Observation) {r}
... payload 0..1BackboneElement
.... contentString 1..1string

doco Documentation for this format

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A record of information transmitted from a sender to a receiver
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... 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 | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category CodeableConceptMessage category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example)
... category 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/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 CodeableConceptA channel of communication
Slice: Unordered, Open by value:coding.system
Binding: ParticipationMode (example)
... medium 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/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 1..*Reference(Patient | Practitioner | CareTeam) {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 1..1Reference(Patient | Practitioner | CareTeam) {r}Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)
... 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
.... 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..1Reference(Practitioner | Patient | RelatedPerson) {r}, stringIndividual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

This structure is derived from Communication

Summary

Mandatory: 4 elements (2 nested mandatory elements)
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Communication.category is sliced based on the value of value:coding.system
  • The element Communication.medium is sliced based on the value of value:coding.system

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*
... identifier 0..*Identifier
... definition 0..*Reference(PlanDefinition | ActivityDefinition) {r}
... basedOn 0..*Reference(Resource) {r}
... partOf 0..*Reference(CarePlan) {r}The CarePlan that this communication relates to
... category CodeableConceptSlice: Unordered, Open by value:coding.system
... category 1..1CodeableConcept
.... coding 0..*CodingBinding: MessageCategory (required)
..... system 1..1uriFixed Value: http://ehealth.sundhed.dk/message-category
..... code 0..1codeBinding: MessageCategory (required)
... medium CodeableConceptSlice: Unordered, Open by value:coding.system
... medium 0..1CodeableConceptBinding: MessageMedium (example)
.... coding 0..*Coding
..... system 1..1uriFixed Value: http://ehealth.sundhed.dk/message-medium
..... code 0..1codeBinding: MessageMedium (required)
... subject 0..1Reference(Patient | Group) {r}
... recipient 1..*Reference(Patient | Practitioner | CareTeam) {r}
... topic 0..*Reference(Resource) {r}
... context 0..1Reference(Encounter | EpisodeOfCare) {r}
... sender 1..1Reference(Patient | Practitioner | CareTeam) {r}
... reasonReference 0..*Reference(Condition | Observation) {r}
... payload 0..1BackboneElement
.... contentString 1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A record of information transmitted from a sender to a receiver
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... 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 | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category CodeableConceptMessage category
Slice: Unordered, Open by value:coding.system
Binding: CommunicationCategory (example)
... category 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/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 CodeableConceptA channel of communication
Slice: Unordered, Open by value:coding.system
Binding: ParticipationMode (example)
... medium 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/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 1..*Reference(Patient | Practitioner | CareTeam) {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 1..1Reference(Patient | Practitioner | CareTeam) {r}Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)
... 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
.... 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..1Reference(Practitioner | Patient | RelatedPerson) {r}, stringIndividual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

 

Terminology Bindings

PathNameConformanceValueSet
Communication.languageCommon LanguagesextensibleCommon Languages
Communication.statusEventStatusrequiredEventStatus
Communication.notDoneReasonCommunicationNotDoneReasonexampleCommunicationNotDoneReason
Communication.categoryCommunicationCategoryexampleCommunicationCategory
Communication.categoryCommunicationCategoryexampleCommunicationCategory
Communication.category.codingMessageCategoryrequiredMessageCategory
Communication.category.coding.codeMessageCategoryrequiredMessageCategory
Communication.mediumMessageMediumexampleMessageMedium
Communication.mediumMessageMediumexampleMessageMedium
Communication.medium.coding.codeMessageMediumrequiredMessageMedium
Communication.reasonCodeSNOMED CT Clinical FindingsexampleSNOMED CT Clinical Findings

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()
ele-1Communication.payloadAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.