eHealth Infrastructure
3.3.0 - ci-build Denmark flag

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

Resource Profile: ehealth-communication-request

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-request Version: 3.3.0
Active as of 2024-10-16 Computable Name: ehealth-communication-request

Introduction

The CommunicationRequest resource allows for changes in the way the eHealth Infrastructure creates Communications (of profile ehealth-message).

Scope and Usage

The eHealth Infrastructure generates Communications (of profile ehealth-message) in the following cases:

  • Automated processing has been performed on a submitted measurement - whether zero, one or more Communication are created depends on the automated processing rules involved.
  • A measurement is missing, that is, expected measurement has not been submitted
  • A measurement has been submitted at an unexpected time
  • A reminder that a measurement is expected to be submitted
  • A CarePlan or EpisodeOfCare has been created or updated
  • A reminder that an order in the SSL domain is to be delivered (requires additional configuration in the SSL Contract)

The default behaviour and controllability for the different Communication scenarios differ. An overview of how to control the different Communication generation can be found here.

The CommunicationRequest is used to customize how and when Communications are created by the infrastructure:

  • CommunicationRequest can in some scenarios specify suppression of a specific Communication for CareTeams and/or Patients
  • CommunicationRequest can in some scenarios specify overriding of medium and/or payload for Patient Communications

If multiple CommunicationRequests for the same recipient are found the most recent (by occurrencePeriod.start) with status active takes precedence. If multiple CommunicationRequest resources are the most recent and active, any CommunicationRequest with doNotPerform = true takes precedence.

Suppression of Communications

When the infrastructure by default creates Communication for either a Patient or CareTeam, it may be possible to suppress creation for a specific recipient. An overview of when suppression is possible is given here. A CommunicationRequest states suppression when:

  • doNotPerform is set to true

See the other requirements for a CommunicationRequest to take effect here.Updating doNotPerform to false or removing the attribute disables the specified suppression of the Communication. Alternatively, the CommunicationRequest lifecycle can be adjusted by setting a status value other than active.

Override medium and payload

In some scenarios it is possible to use CommunicationRequest to override some default values of the Communication:

  • medium overrides the Communication medium.
  • payload overrides the Communication payload.

Boundaries and Relationships

A CommunicationRequest is related to Communication (ehealth-message) and in some cases EpisodeOfCare (ehealth-episode-of-care) or ServiceRequest (ehealth-serviceRequest).

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 0..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... basedOn 0..1 Reference(Resource) Fulfills plan or proposal
... category 0..* CodeableConcept Message category
Binding: MessageCategory (required)
... medium 0..* CodeableConcept A channel of communication
Binding: MessageMedium (required)
... subject 1..1 Reference(Patient) Focus of message
... recipient 0..* Reference(Patient | CareTeam) {r} Message recipient

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CommunicationRequest.categoryrequiredMessageCategory
http://ehealth.sundhed.dk/vs/message-category
from this IG
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority
from the FHIR Standard
CommunicationRequest.mediumrequiredMessageMedium
http://ehealth.sundhed.dk/vs/message-medium
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 0..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.

... category 0..* CodeableConcept Message category
Binding: MessageCategory (required)
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: MessageMedium (required)
... subject 1..1 Reference(Patient) Focus of message
... recipient 0..* Reference(Patient | CareTeam) {r} Message recipient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CommunicationRequest.categoryrequiredMessageCategory
http://ehealth.sundhed.dk/vs/message-category
from this IG
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority
from the FHIR Standard
CommunicationRequest.mediumrequiredMessageMedium
http://ehealth.sundhed.dk/vs/message-medium
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 0..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique identifier
... basedOn Σ 0..1 Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.

... statusReason 0..1 CodeableConcept Reason for current status
Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of a request.

... category 0..* CodeableConcept Message category
Binding: MessageCategory (required)
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: MessageMedium (required)
... subject 1..1 Reference(Patient) Focus of message
... about 0..* Reference(Resource) Resources that pertain to this communication request
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... 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
.... content[x] 1..1 Message part content
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... recipient 0..* Reference(Patient | CareTeam) {r} Message recipient
... sender Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
... reasonCode Σ 0..* CodeableConcept Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryrequiredMessageCategory
http://ehealth.sundhed.dk/vs/message-category
from this IG
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority
from the FHIR Standard
CommunicationRequest.mediumrequiredMessageMedium
http://ehealth.sundhed.dk/vs/message-medium
from this IG
CommunicationRequest.reasonCodeexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

This structure is derived from CommunicationRequest

Summary

Mandatory: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 0..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... basedOn 0..1 Reference(Resource) Fulfills plan or proposal
... category 0..* CodeableConcept Message category
Binding: MessageCategory (required)
... medium 0..* CodeableConcept A channel of communication
Binding: MessageMedium (required)
... subject 1..1 Reference(Patient) Focus of message
... recipient 0..* Reference(Patient | CareTeam) {r} Message recipient

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CommunicationRequest.categoryrequiredMessageCategory
http://ehealth.sundhed.dk/vs/message-category
from this IG
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority
from the FHIR Standard
CommunicationRequest.mediumrequiredMessageMedium
http://ehealth.sundhed.dk/vs/message-medium
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 0..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.

... category 0..* CodeableConcept Message category
Binding: MessageCategory (required)
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: MessageMedium (required)
... subject 1..1 Reference(Patient) Focus of message
... recipient 0..* Reference(Patient | CareTeam) {r} Message recipient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CommunicationRequest.categoryrequiredMessageCategory
http://ehealth.sundhed.dk/vs/message-category
from this IG
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority
from the FHIR Standard
CommunicationRequest.mediumrequiredMessageMedium
http://ehealth.sundhed.dk/vs/message-medium
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 0..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique identifier
... basedOn Σ 0..1 Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.

... statusReason 0..1 CodeableConcept Reason for current status
Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of a request.

... category 0..* CodeableConcept Message category
Binding: MessageCategory (required)
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: MessageMedium (required)
... subject 1..1 Reference(Patient) Focus of message
... about 0..* Reference(Resource) Resources that pertain to this communication request
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... 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
.... content[x] 1..1 Message part content
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... recipient 0..* Reference(Patient | CareTeam) {r} Message recipient
... sender Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
... reasonCode Σ 0..* CodeableConcept Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryrequiredMessageCategory
http://ehealth.sundhed.dk/vs/message-category
from this IG
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority
from the FHIR Standard
CommunicationRequest.mediumrequiredMessageMedium
http://ehealth.sundhed.dk/vs/message-medium
from this IG
CommunicationRequest.reasonCodeexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

This structure is derived from CommunicationRequest

Summary

Mandatory: 1 element

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron