FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Activitydefinition-example.xml

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

Raw XML (canonical form)

Jump past Narrative

Activity definition to refer a patient to a mental health integrated care program (id = "referralPrimaryCareMentalHealth")

<ActivityDefinition xmlns="http://hl7.org/fhir">
  <id value="referralPrimaryCareMentalHealth"/> 
  <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;">ActivityDefinition/referralPrimaryCareMentalHealth</td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Status: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">draft</td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Description: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">refer to primary care mental-health integrated care program for evaluation and treatment
             of mental health conditions now</td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Category: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-left: 25px; padding-right: 25px;">referral</td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Code: </b> 
               </td> 
            </tr> 
            <tr> 
               <td style="padding-right: 25px;">
                  <span style="padding-left: 25px;">
                     <b> text: </b> 
                     <span> Referral to service (procedure)</span> 
                     <br/>  
                  </span> 
                  <span> 
                     <span> 
                        <span style="padding-left: 25px;">
                           <b> system: </b> 
                           <span> http://snomed.info/sct</span> 
                           <br/>  
                        </span> 
                        <span style="padding-left: 25px;">
                           <b> code: </b> 
                           <span> 306206005</span> 
                           <br/>  
                        </span> 
                     </span> 
                  </span> 
               </td> 
            </tr> 
         </table> 
         <p/>  
         <table class="grid dict">
            <tr> 
               <td> 
                  <b> Participant: </b> 
               </td> 
            </tr> 
            <tr style="vertical-align: top;">
               <td style="padding-left: 25px; padding-right: 25px;">practitioner</td> 
            </tr> 
         </table> 
      </div> 
  </text> 
  <url value="http://motivemi.com/artifacts/ActivityDefinition/referralPrimaryCareMentalHealth"/> 
  <identifier> 
    <use value="official"/> 
    <system value="http://motivemi.com/artifacts"/> 
    <value value="referralPrimaryCareMentalHealth"/> 
  </identifier> 
  <version value="1.1.0"/> 
  <name value="ReferralPrimaryCareMentalHealth"/> 
  <title value="Referral to Primary Care Mental Health"/> 
  <status value="active"/> 
  <experimental value="true"/> 
  <date value="2017-03-03T14:06:00Z"/> 
  <publisher value="Motive Medical Intelligence"/> 
  <description value="refer to primary care mental-health integrated care program for evaluation and treatment
   of mental health conditions now"/> 
  <purpose value="Defines a referral to a mental-health integrated care program for use in suicide risk
   order sets. The definition is independent of the order set in which it appears to allow
   reuse of the general definition of the referrral."/> 
  <usage value="This activity definition is used as the definition of a referral request within various
   suicide risk order sets. Elements that apply universally are defined here, while elements
   that apply to the specific setting of a referral within a particular order set are defined
   in the order set."/> 
  <approvalDate value="2017-03-01"/> 
  <lastReviewDate value="2017-03-01"/> 
  <effectivePeriod> 
    <start value="2017-03-01"/> 
    <end value="2017-12-31"/> 
  </effectivePeriod> 
  <useContext> 
    <code> 
      <system value="http://hl7.org/fhir/usage-context-type"/> 
      <code value="age"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="https://meshb.nlm.nih.gov"/> 
        <code value="D000328"/> 
        <display value="Adult"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <useContext> 
    <code> 
      <system value="http://hl7.org/fhir/usage-context-type"/> 
      <code value="focus"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="http://snomed.info/sct"/> 
        <code value="87512008"/> 
        <display value="Mild major depression"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <useContext> 
    <code> 
      <system value="http://hl7.org/fhir/usage-context-type"/> 
      <code value="focus"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="http://snomed.info/sct"/> 
        <code value="40379007"/> 
        <display value="Major depression, recurrent, mild"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <useContext> 
    <code> 
      <system value="http://hl7.org/fhir/usage-context-type"/> 
      <code value="focus"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="http://snomed.info/sct"/> 
        <code value="225444004"/> 
        <display value="At risk for suicide (finding)"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <useContext> 
    <code> 
      <system value="http://hl7.org/fhir/usage-context-type"/> 
      <code value="focus"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="http://snomed.info/sct"/> 
        <code value="306206005"/> 
        <display value="Referral to service (procedure)"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <useContext> 
    <code> 
      <system value="http://hl7.org/fhir/usage-context-type"/> 
      <code value="user"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="http://snomed.info/sct"/> 
        <code value="309343006"/> 
        <display value="Physician"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <useContext> 
    <code> 
      <system value="http://hl7.org/fhir/usage-context-type"/> 
      <code value="venue"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="http://snomed.info/sct"/> 
        <code value="440655000"/> 
        <display value="Outpatient environment"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <jurisdiction> 
    <coding> 
      <system value="urn:iso:std:iso:3166"/> 
      <code value="US"/> 
    </coding> 
  </jurisdiction> 
  <topic> 
    <text value="Mental Health Referral"/> 
  </topic> 
  <contributor> 
    <type value="author"/> 
    <name value="Motive Medical Intelligence"/> 
    <contact> 
      <telecom> 
        <system value="phone"/> 
        <value value="415-362-4007"/> 
        <use value="work"/> 
      </telecom> 
      <telecom> 
        <system value="email"/> 
        <value value="info@motivemi.com"/> 
        <use value="work"/> 
      </telecom> 
    </contact> 
  </contributor> 
  <contact> 
    <telecom> 
      <system value="phone"/> 
      <value value="415-362-4007"/> 
      <use value="work"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="info@motivemi.com"/> 
      <use value="work"/> 
    </telecom> 
  </contact> 
  <copyright value="© Copyright 2016 Motive Medical Intelligence. All rights reserved."/> 
  <relatedArtifact> 
    <type value="citation"/> 
    <display value="Practice Guideline for the Treatment of Patients with Major Depressive Disorder"/> 
    <url value="http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf"/> 
  </relatedArtifact> 
  <relatedArtifact> 
    <type value="predecessor"/> 
    <resource> 
      <reference value="ActivityDefinition/referralPrimaryCareMentalHealth-initial"/> 
    </resource> 
  </relatedArtifact> 
  <!--   Kind indicates the type of resource that is defined by this activity, a ReferralRequest
   in this case   -->
  <kind value="ReferralRequest"/> 
  <code> 
    <coding> 
      <system value="http://snomed.info/sct"/> 
      <code value="306206005"/> 
    </coding> 
    <text value="Referral to service (procedure)"/> 
  </code> 
  <timingTiming> 
    <event> 
    <!--   The expression here specifies the value for the timing of the resulting resource.
       In this case, referralRequest.fulfillmentTime.start   -->
      <extension url="http://hl7.org/fhir/StructureDefinition/cqif-cqlExpression">
        <valueString value="Now()"/> 
      </extension> 
    </event> 
  </timingTiming> 
  <participant> 
    <type value="practitioner"/> 
  </participant> 
</ActivityDefinition> 

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.