Clinical Practice Guidelines Example Implementation Guide - Chronic Kidney Disease
1.0.0 - ci-build International flag

Clinical Practice Guidelines Example Implementation Guide - Chronic Kidney Disease, published by HL7 International - Clinical Decision Support WG. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cqframework/cpg-example-ckd/ and changes regularly. See the Directory of published versions

: Chronic Kidney Disease (CKD) risk screening Plan Definition - JSON Representation

Active as of 2024-11-18

Raw json | Download

{
  "resourceType" : "PlanDefinition",
  "id" : "ckd-risk-screening",
  "meta" : {
    "profile" : [
      🔗 "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-recommendationdefinition"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: PlanDefinition ckd-risk-screening</b></p><a name=\"ckd-risk-screening\"> </a><a name=\"hcckd-risk-screening\"> </a><a name=\"ckd-risk-screening-en-US\"> </a><p><b>CQF Knowledge capability</b>: shareable</p><p><b>CQF Knowledge capability</b>: computable</p><p><b>CQF Knowledge capability</b>: publishable</p><p><b>CQF knowledge representation level</b>: structured</p><p><b>url</b>: <a href=\"PlanDefinition-ckd-risk-screening.html\">PlanDefinition Chronic Kidney Disease (CKD) risk screening Plan Definition</a></p><p><b>version</b>: 1.0.0</p><p><b>name</b>: CKDRiskScreening</p><p><b>title</b>: Chronic Kidney Disease (CKD) risk screening Plan Definition</p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/plan-definition-type eca-rule}\">ECA Rule</span></p><p><b>status</b>: Active</p><p><b>experimental</b>: true</p><p><b>date</b>: 2024-11-18 18:20:09+0000</p><p><b>publisher</b>: HL7 International - Clinical Decision Support WG</p><p><b>contact</b>: HL7 International - Clinical Decision Support WG: <a href=\"http://www.hl7.org/Special/committees/dss/index.cfm\">http://www.hl7.org/Special/committees/dss/index.cfm</a></p><p><b>description</b>: </p><div><p>Chronic Kidney Disease (CKD) risk screening</p>\n</div><h3>UseContexts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-usage-context-type.html#usage-context-type-focus\">UsageContextType focus</a>: Clinical Focus</td><td><span title=\"Codes:{http://snomed.info/sct 709044004}\">Chronic kidney disease (disorder)</span></td></tr></table><p><b>jurisdiction</b>: <span title=\"Codes:{http://unstats.un.org/unsd/methods/m49/m49.htm 001}\">World</span></p><p><b>topic</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/definition-topic treatment}\">Treatment</span></p><p><b>library</b>: <a href=\"Library-CKDRiskLogic.html\">Chronic Kidney Disease (CKD) risk screening logic</a></p><blockquote><p><b>action</b></p><h3>Triggers</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Name</b></td></tr><tr><td style=\"display: none\">*</td><td>Named Event</td><td>patient-view</td></tr></table><blockquote><p><b>condition</b></p><p><b>kind</b>: Applicability</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>Has CKD or Diabetes</td></tr></table></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Order Renal Lab Panel</p><p><b>description</b>: Order full renal lab panel, eGFR or UCAR indicates risk.</p><blockquote><p><b>documentation</b></p><p><b>type</b>: Documentation</p><p><b>display</b>: NIDDK Quick Reference on UACR &amp; GFR</p><p><b>url</b>: <a href=\"https://www.niddk.nih.gov/health-information/professionals/clinical-tools-patient-education-outreach/quick-reference-uacr-gfr\">https://www.niddk.nih.gov/health-information/professionals/clinical-tools-patient-education-outreach/quick-reference-uacr-gfr</a></p><h3>Documents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"https://www.niddk.nih.gov/health-information/professionals/clinical-tools-patient-education-outreach/quick-reference-uacr-gfr\">https://www.niddk.nih.gov/health-information/professionals/clinical-tools-patient-education-outreach/quick-reference-uacr-gfr</a></td></tr></table></blockquote><blockquote><p><b>condition</b></p><p><b>kind</b>: Applicability</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>Needs eGFR Lab</td></tr></table></blockquote><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/action-type create}\">Create</span></p><p><b>definition</b>: <a href=\"ActivityDefinition-ckd-risk-renal-lab-order.html\">Order Renal Lab Panel Activity Definition</a></p><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: action.description</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>NeedsGFRDetail</td></tr></table></blockquote><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: activity.extension</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>NeedsGFRSeverity</td></tr></table></blockquote></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: 2-year Kidney Failure Risk</p><blockquote><p><b>documentation</b></p><p><b>type</b>: Documentation</p><p><b>display</b>: Kidney Failure Risk Equation</p><p><b>url</b>: <a href=\"http://kidneyfailurerisk.com/#about-the-equation\">http://kidneyfailurerisk.com/#about-the-equation</a></p><h3>Documents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"http://kidneyfailurerisk.com/#about-the-equation\">http://kidneyfailurerisk.com/#about-the-equation</a></td></tr></table></blockquote><blockquote><p><b>condition</b></p><p><b>kind</b>: Applicability</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>Has Abnormal eGFR</td></tr></table></blockquote><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: action.description</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>2-YearRiskDetail</td></tr></table></blockquote><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: activity.extension</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>2-YearRiskSeverity</td></tr></table></blockquote></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: 5-year Kidney Failure Risk</p><blockquote><p><b>documentation</b></p><p><b>type</b>: Documentation</p><p><b>display</b>: Kidney Failure Risk Equation</p><p><b>url</b>: <a href=\"http://kidneyfailurerisk.com/#about-the-equation\">http://kidneyfailurerisk.com/#about-the-equation</a></p><h3>Documents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"http://kidneyfailurerisk.com/#about-the-equation\">http://kidneyfailurerisk.com/#about-the-equation</a></td></tr></table></blockquote><blockquote><p><b>condition</b></p><p><b>kind</b>: Applicability</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>Has Abnormal eGFR</td></tr></table></blockquote><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: action.description</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>5-YearRiskDetail</td></tr></table></blockquote><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: activity.extension</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>5-YearRiskSeverity</td></tr></table></blockquote></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Recommend Nephrology Referral</p><blockquote><p><b>documentation</b></p><p><b>type</b>: Documentation</p><p><b>display</b>: National Kidney Disease Education Program</p><p><b>url</b>: <a href=\"https://www.niddk.nih.gov/health-information/communication-programs/nkdep\">https://www.niddk.nih.gov/health-information/communication-programs/nkdep</a></p><h3>Documents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"https://www.niddk.nih.gov/health-information/communication-programs/nkdep\">https://www.niddk.nih.gov/health-information/communication-programs/nkdep</a></td></tr></table></blockquote><blockquote><p><b>condition</b></p><p><b>kind</b>: Applicability</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>Recommend Nephrology Referral</td></tr></table></blockquote><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/action-type create}\">Create</span></p><p><b>definition</b>: <a href=\"ActivityDefinition-ckd-risk-referral-nephrology.html\">Referral to Nephrologist Activity Definition</a></p><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: action.description</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>NephrologyReferralDetail</td></tr></table></blockquote><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: activity.extension</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>CQL</td><td>NephrologyReferralSeverity</td></tr></table></blockquote></blockquote></blockquote></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability",
      "valueCode" : "shareable"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability",
      "valueCode" : "computable"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability",
      "valueCode" : "publishable"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel",
      "valueCode" : "structured"
    }
  ],
  "url" : "http://cqframework.org/cpg-example-ckd/PlanDefinition/ckd-risk-screening",
  "version" : "1.0.0",
  "name" : "CKDRiskScreening",
  "title" : "Chronic Kidney Disease (CKD) risk screening Plan Definition",
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code" : "eca-rule",
        "display" : "ECA Rule"
      }
    ]
  },
  "status" : "active",
  "experimental" : true,
  "date" : "2024-11-18T18:20:09+00:00",
  "publisher" : "HL7 International - Clinical Decision Support WG",
  "contact" : [
    {
      "name" : "HL7 International - Clinical Decision Support WG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
        }
      ]
    }
  ],
  "description" : "Chronic Kidney Disease (CKD) risk screening",
  "useContext" : [
    {
      "code" : {
        "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code" : "focus",
        "display" : "Clinical Focus"
      },
      "valueCodeableConcept" : {
        "coding" : [
          {
            "system" : "http://snomed.info/sct",
            "code" : "709044004",
            "display" : "Chronic kidney disease (disorder)"
          }
        ]
      }
    }
  ],
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "topic" : [
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/definition-topic",
          "code" : "treatment",
          "display" : "Treatment"
        }
      ]
    }
  ],
  "library" : [
    🔗 "http://cqframework.org/cpg-example-ckd/Library/CKDRiskLogic"
  ],
  "action" : [
    {
      "trigger" : [
        {
          "type" : "named-event",
          "name" : "patient-view"
        }
      ],
      "condition" : [
        {
          "kind" : "applicability",
          "expression" : {
            "language" : "text/cql",
            "expression" : "Has CKD or Diabetes"
          }
        }
      ],
      "action" : [
        {
          "title" : "Order Renal Lab Panel",
          "description" : "Order full renal lab panel, eGFR or UCAR indicates risk.",
          "documentation" : [
            {
              "type" : "documentation",
              "display" : "NIDDK Quick Reference on UACR & GFR",
              "url" : "https://www.niddk.nih.gov/health-information/professionals/clinical-tools-patient-education-outreach/quick-reference-uacr-gfr",
              "document" : {
                "url" : "https://www.niddk.nih.gov/health-information/professionals/clinical-tools-patient-education-outreach/quick-reference-uacr-gfr"
              }
            }
          ],
          "condition" : [
            {
              "kind" : "applicability",
              "expression" : {
                "language" : "text/cql",
                "expression" : "Needs eGFR Lab"
              }
            }
          ],
          "type" : {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/action-type",
                "code" : "create"
              }
            ]
          },
          "definitionCanonical" : "http://cqframework.org/cpg-example-ckd/ActivityDefinition/ckd-risk-renal-lab-order",
          "dynamicValue" : [
            {
              "path" : "action.description",
              "expression" : {
                "language" : "text/cql",
                "expression" : "NeedsGFRDetail"
              }
            },
            {
              "path" : "activity.extension",
              "expression" : {
                "language" : "text/cql",
                "expression" : "NeedsGFRSeverity"
              }
            }
          ]
        },
        {
          "title" : "2-year Kidney Failure Risk",
          "documentation" : [
            {
              "type" : "documentation",
              "display" : "Kidney Failure Risk Equation",
              "url" : "http://kidneyfailurerisk.com/#about-the-equation",
              "document" : {
                "url" : "http://kidneyfailurerisk.com/#about-the-equation"
              }
            }
          ],
          "condition" : [
            {
              "kind" : "applicability",
              "expression" : {
                "language" : "text/cql",
                "expression" : "Has Abnormal eGFR"
              }
            }
          ],
          "dynamicValue" : [
            {
              "path" : "action.description",
              "expression" : {
                "language" : "text/cql",
                "expression" : "2-YearRiskDetail"
              }
            },
            {
              "path" : "activity.extension",
              "expression" : {
                "language" : "text/cql",
                "expression" : "2-YearRiskSeverity"
              }
            }
          ]
        },
        {
          "title" : "5-year Kidney Failure Risk",
          "documentation" : [
            {
              "type" : "documentation",
              "display" : "Kidney Failure Risk Equation",
              "url" : "http://kidneyfailurerisk.com/#about-the-equation",
              "document" : {
                "url" : "http://kidneyfailurerisk.com/#about-the-equation"
              }
            }
          ],
          "condition" : [
            {
              "kind" : "applicability",
              "expression" : {
                "language" : "text/cql",
                "expression" : "Has Abnormal eGFR"
              }
            }
          ],
          "dynamicValue" : [
            {
              "path" : "action.description",
              "expression" : {
                "language" : "text/cql",
                "expression" : "5-YearRiskDetail"
              }
            },
            {
              "path" : "activity.extension",
              "expression" : {
                "language" : "text/cql",
                "expression" : "5-YearRiskSeverity"
              }
            }
          ]
        },
        {
          "title" : "Recommend Nephrology Referral",
          "documentation" : [
            {
              "type" : "documentation",
              "display" : "National Kidney Disease Education Program",
              "url" : "https://www.niddk.nih.gov/health-information/communication-programs/nkdep",
              "document" : {
                "url" : "https://www.niddk.nih.gov/health-information/communication-programs/nkdep"
              }
            }
          ],
          "condition" : [
            {
              "kind" : "applicability",
              "expression" : {
                "language" : "text/cql",
                "expression" : "Recommend Nephrology Referral"
              }
            }
          ],
          "type" : {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/action-type",
                "code" : "create"
              }
            ]
          },
          "definitionCanonical" : "http://cqframework.org/cpg-example-ckd/ActivityDefinition/ckd-risk-referral-nephrology",
          "dynamicValue" : [
            {
              "path" : "action.description",
              "expression" : {
                "language" : "text/cql",
                "expression" : "NephrologyReferralDetail"
              }
            },
            {
              "path" : "activity.extension",
              "expression" : {
                "language" : "text/cql",
                "expression" : "NephrologyReferralSeverity"
              }
            }
          ]
        }
      ]
    }
  ]
}