This page is part of the Clinical Guidelines (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/cpg/Library/sendmessage-library | Version: 2.0.0-ballot | |||
Active as of 2023-12-19 | Computable Name: SendMessageLibrary |
Logic for an example recommendation to send a message
Patient | out | 0 | 1 | Patient |
Inclusion Criteria | out | 0 | 1 | boolean |
Active or Completed Communication | out | 0 | * | Communication |
Communication Not Done | out | 0 | * | Communication |
Communication Proposal | out | 0 | * | CommunicationRequest |
Communication Not Proposed | out | 0 | * | CommunicationRequest |
Is Recommendation Applicable | out | 0 | 1 | boolean |
Type: Communication (Communication) |
Type: Communication (Communication) |
Type: CommunicationRequest (CommunicationRequest) |
Type: CommunicationRequest (CommunicationRequest) |
text/cql
library SendMessage
using FHIR version '4.0.1'
include FHIRHelpers version '4.0.1'
context Patient
/* Recommendation to greet the patient */
/*
NOTE: This recommendation is dramatically simplified to illustrate the general
pattern for a positive recommendation, with the ability for users to reject
the recommendation, and flexibility in how the recommendation is achieved.
Specifically:
* There is no terminology, any communication request/event on any topic will do
* There is no timing, any communication request/event will do at any time
* There is no reference to participants other than the patient
* There is no relationship to a setting
* There is no relationship to an encounter or episode
* There is no relationship to a care plan
These simplifications allow the example to focus exclusively on the pattern for
recommending and for accepting/rejecting the proposal, as well as documenting
the completion, or explicit non-performance of the communication.
*/
/*
Positive recommendation:
If the activity has not been performed
If the activity has not been planned or proposed
Propose the activity
Given a proposal, the user can:
Accept the proposal
Ignore the proposal
Reject the proposal without reason
Reject the proposal with reason
Scenario 1: No event, no plan or proposal, decision support should propose
Scenario 2: No event, incomplete proposal, decision support should not propose
Scenario 3: No event, rejected proposal, decision support should not propose
Scenario 4: Event, no proposal, decision support should not propose
Scenario 5: Event, completed proposal, decision support should not propose
Scenario 6: Event not done, no proposal, decision support should not propose
Scenario 7: Event not done, proposal, decision support should not propose
*/
define "Inclusion Criteria":
Patient.active
define "Active or Completed Communication":
[Communication] C
where C.status in { 'preparation', 'in-progress', 'on-hold', 'completed' }
define "Communication Not Done":
[Communication] C
where C.status in { 'not-done', 'stopped' }
define "Communication Proposal":
[CommunicationRequest] R
where R.status in { 'draft', 'active', 'on-hold' }
and not (Coalesce(R.doNotPerform, false))
define "Communication Not Proposed":
[CommunicationRequest] R
where R.status in { 'revoked' }
and not (Coalesce(R.doNotPerform, false))
define "Is Recommendation Applicable":
"Inclusion Criteria"
and not exists (
"Active or Completed Communication"
union "Communication Not Done"
)
and not exists (
"Communication Proposal"
union "Communication Not Proposed"
)
Content not shown - (
application/elm+xml
, size = 24Kb)
Content not shown - (
application/elm+json
, size = 43Kb)