PlanDefinition - FHIR Resource (stu3)


This PlanDefinition Resource uses the FHIR API standard for access and structure.

Validate an PlanDefinition FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
actiontrueData Type# Action defined by the plan
approvalDatefalsedate# When the plan definition was approved by publisher
contacttrueContactDetail# Contact details for the publisher
contributortrueContributor# A content contributor
copyrightfalsemarkdown# Use and/or publishing restrictions
datefalsedateTime# Date this was last changed
descriptionfalsemarkdown# Natural language description of the plan definition
effectivePeriodfalsePeriod# When the plan definition is expected to be used
experimentalfalseboolean# For testing purposes, not real usage
goaltrueData Type# What the plan is trying to accomplish
identifiertrueIdentifier# Additional identifier for the plan definition
jurisdictiontrueCodeableConcept# Intended jurisdiction for plan definition (if applicable)
lastReviewDatefalsedate# When the plan definition was last reviewed
librarytrueReference# Logic used by the plan definition
namefalsestring# Name for this plan definition (computer friendly)
publisherfalsestring# Name of the publisher (organization or individual)
purposefalsemarkdown# Why this plan definition is defined
relatedArtifacttrueRelatedArtifact# Related artifacts for the asset
statusfalsecode# draft | active | retired | unknown
titlefalsestring# Name for this plan definition (human friendly)
topictrueCodeableConcept# E.g. Education, Treatment, Assessment, etc
typefalseCodeableConcept# order-set | protocol | eca-rule
urlfalseuri# Logical URI to reference this plan definition (globally unique)
usagefalsestring# Describes the clinical usage of the asset
useContexttrueUsageContext# Context the content is intended to support
versionfalsestring# Business version of the plan definition

PlanDefinition Example

{
  "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/low-suicide-risk-order-set</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>mmi:low-suicide-risk-order-set</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;\">Low Suicide Risk Order Set</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;\">draft</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;\">Orders to be applied to a patient characterized as low suicide risk.</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Purpose: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">This order set helps ensure consistent application of appropriate orders for the care of low suicide risk patients.</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Usage: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">This order set should be applied after assessing a patient for suicide risk, when the findings of that assessment indicate the patient has low suicide risk.</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Context: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-right: 25px;\">\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>system: </b>\n                     <span>http://hl7.org/fhir/usage-context-type</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>code: </b>\n                     <span>age</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>value: </b>\n                     <br/>\n                     <span>\n                        <span>\n                           <span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>system: </b>\n                                 <span>https://meshb.nlm.nih.gov</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>code: </b>\n                                 <span>D000328</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>display: </b>\n                                 <span>Adult</span>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </p>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Context: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-right: 25px;\">\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>system: </b>\n                     <span>http://hl7.org/fhir/usage-context-type</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>code: </b>\n                     <span>focus</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>value: </b>\n                     <br/>\n                     <span>\n                        <span>\n                           <span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>system: </b>\n                                 <span>http://snomed.info/sct</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>code: </b>\n                                 <span>87512008</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>display: </b>\n                                 <span>Mild major depression</span>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </p>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Context: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-right: 25px;\">\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>system: </b>\n                     <span>http://hl7.org/fhir/usage-context-type</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>code: </b>\n                     <span>focus</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>value: </b>\n                     <br/>\n                     <span>\n                        <span>\n                           <span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>system: </b>\n                                 <span>http://snomed.info/sct</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>code: </b>\n                                 <span>40379007</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>display: </b>\n                                 <span>Major depression, recurrent, mild</span>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </p>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Context: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-right: 25px;\">\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>system: </b>\n                     <span>http://hl7.org/fhir/usage-context-type</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>code: </b>\n                     <span>focus</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>value: </b>\n                     <br/>\n                     <span>\n                        <span>\n                           <span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>system: </b>\n                                 <span>http://snomed.info/sct</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>code: </b>\n                                 <span>394687007</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>display: </b>\n                                 <span>Low suicide risk</span>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </p>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Context: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-right: 25px;\">\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>system: </b>\n                     <span>http://hl7.org/fhir/usage-context-type</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>code: </b>\n                     <span>focus</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>value: </b>\n                     <br/>\n                     <span>\n                        <span>\n                           <span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>system: </b>\n                                 <span>http://snomed.info/sct</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>code: </b>\n                                 <span>225337009</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>display: </b>\n                                 <span>Suicide risk assessment</span>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </p>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Context: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-right: 25px;\">\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>system: </b>\n                     <span>http://hl7.org/fhir/usage-context-type</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>code: </b>\n                     <span>user</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>value: </b>\n                     <br/>\n                     <span>\n                        <span>\n                           <span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>system: </b>\n                                 <span>http://snomed.info/sct</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>code: </b>\n                                 <span>309343006</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>display: </b>\n                                 <span>Physician</span>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </p>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Context: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-right: 25px;\">\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>system: </b>\n                     <span>http://hl7.org/fhir/usage-context-type</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>code: </b>\n                     <span>venue</span>\n                  </p>\n                  <p style=\"padding-left: 25px; margin-top: 5px; margin-bottom: 5px;\">\n                     <b>value: </b>\n                     <br/>\n                     <span>\n                        <span>\n                           <span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>system: </b>\n                                 <span>http://snomed.info/sct</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>code: </b>\n                                 <span>440655000</span>\n                                 <br/>\n                              </span>\n                              <span style=\"padding-left: 25px;\">\n                                 <b>display: </b>\n                                 <span>Outpatient environment</span>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </p>\n               </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>Suicide risk assessment</span>\n                  </span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Contributor: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <b>\n                     <span>author</span>:\n                  </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 50px; padding-right: 25px;\">Motive Medical Intelligence</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/suiciderisk-orderset-logic</span>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <b>display: </b>\n                  <span>SuicideRiskLogic</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>Suicide Risk Assessment and Outpatient Management</span>\n                  <br/>\n               </span>\n               <span style=\"padding-left: 25px;\">\n                  <span>\n                     <b>Step: </b>\n                     <br/>\n                     <span style=\"padding-left: 50px;\">\n                        <b>title: </b>\n                        <span>Consults and Referrals</span>\n                        <br/>\n                     </span>\n                     <span style=\"padding-left: 50px;\">\n                        <span>\n                           <b>Step: </b>\n                           <br/>\n                           <span style=\"padding-left: 75px;\">\n                              <b>text: </b>\n                              <span>Refer to outpatient mental health program for evaluation and treatment of mental health conditions now</span>\n                              <br/>\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;\">#referralToMentalHealthCare</span>\n                                 <span>\n                                    <span style=\"padding-left: 75px;\">\n                                       <br/>\n                                       <span style=\"padding-left: 100px;\">\n                                          <b>description: </b>\n                                          <span>refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now</span>\n                                          <br/>\n                                       </span>\n                                       <span style=\"padding-left: 100px;\">\n                                          <b>category: </b>\n                                          <span>referral</span>\n                                          <br/>\n                                       </span>\n                                    </span>\n                                 </span>\n                              </span>\n                           </span>\n                           <span style=\"padding-left: 50px;\"/>\n                        </span>\n                     </span>\n                  </span>\n                  <span>\n                     <b>Step: </b>\n                     <br/>\n                     <span style=\"padding-left: 50px;\">\n                        <b>title: </b>\n                        <span>Medications</span>\n                        <br/>\n                     </span>\n                     <span style=\"padding-left: 50px;\">\n                        <span>\n                           <b>Step: </b>\n                           <br/>\n                           <span style=\"padding-left: 75px;\">\n                              <b>title: </b>\n                              <span>First-Line Antidepressants</span>\n                              <br/>\n                           </span>\n                           <span style=\"padding-left: 75px;\">\n                              <span>\n                                 <b>Step: </b>\n                                 <br/>\n                                 <span style=\"padding-left: 100px;\">\n                                    <b>title: </b>\n                                    <span>Selective Serotonin Reuptake Inhibitors (Choose a mazimum of one or document reasons for exception)</span>\n                                    <br/>\n                                 </span>\n                                 <span style=\"padding-left: 100px;\">\n                                    <span>\n                                       <b>Step: </b>\n                                       <br/>\n                                       <span style=\"padding-left: 125px;\">\n                                          <b>text: </b>\n                                          <span>citalopram 20 mg tablet 1 tablet oral 1 time daily now (30 table; 3 refills)</span>\n                                          <br/>\n                                       </span>\n                                       <span style=\"padding-left: 125px;\">\n                                          <b>condition: </b>\n                                          <br/>\n                                          <span style=\"padding-left: 150px;\">\n                                             <b>reference: </b>\n                                             <br/>\n                                             <span style=\"padding-left: 175px;\">#citalopramPrescription</span>\n                                             <span/>\n                                             <span>\n                                                <span style=\"padding-left: 125px;\">\n                                                   <br/>\n                                                   <span style=\"padding-left: 150px;\">\n                                                      <b>category: </b>\n                                                      <span>drug</span>\n                                                      <br/>\n                                                   </span>\n                                                </span>\n                                             </span>\n                                             <span/>\n                                             <span/>\n                                          </span>\n                                       </span>\n                                       <span style=\"padding-left: 100px;\"/>\n                                    </span>\n                                    <span>\n                                       <b>Step: </b>\n                                       <br/>\n                                       <span style=\"padding-left: 125px;\">\n                                          <b>text: </b>\n                                          <span>escitalopram 10 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)</span>\n                                          <br/>\n                                       </span>\n                                       <span style=\"padding-left: 100px;\"/>\n                                    </span>\n                                    <span>\n                                       <b>Step: </b>\n                                       <br/>\n                                       <span style=\"padding-left: 125px;\">\n                                          <b>text: </b>\n                                          <span>fluoxetine 20 mg capsule 1 capsule oral 1 time daily now (30 tablet; 3 refills)</span>\n                                          <br/>\n                                       </span>\n                                       <span style=\"padding-left: 100px;\"/>\n                                    </span>\n                                    <span>\n                                       <b>Step: </b>\n                                       <br/>\n                                       <span style=\"padding-left: 125px;\">\n                                          <b>text: </b>\n                                          <span>paroxetine 20 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)</span>\n                                          <br/>\n                                       </span>\n                                       <span style=\"padding-left: 100px;\"/>\n                                    </span>\n                                    <span>\n                                       <b>Step: </b>\n                                       <br/>\n                                       <span style=\"padding-left: 125px;\">\n                                          <b>text: </b>\n                                          <span>sertraline 50 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)</span>\n                                          <br/>\n                                       </span>\n                                       <span style=\"padding-left: 100px;\"/>\n                                    </span>\n                                 </span>\n                              </span>\n                              <span>\n                                 <b>Step: </b>\n                                 <br/>\n                                 <span style=\"padding-left: 125px;\">\n                                    <b>text: </b>\n                                    <span>Dopamine Norepinephrine Reuptake Inhibitors (Choose a maximum of one or document reasons for exception)</span>\n                                    <br/>\n                                 </span>\n                                 <span style=\"padding-left: 75px;\"/>\n                              </span>\n                              <span>\n                                 <b>Step: </b>\n                                 <br/>\n                                 <span style=\"padding-left: 100px;\">\n                                    <b>text: </b>\n                                    <span>Serotonin Norepinephrine Reuptake Inhibitors (Choose a maximum of one or doument reasons for exception)</span>\n                                    <br/>\n                                 </span>\n                                 <span style=\"padding-left: 75px;\"/>\n                              </span>\n                              <span>\n                                 <b>Step: </b>\n                                 <br/>\n                                 <span style=\"padding-left: 100px;\">\n                                    <b>text: </b>\n                                    <span>Norepinephrine-Serotonin Modulators (Choose a maximum of one or document reasons for exception)</span>\n                                    <br/>\n                                 </span>\n                                 <span style=\"padding-left: 100px;\"/>\n                              </span>\n                           </span>\n                        </span>\n                     </span>\n                  </span>\n               </span>\n            </span>\n         </p>\n      </div>"
  },
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "US",
          "system": "urn:iso:std:iso:3166"
        }
      ]
    }
  ],
  "library": [
    {
      "display": "SuicideRiskLogic",
      "reference": "Library/suiciderisk-orderset-logic"
    }
  ],
  "topic": [
    {
      "text": "Suicide risk assessment"
    }
  ],
  "contributor": [
    {
      "contact": [
        {
          "telecom": [
            {
              "use": "work",
              "system": "phone",
              "value": "415-362-4007"
            },
            {
              "use": "work",
              "system": "email",
              "value": "info@motivemi.com"
            }
          ]
        }
      ],
      "type": "author",
      "name": "Motive Medical Intelligence"
    }
  ],
  "id": "low-suicide-risk-order-set",
  "copyright": "© Copyright 2016 Motive Medical Intelligence. All rights reserved.",
  "title": "Low Suicide Risk Order Set",
  "lastReviewDate": "2016-08-15",
  "contained": [
    {
      "status": "draft",
      "kind": "ReferralRequest",
      "code": {
        "text": "Referral to service (procedure)",
        "coding": [
          {
            "code": "306206005",
            "system": "http://snomed.info/sct"
          }
        ]
      },
      "participant": [
        {
          "type": "practitioner"
        }
      ],
      "description": "refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now",
      "resourceType": "ActivityDefinition",
      "timingTiming": {
        "_event": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/cqif-cqlExpression",
                "valueString": "Now()"
              }
            ]
          }
        ]
      },
      "id": "referralToMentalHealthCare"
    },
    {
      "status": "draft",
      "kind": "MedicationRequest",
      "productReference": {
        "reference": "#citalopramMedication"
      },
      "resourceType": "ActivityDefinition",
      "dosage": [
        {
          "timing": {
            "repeat": {
              "frequency": 1,
              "periodUnit": "d",
              "period": 1
            }
          },
          "text": "1 tablet oral 1 time daily",
          "route": {
            "text": "Oral route (qualifier value)",
            "coding": [
              {
                "code": "26643006",
                "display": "Oral route (qualifier value)"
              }
            ]
          },
          "doseQuantity": {
            "unit": "{tbl}",
            "value": 1
          }
        }
      ],
      "dynamicValue": [
        {
          "path": "dispenseRequest.numberOfRepeatsAllowed",
          "expression": "3"
        },
        {
          "path": "dispenseRequest.quantity",
          "expression": "30 '{tbl}'"
        }
      ],
      "id": "citalopramPrescription"
    },
    {
      "resourceType": "Medication",
      "code": {
        "text": "citalopram",
        "coding": [
          {
            "code": "200371",
            "system": "http://www.nlm.nih.gov/research/umls/rxnorm"
          }
        ]
      },
      "id": "citalopramMedication",
      "form": {
        "text": "Tablet dose form",
        "coding": [
          {
            "code": "385055001",
            "system": "http://snomed.info/sct",
            "display": "Tablet dose form"
          }
        ]
      },
      "ingredient": [
        {
          "itemReference": {
            "reference": "#citalopramSubstance"
          },
          "amount": {
            "denominator": {
              "unit": "{tbl}",
              "value": 1
            },
            "numerator": {
              "unit": "mg",
              "value": 20
            }
          }
        }
      ]
    },
    {
      "resourceType": "Substance",
      "code": {
        "text": "citalopram",
        "coding": [
          {
            "code": "2556",
            "system": "http://www.nlm.nih.gov/research/umls/rxnorm"
          }
        ]
      },
      "id": "citalopramSubstance"
    }
  ],
  "version": "1.0.0",
  "usage": "This order set should be applied after assessing a patient for suicide risk, when the findings of that assessment indicate the patient has low suicide risk.",
  "status": "active",
  "approvalDate": "2016-03-12",
  "description": "Orders to be applied to a patient characterized as low suicide risk.",
  "effectivePeriod": {
    "start": "2016-01-01",
    "end": "2017-12-31"
  },
  "action": [
    {
      "action": [
        {
          "action": [
            {
              "definition": {
                "reference": "#referralToMentalHealthCare"
              },
              "textEquivalent": "Refer to outpatient mental health program for evaluation and treatment of mental health conditions now",
              "dynamicValue": [
                {
                  "path": "timing.event",
                  "expression": "Now()"
                },
                {
                  "path": "specialty",
                  "expression": "Code '261QM0850X' from SuicideRiskLogic.\"NUCC Provider Taxonomy\" display 'Adult Mental Health'"
                },
                {
                  "path": "occurrenceDateTime",
                  "expression": "SuicideRiskLogic.ReferralRequestFulfillmentTime"
                },
                {
                  "path": "subject",
                  "expression": "SuicideRiskLogic.Patient"
                },
                {
                  "path": "requester.agent",
                  "expression": "SuicideRiskLogic.Practitioner"
                },
                {
                  "path": "reasonCode",
                  "expression": "SuicideRiskLogic.RiskAssessmentScore"
                },
                {
                  "path": "reasonReference",
                  "expression": "SuicideRiskLogic.RiskAssessment"
                }
              ]
            }
          ],
          "selectionBehavior": "any",
          "groupingBehavior": "logical-group",
          "title": "Consults and Referrals"
        },
        {
          "action": [
            {
              "action": [
                {
                  "action": [
                    {
                      "definition": {
                        "reference": "#citalopramPrescription"
                      },
                      "textEquivalent": "citalopram 20 mg tablet 1 tablet oral 1 time daily now (30 table; 3 refills)",
                      "dynamicValue": [
                        {
                          "path": "status",
                          "expression": "'draft'"
                        },
                        {
                          "path": "patient",
                          "expression": "SuicideRiskLogic.Patient"
                        },
                        {
                          "path": "prescriber",
                          "expression": "SuicideRiskLogic.Practitioner"
                        },
                        {
                          "path": "reasonCode",
                          "expression": "SuicideRiskLogic.RiskAssessmentScore"
                        },
                        {
                          "path": "reasonReference",
                          "expression": "SuicideRiskLogic.RiskAssessment"
                        }
                      ]
                    },
                    {
                      "textEquivalent": "escitalopram 10 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)"
                    },
                    {
                      "textEquivalent": "fluoxetine 20 mg capsule 1 capsule oral 1 time daily now (30 tablet; 3 refills)"
                    },
                    {
                      "textEquivalent": "paroxetine 20 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)"
                    },
                    {
                      "textEquivalent": "sertraline 50 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)"
                    }
                  ],
                  "selectionBehavior": "at-most-one",
                  "documentation": [
                    {
                      "document": {
                        "url": "http://dailymed.nlm.nih.gov/dailymed/drugInfo.cfm?setid=6daeb45c-451d-b135-bf8f-2d6dff4b6b01",
                        "contentType": "text/html",
                        "title": "National Library of Medicine. DailyMed website. CITALOPRAM- citalopram hydrobromide tablet, film coated."
                      },
                      "type": "citation"
                    }
                  ],
                  "groupingBehavior": "logical-group",
                  "title": "Selective Serotonin Reuptake Inhibitors (Choose a mazimum of one or document reasons for exception)"
                },
                {
                  "textEquivalent": "Dopamine Norepinephrine Reuptake Inhibitors (Choose a maximum of one or document reasons for exception)"
                },
                {
                  "textEquivalent": "Serotonin Norepinephrine Reuptake Inhibitors (Choose a maximum of one or doument reasons for exception)"
                },
                {
                  "textEquivalent": "Norepinephrine-Serotonin Modulators (Choose a maximum of one or document reasons for exception)"
                }
              ],
              "selectionBehavior": "at-most-one",
              "documentation": [
                {
                  "document": {
                    "url": "http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf",
                    "contentType": "text/html",
                    "extension": [
                      {
                        "url": "http://hl7.org/fhir/StructureDefinition/cqif-qualityOfEvidence",
                        "valueCodeableConcept": {
                          "text": "High Quality",
                          "coding": [
                            {
                              "code": "high",
                              "system": "http://hl7.org/fhir/evidence-quality"
                            }
                          ]
                        }
                      }
                    ],
                    "title": "Practice Guideline for the Treatment of Patients with Major Depressive Disorder"
                  },
                  "type": "citation"
                }
              ],
              "groupingBehavior": "logical-group",
              "title": "First-Line Antidepressants"
            }
          ],
          "selectionBehavior": "at-most-one",
          "groupingBehavior": "logical-group",
          "title": "Medications"
        }
      ],
      "title": "Suicide Risk Assessment and Outpatient Management"
    }
  ],
  "useContext": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "D000328",
            "system": "https://meshb.nlm.nih.gov",
            "display": "Adult"
          }
        ]
      },
      "code": {
        "code": "age",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "87512008",
            "system": "http://snomed.info/sct",
            "display": "Mild major depression"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "40379007",
            "system": "http://snomed.info/sct",
            "display": "Major depression, recurrent, mild"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "394687007",
            "system": "http://snomed.info/sct",
            "display": "Low suicide risk"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "225337009",
            "system": "http://snomed.info/sct",
            "display": "Suicide risk assessment"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "309343006",
            "system": "http://snomed.info/sct",
            "display": "Physician"
          }
        ]
      },
      "code": {
        "code": "user",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "440655000",
            "system": "http://snomed.info/sct",
            "display": "Outpatient environment"
          }
        ]
      },
      "code": {
        "code": "venue",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    }
  ],
  "purpose": "This order set helps ensure consistent application of appropriate orders for the care of low suicide risk patients.",
  "date": "2015-08-15",
  "publisher": "Motive Medical Intelligence",
  "name": "LowSuicideRiskOrderSet",
  "resourceType": "PlanDefinition",
  "url": "http://motivemi.com/artifacts/PlanDefinition/low-suicide-risk-order-set",
  "contact": [
    {
      "telecom": [
        {
          "use": "work",
          "system": "phone",
          "value": "415-362-4007"
        },
        {
          "use": "work",
          "system": "email",
          "value": "info@motivemi.com"
        }
      ]
    }
  ],
  "relatedArtifact": [
    {
      "url": "http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf",
      "type": "derived-from",
      "display": "Practice Guideline for the Treatment of Patients with Major Depressive Disorder"
    },
    {
      "resource": {
        "reference": "ActivityDefinition/referralPrimaryCareMentalHealth"
      },
      "type": "composed-of"
    },
    {
      "resource": {
        "reference": "ActivityDefinition/citalopramPrescription"
      },
      "type": "composed-of"
    }
  ],
  "identifier": [
    {
      "use": "official",
      "system": "http://motivemi.com/artifacts",
      "value": "mmi:low-suicide-risk-order-set"
    }
  ],
  "experimental": true
}

PlanDefinition Structure


  
{
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this plan definition (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the plan definition
  "version" : "<string>", // Business version of the plan definition
  "name" : "<string>", // Name for this plan definition (computer friendly)
  "title" : "<string>", // Name for this plan definition (human friendly)
  "type" : { CodeableConcept }, // order-set | protocol | eca-rule
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "description" : "<markdown>", // Natural language description of the plan definition
  "purpose" : "<markdown>", // Why this plan definition is defined
  "usage" : "<string>", // Describes the clinical usage of the asset
  "approvalDate" : "<date>", // When the plan definition was approved by publisher
  "lastReviewDate" : "<date>", // When the plan definition was last reviewed
  "effectivePeriod" : { Period }, // When the plan definition is expected to be used
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for plan definition (if applicable)
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "contributor" : [{ Contributor }], // A content contributor
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Related artifacts for the asset
  "library" : [{ Reference(Library) }], // Logic used by the plan definition
  "goal" : [{ // What the plan is trying to accomplish
    "category" : { CodeableConcept }, // E.g. Treatment, dietary, behavioral, etc
    "description" : { CodeableConcept }, // R!  Code or text describing the goal
    "priority" : { CodeableConcept }, // high-priority | medium-priority | low-priority
    "start" : { CodeableConcept }, // When goal pursuit begins
    "addresses" : [{ CodeableConcept }], // What does the goal address
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the goal
    "target" : [{ // Target outcome for the goal
      "measure" : { CodeableConcept }, // The parameter whose value is to be tracked
      // detail[x]: The target value to be achieved. One of these 3:
      "detailQuantity" : { Quantity },
      "detailRange" : { Range },
      "detailCodeableConcept" : { CodeableConcept },
      "due" : { Duration } // Reach goal within
    }]
  }],
  "action" : [{ // Action defined by the plan
    "label" : "<string>", // User-visible label for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Short description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or sub-actions
    "reason" : [{ CodeableConcept }], // Why the action should be performed
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goalId" : ["<id>"], // What goals this action supports
    "triggerDefinition" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "description" : "<string>", // Natural language description of the condition
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // Boolean-valued expression
    }],
    "input" : [{ DataRequirement }], // Input data requirements
    "output" : [{ DataRequirement }], // Output data definition
    "relatedAction" : [{ // Relationship to another action
      "actionId" : "<id>", // R!  What action is this related to
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration }
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 5:
    "timingDateTime" : "<dateTime>",
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ // Who should participate in the action
      "type" : "<code>", // R!  patient | practitioner | related-person
      "role" : { CodeableConcept } // E.g. Nurse, Surgeon, Parent, etc
    }],
    "type" : { Coding }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    "definition" : { Reference(ActivityDefinition|PlanDefinition) }, // Description of the activity to be performed
    "transform" : { Reference(StructureMap) }, // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "description" : "<string>", // Natural language description of the dynamic value
      "path" : "<string>", // The path to the element to be set dynamically
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // An expression that provides the dynamic value for the customization
    }],
    "action" : [{ Content as for PlanDefinition.action }] // A sub-action
  }]
}


 

PlanDefinition Search Parameters

The following search parameters can be used to query PlanDefinition resources. Just submit the like so:

https://api.1up.health/fhir/stu3/PlanDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
composed-ofreferencerelatedArtifact.where
datedatedate
depends-onreferencerelatedArtifact.where
derived-fromreferencerelatedArtifact.where
descriptiontextdescription
effectivedateeffectivePeriod
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
predecessorreferencerelatedArtifact.where
publishertextpublisher
statustextstatus
successorreferencerelatedArtifact.where
titletexttitle
topictexttopic
urluriurl
versiontextversion