STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Protocol-example.json

Raw JSON (canonical form)

General Protocol Example

{
  "resourceType": "Protocol",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div>\n<p>\n\t\t<b>id: </b>example, </p>\n\t\n\t<p>\n\t\t<b>identifier: </b>, <b>system: </b>http://acme.org, <b>value: </b>example-1, </p>\n\t<p>\n\t\t<b>title: </b>Obesity Assessment Protocol, </p>\n\t<p>\n\t\t<b>status: </b>draft, </p>\n\t<p>\n\t\t<b>type: </b>condition, </p>\n\t<p>\n\t\t<b>purpose: </b>Example of A medical algorithm for assessment and treatment of overweight and obesity, </p>\n\t<p>\n\t\t<b>author: </b>, <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, </p>\n\t<p>\n\t\t<b>step: </b>, <b>name: </b>Measure BMI, <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, <b>precondition: </b>, <b>union: </b>, <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., <b>condition: </b>, <b>type: </b>, <b>coding: </b>, <b>system: </b>http://acme.org, <b>code: </b>1234, <b>display: </b>Obesity, <b>valueBoolean: </b>true, <b>union: </b>, <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., <b>condition: </b>, <b>type: </b>, <b>text: </b>BMI in last 2 years, <b>valueBoolean: </b>false, <b>activity: </b>, <b>detail: </b>, <b>category: </b>procedure, <b>code: </b>, <b>coding: </b>, <b>system: </b>http://loinc.org, <b>code: </b>39156-5, <b>display: </b>Body mass index (BMI) [Ratio], <b>performer: </b>, <b>display: </b>Nurse Ratched, <b>description: </b>Extra information on activity , </p>\n\t\t</div>"
  },
  "identifier": [
    {
      "system": "http://acme.org",
      "value": "example-1"
    }
  ],
  "title": "Obesity Assessment Protocol",
  "status": "draft",
  "_status": {
    "fhir_comments": [
      " The status of the protocol.draft | testing | review | active | withdrawn | superseded "
    ]
  },
  "type": "condition",
  "_type": {
    "fhir_comments": [
      " A code that classifies the general type of context to which these behavior definitions apply. This is used for searching, sorting and display purposes. "
    ]
  },
  "purpose": "Example of A medical algorithm for assessment and treatment of overweight and obesity",
  "_purpose": {
    "fhir_comments": [
      " When is the protocol to be used "
    ]
  },
  "author": {
    "fhir_comments": [
      " Who wrote the Protocol "
    ],
    "display": "National Heart, Lung, and Blood Institute http://www.nhlbi.nih.gov/health-pro/guidelines/current/obesity-guidelines/e_textbook/txgd/algorthm/algorthm.htm"
  },
  "step": [
    {
      "fhir_comments": [
        " \tThe meat of the protocol - a series of steps "
      ],
      "name": "Measure BMI",
      "_name": {
        "fhir_comments": [
          " step label "
        ]
      },
      "description": "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",
      "_description": {
        "fhir_comments": [
          " description of activity "
        ]
      },
      "precondition": {
        "fhir_comments": [
          " How long does each step last\n<duration></duration>\n ",
          " Rules prior to execution "
        ],
        "union": [
          {
            "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.",
            "condition": {
              "fhir_comments": [
                " condition evaluated\n "
              ],
              "type": {
                "fhir_comments": [
                  " The type of observation, test or other assertion being evaluated by the condition. "
                ],
                "coding": [
                  {
                    "system": "http://acme.org",
                    "code": "1234",
                    "display": "Obesity"
                  }
                ]
              },
              "valueBoolean": true,
              "_valueBoolean": {
                "fhir_comments": [
                  " Indicates what value the observation/test/assertion must have in order for the condition to be considered to be satisfied. "
                ]
              }
            }
          },
          {
            "description": "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.",
            "condition": {
              "fhir_comments": [
                " condition evaluated "
              ],
              "type": {
                "fhir_comments": [
                  " The type of observation, test or other assertion being evaluated by the condition. "
                ],
                "text": "BMI in last 2 years"
              },
              "valueBoolean": false,
              "_valueBoolean": {
                "fhir_comments": [
                  " Indicates what value the observation/test/assertion must have in order for the condition to be considered to be satisfied. "
                ]
              }
            }
          }
        ]
      },
      "activity": [
        {
          "fhir_comments": [
            " \tActivities that occur within timepoint "
          ],
          "detail": {
            "category": "procedure",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "39156-5",
                  "display": "Body mass index (BMI) [Ratio]"
                }
              ]
            },
            "performer": [
              {
                "fhir_comments": [
                  " \tWhen should this activity occur\n<timingCodeableConcept></timingCodeableConcept>\n\nWhere should it occur\n<location></location> ",
                  " Who should do this "
                ],
                "display": "Nurse Ratched"
              }
            ],
            "description": "Extra information on activity ",
            "_description": {
              "fhir_comments": [
                " What supplied or administiered if applicable and how much\n<product></product>\n<quantity></quantity>\n ",
                " Extra information on activity "
              ]
            }
          }
        }
      ]
    }
  ]
}

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.