FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example PlanDefinition/protocol-example (JSON)

Clinical Decision Support Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

Raw JSON (canonical form + also see JSON Format Specification)

Obesity Assessment Protocol

{
  "resourceType" : "PlanDefinition",
  "id" : "protocol-example",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\n      <p>\n    \n        <b>id: </b>example, \n      </p>\n\n  \n      <p>\n    \n        <b>identifier: </b>, \n        <b>system: </b>http://acme.org, \n        <b>value: </b>example-1, \n      </p>\n  \n      <p>\n    \n        <b>title: </b>Obesity Assessment Protocol, \n      </p>\n  \n      <p>\n    \n        <b>status: </b>draft, \n      </p>\n  \n      <p>\n    \n        <b>type: </b>condition, \n      </p>\n  \n      <p>\n    \n        <b>purpose: </b>Example of A medical algorithm for assessment and treatment of overweight and obesity, \n      </p>\n  \n      <p>\n    \n        <b>author: </b>, \n        <b>display: </b>National Heart, Lung, and Blood Institute http://www.nhlbi.nih.gov/health-pro/guidelines/current/obesity-guidelines/e_textbook/txgd/algorthm/algorthm.htm, \n      </p>\n  \n      <p>\n    \n        <b>step: </b>, \n        <b>name: </b>Measure BMI, \n        <b>description: </b>Measure, Weight, Height, Waist, Circumference; Calculate BMI  Weight must be measured so that the BMI can be calculated. Most charts are based on weights obtained with the patient wearing undergarments and no shoes. BMI can be manually calculated (kg/[height in meters]2), but is more easily obtained from a nomogram. Waist circumference is important because evidence suggests that abdominal fat is a particularly strong determinant of cardiovascular risk in those with a BMI of 25 to 34.9 kg/m2. Increased waist circumference can also be a marker of increased risk even in persons of normal weight. The technique for measuring waist circumference is described in the text. A nutrition assessment will also help to assess the diet and physical activity habits of overweight patients, \n        <b>precondition: </b>, \n        <b>union: </b>, \n        <b>description: </b>The practitioner must seek to determine whether the patient has ever been overweight. While a technical definition is provided, a simple question such as 'Have you ever been overweight?' will accomplish the same goal. Questions directed towards weight history, dietary habits, physical activities, and medications may provide useful information about the origins of obesity in particular patients., \n        <b>condition: </b>, \n        <b>type: </b>, \n        <b>coding: </b>, \n        <b>system: </b>http://acme.org, \n        <b>code: </b>1234, \n        <b>display: </b>Obesity, \n        <b>valueBoolean: </b>true, \n        <b>union: </b>, \n        <b>description: </b>BMI Measured in Past 2 Years  For those who have not been overweight, a 2 year interval is appropriate for the reassessment of BMI. While this time span is not evidence-based, it is believed to be a reasonable compromise between the need to identify weight gain at an early stage and the need to limit the time, effort, and cost of repeated measurements., \n        <b>condition: </b>, \n        <b>type: </b>, \n        <b>text: </b>BMI in last 2 years, \n        <b>valueBoolean: </b>false, \n        <b>activity: </b>, \n        <b>detail: </b>, \n        <b>category: </b>procedure, \n        <b>code: </b>, \n        <b>coding: </b>, \n        <b>system: </b>http://loinc.org, \n        <b>code: </b>39156-5, \n        <b>display: </b>Body mass index (BMI) [Ratio], \n        <b>performer: </b>, \n        <b>display: </b>Nurse Ratched, \n        <b>description: </b>Extra information on activity , \n      </p>\n    \n    </div>"
  },
  "contained" : [{
    "resourceType" : "ActivityDefinition",
    "id" : "procedure",
    "status" : "draft",
    "description" : "Extra information on activity ",
    "kind" : "ServiceRequest",
    "code" : {
      "coding" : [{
        "system" : "http://loinc.org",
        "code" : "39156-5",
        "display" : "Body mass index (BMI) [Ratio]"
      }]
    },
    "participant" : [{
      "type" : "practitioner",
      "role" : {
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/practitioner-role",
          "code" : "doctor",
          "display" : "Doctor"
        }]
      }
    }]
  }],
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "cds"
  }],
  "identifier" : [{
    "system" : "http://acme.org",
    "value" : "example-1"
  }],
  "name" : "ObesityAssessmentProtocol",
  "title" : "Obesity Assessment Protocol",
  "type" : {
    "coding" : [{
      "code" : "clinical-protocol"
    }]
  },
  "status" : "draft",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [{
    "telecom" : [{
      "system" : "url"
    }]
  }],
  "description" : "Obesity Assessment Protocol",
  "useContext" : [{
    "code" : {
      "code" : "focus"
    },
    "valueCodeableConcept" : {
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "414916001",
        "display" : "Obesity (disorder)"
      }]
    }
  }],
  "purpose" : "Example of A medical algorithm for assessment and treatment of overweight and obesity",
  "author" : [{
    "name" : "National Heart, Lung, and Blood Institute",
    "telecom" : [{
      "system" : "url",
      "value" : "https://www.nhlbi.nih.gov/health-pro/guidelines"
    }]
  }],
  "relatedArtifact" : [{
    "type" : "derived-from",
    "display" : "Overweight and Obesity Treatment Guidelines",
    "document" : {
      "url" : "http://www.nhlbi.nih.gov/health-pro/guidelines/current/obesity-guidelines/e_textbook/txgd/algorthm/algorthm.htm"
    }
  }],
  "goal" : [{
    "id" : "reduce-bmi-ratio",
    "category" : {
      "text" : "Treatment"
    },
    "description" : {
      "text" : "Reduce BMI to below 25"
    },
    "priority" : {
      "text" : "medium-priority"
    },
    "start" : {
      "text" : "When the patient's BMI Ratio is at or above 25"
    },
    "addresses" : [{
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "414916001",
        "display" : "Obesity (disorder)"
      }]
    }],
    "documentation" : [{
      "type" : "justification",
      "display" : "Evaluation and Treatment Strategy",
      "document" : {
        "url" : "https://www.nhlbi.nih.gov/health-pro/guidelines/current/obesity-guidelines/e_textbook/txgd/42.htm"
      }
    }],
    "target" : [{
      "measure" : {
        "coding" : [{
          "system" : "http://loinc.org",
          "code" : "39156-5",
          "display" : "Body mass index (BMI) [Ratio]"
        }]
      },
      "detailRange" : {
        "high" : {
          "value" : 24.9,
          "unit" : "kg/m2"
        }
      },
      "due" : {
        "value" : 1,
        "unit" : "a"
      }
    }]
  }],
  "action" : [{
    "title" : "Measure BMI",
    "description" : "Measure, Weight, Height, Waist, Circumference; Calculate BMI",
    "textEquivalent" : "Weight must be measured so that the BMI can be calculated. Most charts are based on weights obtained with the patient wearing undergarments and no shoes. BMI can be manually calculated (kg/[height in meters]2), but is more easily obtained from a nomogram. Waist circumference is important because evidence suggests that abdominal fat is a particularly strong determinant of cardiovascular risk in those with a BMI of 25 to 34.9 kg/m2. Increased waist circumference can also be a marker of increased risk even in persons of normal weight. The technique for measuring waist circumference is described in the text. A nutrition assessment will also help to assess the diet and physical activity habits of overweight patients",
    "goalId" : ["reduce-bmi-ratio"],
    "condition" : [{
      "kind" : "applicability",
      "expression" : {
        "description" : "The practitioner must seek to determine whether the patient has ever been overweight. While a technical definition is provided, a simple question such as 'Have you ever been overweight?' will accomplish the same goal. Questions directed towards weight history, dietary habits, physical activities, and medications may provide useful information about the origins of obesity in particular patients.  For those who have not been overweight, a 2 year interval is appropriate for the reassessment of BMI. While this time span is not evidence-based, it is believed to be a reasonable compromise between the need to identify weight gain at an early stage and the need to limit the time, effort, and cost of repeated measurements.",
        "language" : "text/cql",
        "expression" : "exists ([Condition: Obesity]) or not exists ([Observation: BMI] O where O.effectiveDateTime 2 years or less before Today())"
      }
    }],
    "requiredBehavior" : "must-unless-documented",
    "cardinalityBehavior" : "single",
    "definitionCanonical" : "#procedure"
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.