eHealth Infrastructure
2.5.0 - release

eHealth Infrastructure - Local Development build (v2.5.0). See the Directory of published versions

Resource Profile: ehealth-communication-request

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-request Version: 2.5.0
Active as of 2023-02-09 Computable Name: ehealth-communication-request

Introduction

The CommunicationRequest resource allows for change in the way eHealth automated processing creates Communication (of profile ehealth-message) as a result of a submitted measurement or lack thereof for a particular Patient and context.

Scope and Usage

In the eHealth Infrastructure, automated processing generates Communication (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 unexpected time

By default, the Communication is created with recipient set to the one or more CareTeam associated with the CarePlan referencing the ServiceRequest for which the measurement was made.

The CommunicationRequest is used to customize how and when Communications are created by automated processing:

  • For a CareTeam, the CommunicationRequest specifies suppression of setting the CareTeam as recipient of Communication
  • For a Patient, the CommunicationRequest specifies additional creation of Communication with the Patient as recipient

If multiple CommunicationRequests for the same recipient are found, then only the newest is considered valid.

Suppression of setting a CareTeam as recipient in Communication

When automated processing creates Communication about a specific ServiceRequest and Patient, the CareTeam is not set as recipient when a CommunicationRequest exists where:

  • basedOn references the ServiceRequest
  • recipient references the CareTeam
  • reasonCode matches the Communication reasonCode (of the Communication created for CareTeam).
  • priority matches the Task priority (of the Task created for CareTeam).
  • status is ‘suspended’

Setting the status to any other value than ‘suspended’ disables the specified suppression of Communication with the CareTeam as recipient. The Communication is created with recipient set as the remaining one or more CareTeam referenced from the CarePlan referencing the ServiceRequest. In case no remaining CareTeam are referenced from the CarePlan, no Communication is created.

Creation of Communication with Patient as recipient

When automated processing creates Communication about a specific ServiceRequest and Patient, additional Communication with the Patient as recipient is created if a CommunicationRequest exists where:

  • basedOn references the ServiceRequest
  • recipient references the Patient
  • reasonCode matches the Communication reasonCode (of the Communication created for CareTeam).
  • priority matches the Task priority (of the Task created for CareTeam).
  • status is ‘active’

Setting the status to ‘suspended’ disables the specified creation of Communication with the Patient as recipient.

Override medium and payload

It is possible to use CommunicationRequest to override some default values of the Communication:

  • medium of the Communication (created for the Patient or Careteam) overrides the Communication medium (of the Communication created for CareTeam).
  • payload of the Communication (created for the Patient) overrides the Communication payload (of the Communication created for CareTeam).

Boundaries and Relationships

A CommunicationRequest is related to Communication (ehealth-message), Task (ehealth-task), and 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..*CommunicationRequestA request for information to be sent to a receiver
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... basedOn 0..1Reference(Resource)Fulfills plan or proposal
... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: MessageMedium (required)
... subject 1..1Reference(Patient)Focus of message
... recipient 0..*Reference(Patient | CareTeam) {r}Message recipient

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CommunicationRequest.categoryrequiredMessageCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumrequiredMessageMedium
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... basedOn Σ0..1Reference(Resource)Fulfills plan or proposal
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CommunicationRequest.statusrequiredRequestStatus
CommunicationRequest.categoryrequiredMessageCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumrequiredMessageMedium
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent 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: CommonLanguages (preferred): A human language.

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

... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes identifying the reason for the current state of a request.

... category 0..*CodeableConceptMessage category
Binding: MessageCategory (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... medium 0..*CodeableConceptA channel of communication
Binding: MessageMedium (required)
... subject 1..1Reference(Patient)Focus of message
... about 0..*Reference(Resource)Resources that pertain to this communication request
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... 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
.... content[x] 1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... occurrence[x] Σ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ0..1dateTimeWhen request transitioned to being actionable
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... recipient 0..*Reference(Patient | CareTeam) {r}Message recipient
... sender Σ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode Σ0..*CodeableConceptWhy 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..*AnnotationComments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CommunicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CommunicationRequest.statusrequiredRequestStatus
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryrequiredMessageCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumrequiredMessageMedium
CommunicationRequest.reasonCodeexampleActReason

This structure is derived from CommunicationRequest

Summary

Mandatory: 3 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from CommunicationRequest

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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CommunicationRequest.categoryrequiredMessageCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumrequiredMessageMedium

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... basedOn Σ0..1Reference(Resource)Fulfills plan or proposal
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CommunicationRequest.statusrequiredRequestStatus
CommunicationRequest.categoryrequiredMessageCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumrequiredMessageMedium

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent 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: CommonLanguages (preferred): A human language.

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

... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes identifying the reason for the current state of a request.

... category 0..*CodeableConceptMessage category
Binding: MessageCategory (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... medium 0..*CodeableConceptA channel of communication
Binding: MessageMedium (required)
... subject 1..1Reference(Patient)Focus of message
... about 0..*Reference(Resource)Resources that pertain to this communication request
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... 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
.... content[x] 1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... occurrence[x] Σ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ0..1dateTimeWhen request transitioned to being actionable
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... recipient 0..*Reference(Patient | CareTeam) {r}Message recipient
... sender Σ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode Σ0..*CodeableConceptWhy 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..*AnnotationComments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CommunicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CommunicationRequest.statusrequiredRequestStatus
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryrequiredMessageCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumrequiredMessageMedium
CommunicationRequest.reasonCodeexampleActReason

This structure is derived from CommunicationRequest

Summary

Mandatory: 3 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron