Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example PlanDefinition/zika-virus-intervention (JSON)

Clinical Decision Support Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

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

Zika Virus Infection Management Process

{
  "resourceType": "PlanDefinition",
  "id": "zika-virus-intervention",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Id: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">PlanDefinition/zika-virus-intervention</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Identifier: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <b>value: </b>\n                  <span>zika-virus-intervention</span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Title: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">Example Zika Virus Intervention</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Status: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">active</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Description: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">Zika Virus Management intervention describing the CDC Guidelines for Zika Virus Reporting and Management.</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Topic: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <span>\n                     <b>text: </b>\n                     <span>Zika Virus Management</span>\n                  </span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Library: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <b>reference: </b>\n                  <span>Library/zika-virus-intervention-logic</span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <h2>Actions</h2>\n         <p style=\"width: 100%;\" class=\"hierarchy\">\n            <span>\n               <b>Step: </b>\n               <br/>\n               <span style=\"padding-left: 25px;\">\n                  <b>title: </b>\n                  <span>Zika Virus Assessment</span>\n                  <br/>\n               </span>\n               <span style=\"padding-left: 25px;\">\n                  <b>condition: </b>\n                  <br/>\n                  <span style=\"padding-left: 50px;\">\n                     <b>type: </b>\n                     <span>applicability</span>\n                     <br/>\n                  </span>\n                  <span style=\"padding-left: 50px;\">\n                     <b>expression: </b>\n                     <span>Is Patient Pregnant</span>\n                     <br/>\n                  </span>\n               </span>\n               <span style=\"padding-left: 25px;\">\n                  <span>\n                     <b>Step: </b>\n                     <br/>\n                     <span style=\"padding-left: 50px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 75px;\">\n                           <b>type: </b>\n                           <span>applicability</span>\n                           <br/>\n                        </span>\n                        <span style=\"padding-left: 75px;\">\n                           <b>expression: </b>\n                           <span>Should Administer Zika Virus Exposure Assessment</span>\n                           <br/>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 50px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 75px;\">\n                           <b>reference: </b>\n                           <br/>\n                           <span style=\"padding-left: 100px;\">#administer-zika-virus-exposure-assessment</span>\n                           <br/>\n                           <span>\n\t\t\t\t\t\t\t <span style=\"padding-left: 75px;\">\n\t\t\t\t\t\t\t\t<b>description: </b>\n\t\t\t\t\t\t\t\t<span>Administer Zika Virus Exposure Assessment</span>\n\t\t\t\t\t\t\t\t<br/>\n\t\t\t\t\t\t\t </span>\n\t\t\t\t\t\t\t <span style=\"padding-left: 75px;\">\n\t\t\t\t\t\t\t\t<b>category: </b>\n\t\t\t\t\t\t\t\t<span>procedure</span>\n\t\t\t\t\t\t\t\t<br/>\n\t\t\t\t\t\t\t </span>\n                           </span>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 50px;\"/>\n                  </span>\n                  <span>\n                     <b>Step: </b>\n                     <br/>\n                     <span style=\"padding-left: 75px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 100px;\">\n                           <b>type: </b>\n                           <span>applicability</span>\n                           <br/>\n                        </span>\n                        <span style=\"padding-left: 100px;\">\n                           <b>expression: </b>\n                           <span>Should Order Serum + Urine rRT-PCR Test</span>\n                           <br/>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 75px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 100px;\">\n                           <b>reference: </b>\n                           <br/>\n                           <span style=\"padding-left: 125px;\">ActivityDefinition/order-serum-urine-rrt-pcr-test</span>\n                           <br/>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 50px;\"/>\n                  </span>\n                  <span>\n                     <b>Step: </b>\n                     <br/>\n                     <span style=\"padding-left: 75px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 100px;\">\n                           <b>type: </b>\n                           <span>applicability</span>\n                           <br/>\n                        </span>\n                        <span style=\"padding-left: 100px;\">\n                           <b>expression: </b>\n                           <span>Should Order Serum Zika Virus IgM + Dengue Virus IgM</span>\n                           <br/>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 75px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 100px;\">\n                           <b>reference: </b>\n                           <br/>\n                           <span style=\"padding-left: 125px;\">#order-serum-zika-dengue-virus-igm</span>\n                           <br/>\n                           <span>\n                              <span style=\"padding-left: 50px;\">\n                                 <span style=\"padding-left: 50px;\">\n                                    <b>description: </b>\n                                    <span>Order Serum Zika and Dengue Virus IgM</span>\n                                    <br/>\n                                 </span>\n                                 <span style=\"padding-left: 75px;\">\n                                    <b>related:</b>\n                                    <br/>\n                                    <span style=\"padding-left: 100px;\">\n                                       <b>type: </b>\n                                       <span>documentation</span>\n                                       <br/>\n                                    </span>\n                                    <span style=\"padding-left: 100px;\">\n                                       <b>display: </b>\n                                       <span>Explanation of diagnostic tests for Zika virus and which to use based on the patients clinical and exposure history.</span>\n                                       <br/>\n                                    </span>\n                                 </span>\n                                 <span style=\"padding-left: 100px;\">\n                                    <b>category: </b>\n                                    <span>diagnostic</span>\n                                    <br/>\n                                 </span>\n                              </span>\n                           </span>\n                           <span/>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 50px;\"/>\n                  </span>\n                  <span>\n                     <b>Step: </b>\n                     <br/>\n                     <span style=\"padding-left: 75px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 100px;\">\n                           <b>type: </b>\n                           <span>applicability</span>\n                           <br/>\n                        </span>\n                        <span style=\"padding-left: 100px;\">\n                           <b>expression: </b>\n                           <span>Should Consider IgM Antibody Testing</span>\n                           <br/>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 75px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 100px;\">\n                           <b>reference: </b>\n                           <br/>\n                           <span style=\"padding-left: 125px;\">ActivityDefinition/consider-igm-antibody-testing</span>\n                           <br/>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 50px;\"/>\n                  </span>\n                  <span>\n                     <b>Step: </b>\n                     <br/>\n                     <span style=\"padding-left: 75px;\">\n                        <b>condition: </b>\n                        <br/>\n                        <span style=\"padding-left: 100px;\">\n                           <b>type: </b>\n                           <span>applicability</span>\n                           <br/>\n                        </span>\n                        <span style=\"padding-left: 100px;\">\n                           <b>expression: </b>\n                           <span>Should Provide Mosquito Prevention and Contraception Advice</span>\n                           <br/>\n                        </span>\n                     </span>\n                     <span style=\"padding-left: 50px;\">\n                        <span>\n                           <b>Step: </b>\n                           <br/>\n                           <span style=\"padding-left: 75px;\">\n                              <b>condition: </b>\n                              <br/>\n                              <span style=\"padding-left: 100px;\">\n                                 <b>reference: </b>\n                                 <br/>\n                                 <span style=\"padding-left: 125px;\">#provide-mosquito-prevention-advice</span>\n                                 <span>\n                                    <span style=\"padding-left: 75px;\">\n                                       <br/>\n                                       <span style=\"padding-left: 100px;\">\n                                          <b>description: </b>\n                                          <span>Provide mosquito prevention advice</span>\n                                          <br/>\n                                       </span>\n                                       <span style=\"padding-left: 75px;\">\n                                          <b>related:</b>\n                                          <br/>\n                                          <span style=\"padding-left: 100px;\">\n                                             <b>type: </b>\n                                             <span>documentation</span>\n                                             <br/>\n                                          </span>\n                                          <span style=\"padding-left: 100px;\">\n                                             <b>display: </b>\n                                             <span>Advice for patients about how to avoid Mosquito bites.</span>\n                                             <br/>\n                                          </span>\n                                       </span>\n                                       <span style=\"padding-left: 75px;\">\n                                          <b>related:</b>\n                                          <br/>\n                                          <span style=\"padding-left: 100px;\">\n                                             <b>type: </b>\n                                             <span>documentation</span>\n                                             <br/>\n                                          </span>\n                                          <span style=\"padding-left: 100px;\">\n                                             <b>display: </b>\n                                             <span>Advice for patients about which mosquito repellents are effective and safe to use in pregnancy. [DEET, IF3535 and Picardin are safe during]</span>\n                                             <br/>\n                                          </span>\n                                       </span>\n                                       <span style=\"padding-left: 100px;\">\n                                          <b>category: </b>\n                                          <span>communication</span>\n                                          <br/>\n                                       </span>\n                                    </span>\n                                 </span>\n                              </span>\n                           </span>\n                           <span style=\"padding-left: 75px;\"/>\n                        </span>\n                        <span>\n                           <b>Step: </b>\n                           <br/>\n                           <span style=\"padding-left: 75px;\">\n                              <b>condition: </b>\n                              <br/>\n                              <span style=\"padding-left: 100px;\">\n                                 <b>reference: </b>\n                                 <br/>\n                                 <span style=\"padding-left: 125px;\">ActivityDefinition/provide-contraception-advice</span>\n                                 <br/>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </span>\n               </span>\n            </span>\n         </p>\n      </div>"
  },
  "url": "http://example.org/PlanDefinition/zika-virus-intervention",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.11.5"
    },
    {
      "use": "official",
      "value": "zika-virus-intervention"
    }
  ],
  "version": "2.0.0",
  "title": "Example Zika Virus Intervention",
  "status": "active",
  "date": "2017-01-12",
  "description": "Zika Virus Management intervention describing the CDC Guidelines for Zika Virus Reporting and Management.",
  "useContext": [
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "age"
      },
      "valueRange": {
        "low": {
          "value": 12,
          "unit": "a"
        }
      }
    },
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "user"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "309343006",
            "display": "Physician"
          }
        ]
      }
    }
  ],
  "topic": [
    {
      "text": "Zika Virus Management"
    }
  ],
  "relatedArtifact": [
    {
      "type": "derived-from",
      "document": {
        "url": "https://www.cdc.gov/mmwr/volumes/65/wr/mm6539e1.htm?s_cid=mm6539e1_w"
      }
    },
    {
      "type": "predecessor",
      "resource": "http://example.org/fhir/PlanDefinition/zika-virus-intervention-initial"
    }
  ],
  "library": [
    "http://example.org/fhir/Library/zika-virus-intervention-logic"
  ],
  "action": [
    {
      "title": "Zika Virus Assessment",
      "trigger": [
        {
          "type": "named-event",
          "name": "patient-view"
        }
      ],
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "language": "text/cql",
            "expression": "Is Patient Pregnant"
          }
        }
      ],
      "action": [
        {
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql",
                "expression": "Should Administer Zika Virus Exposure Assessment"
              }
            }
          ],
          "definitionCanonical": "http://example.org/fhir/ActivityDefinition/administer-zika-virus-exposure-assessment"
        },
        {
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql",
                "expression": "Should Order Serum + Urine rRT-PCR Test"
              }
            }
          ],
          "definitionCanonical": "http://example.org/fhir/ActivityDefinition/order-serum-urine-rrt-pcr-test"
        },
        {
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql",
                "expression": "Should Order Serum Zika Virus IgM + Dengue Virus IgM"
              }
            }
          ],
          "definitionCanonical": "http://example.org/fhir/ActivityDefinition/order-serum-zika-dengue-virus-igm"
        },
        {
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql",
                "expression": "Should Consider IgM Antibody Testing"
              }
            }
          ],
          "definitionCanonical": "http://example.org/fhir/ActivityDefinition/consider-igm-antibody-testing"
        },
        {
          "condition": [
            {
              "kind": "applicability",
              "expression": {
                "language": "text/cql",
                "expression": "Should Provide Mosquito Prevention and Contraception Advice"
              }
            }
          ],
          "action": [
            {
              "definitionCanonical": "http://example.org/fhir/ActivityDefinition/provide-mosquito-prevention-advice"
            },
            {
              "definitionCanonical": "http://example.org/fhir/ActivityDefinition/provide-contraception-advice"
            }
          ]
        }
      ]
    }
  ]
}

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.