eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions
Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication | Version: 3.3.0 | |||
Active as of 2024-12-20 | Computable Name: ehealth-communication |
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.
In the eHealth infrastructure, the annotation is defined using the following elements:
sender
refers to the creator and owner of the annotationehealth-communication-senderCareTeam
has same function as sender
but is used where the creator and owner is one or more CareTeamsrecipient
refers to the entities allowed to read the annotationehealth-communication-recipientCareTeam
has same function as recipient
but is used where the allowed reading entity is one or more CareTeamsehealth-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 itselfIn 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
Path | Conformance | ValueSet | URI |
Communication.category | required | CommunicationCategory (a valid code from Communication Category)http://ehealth.sundhed.dk/vs/communication-category from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
recipientCareTeam | 0..* | Reference(ehealth-careteam) {r} | CareTeam message recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
senderCareTeam | 0..* | Reference(ehealth-careteam) {r} | CareTeam message sender URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
restrictionCategory | 1..* | CodeableConcept | Restriction category URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category Binding: Restriction Category (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
basedOn | Σ | 0..* | Reference(Resource) {r} | Request fulfilled by this communication ele-1: All FHIR elements must have a @value or children |
partOf | Σ | 0..* | Reference(Resource) {r} | Part of this action ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. ele-1: All FHIR elements must have a @value or children |
category | 1..* | CodeableConcept | Message category Binding: Communication Category (required) ele-1: All FHIR elements must have a @value or children | |
subject | Σ | 1..1 | Reference(ehealth-patient) {r} | Focus of message ele-1: All FHIR elements must have a @value or children |
recipient | 0..* | Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r} | Message recipient ele-1: All FHIR elements must have a @value or children | |
sender | 0..1 | Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r} | Message sender ele-1: All FHIR elements must have a @value or children | |
reasonReference | Σ | 0..* | Reference(ehealth-condition | ehealth-observation) {r} | Why was communication done? ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Communication.category | required | CommunicationCategory (a valid code from Communication Category)http://ehealth.sundhed.dk/vs/communication-category from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare | |||||
recipientCareTeam | 0..* | Reference(ehealth-careteam) {r} | CareTeam message recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam | |||||
senderCareTeam | 0..* | Reference(ehealth-careteam) {r} | CareTeam message sender URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam | |||||
restrictionCategory | 1..* | CodeableConcept | Restriction category URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category Binding: Restriction Category (required) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique identifier | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates 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..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
category | 1..* | CodeableConcept | Message category Binding: Communication Category (required) | |||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
subject | Σ | 1..1 | Reference(ehealth-patient) {r} | Focus of message | ||||
topic | 0..1 | CodeableConcept | Description 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..1 | Reference(Encounter) | Encounter created as part of | ||||
sent | 0..1 | dateTime | When sent | |||||
received | 0..1 | dateTime | When received | |||||
recipient | 0..* | Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r} | Message recipient | |||||
sender | 0..1 | Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r} | Message sender | |||||
reasonCode | Σ | 0..* | CodeableConcept | Indication 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..* | BackboneElement | Message payload | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
Slices for content[x] | 1..1 | string | Message part content Slice: Unordered, Closed by type:$this | |||||
content[x]:contentString | 1..1 | string | Message part content | |||||
note | 0..* | Annotation | Comments made about the communication | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard | ||||
Communication.category | required | CommunicationCategory (a valid code from Communication Category)http://ehealth.sundhed.dk/vs/communication-category from this IG | ||||
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Communication.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
Communication.topic | example | CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topic from the FHIR Standard | ||||
Communication.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
This structure is derived from Communication
Summary
Mandatory: 4 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Communication
Path | Conformance | ValueSet | URI |
Communication.category | required | CommunicationCategory (a valid code from Communication Category)http://ehealth.sundhed.dk/vs/communication-category from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
recipientCareTeam | 0..* | Reference(ehealth-careteam) {r} | CareTeam message recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
senderCareTeam | 0..* | Reference(ehealth-careteam) {r} | CareTeam message sender URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
restrictionCategory | 1..* | CodeableConcept | Restriction category URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category Binding: Restriction Category (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
basedOn | Σ | 0..* | Reference(Resource) {r} | Request fulfilled by this communication ele-1: All FHIR elements must have a @value or children |
partOf | Σ | 0..* | Reference(Resource) {r} | Part of this action ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. ele-1: All FHIR elements must have a @value or children |
category | 1..* | CodeableConcept | Message category Binding: Communication Category (required) ele-1: All FHIR elements must have a @value or children | |
subject | Σ | 1..1 | Reference(ehealth-patient) {r} | Focus of message ele-1: All FHIR elements must have a @value or children |
recipient | 0..* | Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r} | Message recipient ele-1: All FHIR elements must have a @value or children | |
sender | 0..1 | Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r} | Message sender ele-1: All FHIR elements must have a @value or children | |
reasonReference | Σ | 0..* | Reference(ehealth-condition | ehealth-observation) {r} | Why was communication done? ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Communication.category | required | CommunicationCategory (a valid code from Communication Category)http://ehealth.sundhed.dk/vs/communication-category from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare | |||||
recipientCareTeam | 0..* | Reference(ehealth-careteam) {r} | CareTeam message recipient URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-recipientCareTeam | |||||
senderCareTeam | 0..* | Reference(ehealth-careteam) {r} | CareTeam message sender URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-senderCareTeam | |||||
restrictionCategory | 1..* | CodeableConcept | Restriction category URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-restriction-category Binding: Restriction Category (required) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique identifier | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates 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..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
category | 1..* | CodeableConcept | Message category Binding: Communication Category (required) | |||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
medium | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
subject | Σ | 1..1 | Reference(ehealth-patient) {r} | Focus of message | ||||
topic | 0..1 | CodeableConcept | Description 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..1 | Reference(Encounter) | Encounter created as part of | ||||
sent | 0..1 | dateTime | When sent | |||||
received | 0..1 | dateTime | When received | |||||
recipient | 0..* | Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r} | Message recipient | |||||
sender | 0..1 | Reference(ehealth-device | ehealth-patient | ehealth-practitioner | ehealth-relatedperson) {r} | Message sender | |||||
reasonCode | Σ | 0..* | CodeableConcept | Indication 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..* | BackboneElement | Message payload | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
Slices for content[x] | 1..1 | string | Message part content Slice: Unordered, Closed by type:$this | |||||
content[x]:contentString | 1..1 | string | Message part content | |||||
note | 0..* | Annotation | Comments made about the communication | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard | ||||
Communication.category | required | CommunicationCategory (a valid code from Communication Category)http://ehealth.sundhed.dk/vs/communication-category from this IG | ||||
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Communication.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
Communication.topic | example | CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topic from the FHIR Standard | ||||
Communication.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
This structure is derived from Communication
Summary
Mandatory: 4 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron