Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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

Example ExampleScenario/example (XML)

FHIR Infrastructure 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

Example of examplescenario (id = "example")

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

<ExampleScenario xmlns="http://hl7.org/fhir">
  <id value="example"/> 
  <text> 
    <status value="additional"/> 
    <div xmlns="http://www.w3.org/1999/xhtml"><p>  <b>  ExampleScenario - Medication administration (IHE MMA)</b>  <a name="example"> </a>  </p>  <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border:
       1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource ExampleScenario &quot;example&quot; </p>  </div>  <p>  <b>  status</b>  : draft</p>  <p>  <b>  purpose</b>  : Purpose: this serves to enable remote performing of medication administration,
         by using remote / mobile devices to a) Get the planned medication administrations
         and b) Record the performing of these administrations without a permanent connection
         to the EHR.</p>  
     <img alt="ExampleScenario diagram - IHE MMA example" src="./examplescenario-example.png"/> </div> 
  </text> 
  <status value="draft"/> 
  <purpose value="Purpose: this serves to demonstrate the performing of medication administration,
   by using remote / mobile devices to a) Get the planned medication administrations
   and b) Record the performing of these administrations without a permanent connection
   to the EHR."/> 
  <!--   First define actors  -->
  <actor> 
    <key value="Nurse"/> 
    <type value="person"/> 
    <title value="Nurse"/> 
    <description value="The Nurse"/> 
  </actor> 
  <actor> 
    <key value="MAP"/> 
    <type value="system"/> 
    <title value="Nurse's Tablet"/> 
    <description value="The entity that receives the Administration Requests to show the nurse to perform
     them"/> 
  </actor> 
  <actor> 
    <key value="OP"/> 
    <type value="system"/> 
    <title value="MAR / Scheduler"/> 
    <description value="The Medication Administration Order Placer"/> 
  </actor> 
  <actor> 
    <key value="MAC"/> 
    <type value="system"/> 
    <title value="MAR / EHR"/> 
    <description value="The entity that receives the Medication Administration reports"/> 
  </actor> 
  <!--   Then define the resource instances   -->
  <instance> 
    <key value="iherx001"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationRequest"/> 
    </structureType> 
    <title value="Initial Prescription"/> 
    <description value="The initial prescription which describes &quot;medication X, 3 times per day&quot;
     - the exact scheduling is not   in the initial prescription (it is left for the
     care teams to decide on the schedule)."/> 
  </instance> 
  <instance> 
    <key value="iherx001.001"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationRequest"/> 
    </structureType> 
    <title value="Request for day 1, morning"/> 
    <description value="The administration request for day 1, morning"/> 
  </instance> 
  <instance> 
    <key value="iherx001.002"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationRequest"/> 
    </structureType> 
    <title value="Request for day 1, lunch"/> 
    <description value="The administration request for day 1, lunch"/> 
  </instance> 
  <instance> 
    <key value="iherx001.003"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationRequest"/> 
    </structureType> 
    <title value="Request for day 1, evening"/> 
    <description value="The administration request for day 1, evening"/> 
  </instance> 
  <instance> 
    <key value="iherx001.004"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationRequest"/> 
    </structureType> 
    <title value="Request for day 2, morning"/> 
    <description value="The administration request for day 2, morning"/> 
  </instance> 
  <instance> 
    <key value="iherx001.005"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationRequest"/> 
    </structureType> 
    <title value="Request for day 2, lunch"/> 
    <description value="The administration request for day 2, lunch"/> 
  </instance> 
  <instance> 
    <key value="iherx001.006"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationRequest"/> 
    </structureType> 
    <title value="Request for day 2, evening"/> 
    <description value="The administration request for day 2, evening"/> 
  </instance> 
  <instance> 
    <key value="iheadm001a"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationAdministration"/> 
    </structureType> 
    <title value="Morning meds - taken"/> 
    <description value="Administration report for day 1, morning: Taken"/> 
  </instance> 
  <instance> 
    <key value="iheadm001b"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationAdministration"/> 
    </structureType> 
    <title value="Morning meds - not taken"/> 
    <description value="Administration report for day 1, morning: NOT Taken"/> 
  </instance> 
  <instance> 
    <key value="iherx001bundle"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationRequest"/> 
    </structureType> 
    <title value="Bundle of Medication Requests"/> 
    <description value="All the medication Requests for Day 1"/> 
    <containedInstance> 
      <instanceReference value="iherx001.001"/> 
    </containedInstance> 
    <containedInstance> 
      <instanceReference value="iherx001.002"/> 
    </containedInstance> 
    <containedInstance> 
      <instanceReference value="iherx001.003"/> 
    </containedInstance> 
    <containedInstance> 
      <instanceReference value="iherx001.004"/> 
    </containedInstance> 
    <containedInstance> 
      <instanceReference value="iherx001.005"/> 
    </containedInstance> 
    <containedInstance> 
      <instanceReference value="iherx001.006"/> 
    </containedInstance> 
  </instance> 
  <instance> 
    <key value="iheadm002"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="MedicationAdministration"/> 
    </structureType> 
    <title value="Lunch meds - taken"/> 
    <description value="Administration report for day 1, lunch: Taken"/> 
    <version> 
      <key value="iheadm002v1"/> 
      <description value="Medication just taken"/> 
    </version> 
    <version> 
      <key value="iheadm002v2"/> 
      <description value="Medication rejected"/> 
    </version> 
  </instance> 
  <!--   QUESTION: How to define search actions?  -->
  <instance> 
    <key value="iherxqry"/> 
    <structureType> 
      <system value="http://hl7.org/fhir/fhir-types"/> 
      <code value="SearchParameter"/> 
    </structureType> 
    <title value="Search query1"/> 
    <description value="The search administration request for day 1, morning"/> 
  </instance> 
  <process> 
    <title value="Mobile Medication Administration"/> 
    <description value="This scenario demonstrates the process of getting the relevant medication instructions
     for a patient visit and reporting the results of administration. The scenario is
     as follows: After the prescription is issued, the institution schedules each individual
     administration event in the Medication Administration Record (MAR). When preparing
     for a visit, the nurse queries the MAR for the scheduled administrations, obtaining
     a bundle of records. The nurse then performs the care activities and registers
     the results in the device. Upon synchronization of the device and the institution,
     the results of administration are uploaded to the EHR, thus updating the MAR."/> 
    <preConditions value="Medication administration requests are in the EHR / MAR, scheduled for each individual
     intake."/> 
    <postConditions value="Medication administration Reports are submitted, EHR is updated."/> 
    <step> 
      <number value="1"/> 
      <operation> 
        <title value="Get today's schedule"/> 
        <initiator value="Nurse"/> 
        <receiver value="MAP"/> 
      </operation> 
    </step> 
    <step> 
      <number value="2"/> 
      <operation> 
        <title value="Query administration orders"/> 
        <initiator value="MAP"/> 
        <receiver value="OP"/> 
        <description value="Query for medication administration orders,\n- For today's shifts\n- For today's
         patients"/> 
        <request> 
          <instanceReference value="iherxqry"/> 
        </request> 
        <response> 
          <instanceReference value="iherx001bundle"/> 
        </response> 
      </operation> 
      <pause value="true"/> 
    </step> 
    <step> 
      <number value="3"/> 
      <operation> 
        <title value="Notify (alert)"/> 
        <initiator value="MAP"/> 
        <receiver value="Nurse"/> 
      </operation> 
    </step> 
    <step> 
      <number value="4"/> 
      <operation> 
        <title value="Read orders"/> 
        <initiator value="Nurse"/> 
        <receiver value="MAP"/> 
      </operation> 
      <pause value="true"/> 
    </step> 
    <step> 
      <number value="5"/> 
      <operation> 
        <title value="Ask if patient took meds"/> 
        <initiator value="Nurse"/> 
        <receiver value="Nurse"/> 
      </operation> 
    </step> 
    <step> 
      <alternative> 
        <title value="Patient took meds"/> 
        <description value="Invoke if patient took medications"/> 
        <step> 
          <number value="6a"/> 
          <operation> 
            <title value="Register meds taken"/> 
            <initiator value="Nurse"/> 
            <receiver value="MAP"/> 
            <initiatorActive value="true"/> 
          </operation> 
        </step> 
      </alternative> 
      <alternative> 
        <title value="No drugs"/> 
        <description value="No, patient did not take meds"/> 
        <step> 
          <number value="6b"/> 
          <operation> 
            <title value="Register meds NOT taken"/> 
            <initiator value="Nurse"/> 
            <receiver value="MAP"/> 
            <initiatorActive value="true"/> 
          </operation> 
        </step> 
      </alternative> 
      <alternative> 
        <title value="Not clear"/> 
        <description value="Unknown whether patient took medications or not"/> 
      </alternative> 
      <pause value="true"/> 
    </step> 
    <step> 
      <number value="7"/> 
      <operation> 
        <title value="Administer drug"/> 
        <initiator value="Nurse"/> 
        <receiver value="Nurse"/> 
      </operation> 
    </step> 
    <step> 
      <number value="8"/> 
      <operation> 
        <title value="Record administration"/> 
        <initiator value="Nurse"/> 
        <receiver value="MAP"/> 
        <initiatorActive value="true"/> 
      </operation> 
      <pause value="true"/> 
    </step> 
    <step> 
      <number value="9"/> 
      <operation> 
        <title value="Upload administration reports"/> 
        <initiator value="Nurse"/> 
        <receiver value="MAP"/> 
        <initiatorActive value="true"/> 
        <request> 
          <instanceReference value="iheadm002"/> 
          <versionReference value="iheadm002v1"/> 
        </request> 
      </operation> 
      <pause value="true"/> 
    </step> 
    <step> 
      <number value="10"/> 
      <operation> 
        <title value="Upload administration reports"/> 
        <initiator value="MAP"/> 
        <receiver value="MAC"/> 
        <description value="The nurse's system uploads the administration results to the server"/> 
        <request> 
          <instanceReference value="iheadm001a"/> 
        </request> 
      </operation> 
    </step> 
  </process> 
</ExampleScenario> 

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.