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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cpg/Library/generatereport-library | Version: 2.0.0 | |||
| Active as of 2024-11-26 | Computable Name: GenerateReportLibrary | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.28.10 | ||||
Logic for an example recommendation to generate a report
Generated Narrative: Library generatereport-library
| Depends On | Code System Activity Type | CPG Activity Type Code System | 
| reportWith | in | 0 | 1 | string | 
| Patient | out | 0 | 1 | Patient | 
| Inclusion Criteria | out | 0 | 1 | boolean | 
| Generation Task | out | 0 | * | Task | 
| Generated Report | out | 0 | * | MeasureReport | 
| Active or Completed Activity | out | 0 | * | Task | 
| Activity Not Done | out | 0 | * | Task | 
| Activity Proposal | out | 0 | * | Task | 
| Activity Proposal Rejected | out | 0 | * | Task | 
| Is Recommendation Applicable | out | 0 | 1 | boolean | 
| Type: Task (Task) | 
| Type: MeasureReport (MeasureReport) | 
text/cql
library GenerateReport
using FHIR version '4.0.1'
include FHIRHelpers version '4.0.1'
codesystem "Activity Type": 'http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs'
code "Generate report": 'generate-report' from "Activity Type"
parameter reportWith String
context Patient
/* Recommendation to generate a report */
/*
NOTE: This recommendation is dramatically simplified to illustrate the general
pattern for a positive recommendation to enroll a patient, with the ability
for users to reject the recommendation, and flexibility in how the recommendation
is achieved.
Specifically:
* There is no terminology, any task on any topic will do
* There is no timing, any task 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 activity.
*/
/*
Positive recommendation:
If the patient meets the inclusion criteria
  If the report has not been generated
    If report generation has not been planned or proposed
      Propose report generation
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 "Generation Task":
  [Task] C
    where C.code ~ "Generate report"
      and reportWith(C) = reportWith
      and doNotPerform(C) is not true
define "Generated Report":
  [MeasureReport] R
    where R.measure = reportWith
define "Active or Completed Activity":
  "Generation Task" C
    where C.status in { 'in-progress', 'on-hold', 'completed' }
define "Activity Not Done":
  "Generation Task" C
    where C.status in { 'cancelled', 'failed' }
define "Activity Proposal":
  "Generation Task" R
    where R.status in { 'draft', 'requested', 'received', 'accepted', 'ready' }
define "Activity Proposal Rejected":
  "Generation Task" R
    where R.status in { 'rejected' }
define "Is Recommendation Applicable":
  "Inclusion Criteria"
    and not exists ("Generated Report")
    and not exists (
      "Active or Completed Activity"
        union "Activity Not Done"
    )
    and not exists (
      "Activity Proposal"
        union "Activity Proposal Rejected"
    )
define function doNotPerform(task Task):
  singleton from (
    task.extension E
      where E.url = 'http://hl7.org/fhir/StructureDefinition/request-doNotPerform'
  ).value as boolean
define function reportWith(task Task):
  singleton from (
    task.input I
      where I.type ~ "Generate report"
  ).value as canonical
Content not shown - (application/elm+xml, size = 41Kb )
Content not shown - (application/elm+json, size = 74Kb )