Clinical Practice Guidelines
2.0.0 - STU2 International flag

This page is part of the Clinical Guidelines (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Library: Send Message Library (Experimental)

Official URL: http://hl7.org/fhir/uv/cpg/Library/sendmessage-library Version: 2.0.0
Active as of 2024-11-26 Computable Name: SendMessageLibrary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.28.20

Logic for an example recommendation to send a message

Generated Narrative: Library sendmessage-library

Related Artifacts

Depends OnCode System Task CodesTask Codes

Parameters

Patientout01Patient
Inclusion Criteriaout01boolean
Active or Completed Communicationout0*Communication
Communication Not Doneout0*Communication
Rejected Taskout0*Task
Communication Proposalout0*CommunicationRequest
Communication Rejectedout0*CommunicationRequest
Communication Prohibitedout0*CommunicationRequest
Is Recommendation Applicableout01boolean

Data Requirements

Type: Communication (Communication)
Type: Communication (Communication)
Type: Task (Task)
Type: CommunicationRequest (CommunicationRequest)
Type: CommunicationRequest (CommunicationRequest)
Type: CommunicationRequest (CommunicationRequest)

Contents

text/cql

library SendMessage

using FHIR version '4.0.1'

include FHIRHelpers version '4.0.1'

codesystem "Task Codes": 'http://hl7.org/fhir/CodeSystem/task-code'

code "fulfill": 'fulfill' from "Task Codes" display 'Fulfill'

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 requested
    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 proposal, decision support should propose
Scenario 2: No event, active 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, active 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 "Rejected Task":
  [Task] T
    where T.code ~ "fulfill"
      and T.status = 'rejected'

define "Communication Proposal":
  [CommunicationRequest] R
    without "Rejected Task" T 
      such that R.id = Last(Split(T.focus.reference, '/'))
    where R.status in { 'draft', 'active', 'on-hold' }
      and R.doNotPerform is not true

define "Communication Rejected":
  [CommunicationRequest] R
    with "Rejected Task" T
      such that R.id = Last(Split(T.focus.reference, '/'))
    where R.status in { 'draft', 'active', 'on-hold' }
      and R.doNotPerform is not true

define "Communication Prohibited":
  [CommunicationRequest] R
    where R.status in { 'active' }
      and R.doNotPerform is true

define "Is Recommendation Applicable":
  "Inclusion Criteria"
    and not exists (
      "Active or Completed Communication"
        union "Communication Not Done"
    )
    and not exists (
      "Communication Proposal"
        union "Communication Prohibited"
        union "Communication Rejected"
    )

Content not shown - (application/elm+xml, size = 41Kb )

Content not shown - (application/elm+json, size = 74Kb )