eHealth Infrastructure
2021.3.0 - build

eHealth Infrastructure - Local Development build (v2021.3.0). See the Directory of published versions

Resource Profile: ehealth-communication

Defining URL:http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication
Version:2021.3.0
Name:ehealth-communication
Status:Active as of 2021-11-25T09:32:14+00:00
Publisher:Systematic | Trifork
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

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

Introduction

The FHIR resource Communication is a record of a communication. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver.

This profile, the ehealth-communication, is intended for use of the FHIR Communication for capturing an annotation about a measurement. Such an annotation could for example describe circumstances about a particular Observation, QuestionnaireResponse or Media submitted by a Patient.

Scope and Usage

In the eHealth infrastructure, the annotation is defined using the following elements:

  • sender refers to the creator and owner of the annotation
  • ehealth-communication-senderCareTeam has same function as sender but is used where the creator and owner is one or more CareTeams
  • recipient refers to the entities allowed to read the annotation
  • ehealth-communication-recipientCareTeam has same function as recipient but is used where the allowed reading entity is one or more CareTeams
  • ehealth-restriction-category indicates, when ehealth-communication-senderCareTeam and/or ehealth-communication-recipientCareTeam refer to one or more CareTeams, what workflow areas/responsibilities of members of those CareTeams that the annotation is relevant for.
  • topic refers to the measurement which the annotation is about. This can be zero or more Observation, zero or more QuestionnaireResponse and zero or more Media. At least one of Observation, QuestionnaireResponse or Media should be referred for the annotation to make sense.
  • payload contains the annotation text itself

Boundaries and Relationships

In scope of the eHealth infrastructure, FHIR Communication is also used in the profile ehealth-message where a FHIR Communication captures written communication in the form of messages, notifications and advises. The ehealth-message profile is also used for personal notes.

A personal note differ from an annotation in that the latter is specific for measurements where the former has broader scope.

Formal Views of Profile Content

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

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... ehealth-communication-recipientCareTeam 0..*Reference()CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
... ehealth-restriction-category 1..*CodeableConceptRestriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
... basedOn 0..*Reference(Resource) {r}Request fulfilled by this communication
... partOf 0..*Reference(Resource) {r}Part of this action
... category 1..*CodeableConceptMessage category
Binding: Communication Category (required)
... subject 1..1Reference(ehealth-patient) {r}Focus of message
... recipient 0..*Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r}Message recipient
... sender 0..1Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r}Message sender
... reasonReference 0..*Reference(ehealth-condition | ehealth-observation) {r}Why was communication done?
... payload
.... contentString 1..1stringMessage part content

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... ehealth-communication-recipientCareTeam 0..*Reference()CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
... ehealth-communication-senderCareTeam 0..*Reference(ehealth-careteam) {r}CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
... ehealth-restriction-category 1..*CodeableConceptRestriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(Resource) {r}Request fulfilled by this communication
... partOf Σ0..*Reference(Resource) {r}Part of this action
... inResponseTo 0..*Reference(Communication)Reply to
... status ?!Σ1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.

... statusReason Σ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.

... category 1..*CodeableConceptMessage category
Binding: Communication Category (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.

... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject Σ1..1Reference(ehealth-patient) {r}Focus of message
... topic 0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.

... about 0..*Reference(Resource)Resources that pertain to this communication
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... recipient 0..*Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r}Message recipient
... sender 0..1Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r}Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference Σ0..*Reference(ehealth-condition | ehealth-observation) {r}Why was communication done?
... payload 0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1stringMessage part content
Slice: Unordered, Closed by type:$this
..... content[x]:contentString 1..1stringMessage part content
... note 0..*AnnotationComments made about the communication

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver

doco Documentation for this format

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... ehealth-communication-recipientCareTeam 0..*Reference()CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
... ehealth-restriction-category 1..*CodeableConceptRestriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
... basedOn 0..*Reference(Resource) {r}Request fulfilled by this communication
... partOf 0..*Reference(Resource) {r}Part of this action
... category 1..*CodeableConceptMessage category
Binding: Communication Category (required)
... subject 1..1Reference(ehealth-patient) {r}Focus of message
... recipient 0..*Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r}Message recipient
... sender 0..1Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r}Message sender
... reasonReference 0..*Reference(ehealth-condition | ehealth-observation) {r}Why was communication done?
... payload
.... contentString 1..1stringMessage part content

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... ehealth-communication-recipientCareTeam 0..*Reference()CareTeam message recipient
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam
... ehealth-communication-senderCareTeam 0..*Reference(ehealth-careteam) {r}CareTeam message sender
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam
... ehealth-restriction-category 1..*CodeableConceptRestriction category
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category
Binding: Restriction Category (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(Resource) {r}Request fulfilled by this communication
... partOf Σ0..*Reference(Resource) {r}Part of this action
... inResponseTo 0..*Reference(Communication)Reply to
... status ?!Σ1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.

... statusReason Σ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.

... category 1..*CodeableConceptMessage category
Binding: Communication Category (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.

... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject Σ1..1Reference(ehealth-patient) {r}Focus of message
... topic 0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.

... about 0..*Reference(Resource)Resources that pertain to this communication
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... recipient 0..*Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r}Message recipient
... sender 0..1Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r}Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference Σ0..*Reference(ehealth-condition | ehealth-observation) {r}Why was communication done?
... payload 0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1stringMessage part content
Slice: Unordered, Closed by type:$this
..... content[x]:contentString 1..1stringMessage part content
... note 0..*AnnotationComments made about the communication

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Communication.statusrequiredEventStatus
Communication.statusReasonexampleCommunicationNotDoneReason
Communication.categoryrequiredCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexampleParticipationMode
Communication.topicexampleCommunicationTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

Constraints

IdPathDetailsRequirements
dom-2CommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3CommunicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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-5CommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6CommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Communication.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:episodeOfCareAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.extension:episodeOfCareMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:recipientCareTeamAll FHIR elements must have a @value or children
: hasValue() or (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() or (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() or (children().count() > id.count())
ext-1Communication.extension:restrictionCategoryMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.inResponseToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.mediumAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.aboutAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.sentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.receivedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.recipientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.senderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.payloadAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.payload.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.payload.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.payload.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.payload.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.payload.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.payload.content[x]:contentStringAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())