R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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/plandefinition-predecessor-example (XML)

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

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

Jump past Narrative

Plan Definition Illustrating Predecessor Relationship (id = "plandefinition-predecessor-example")

<?xml version="1.0" encoding="UTF-8"?>

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

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.