Operation-measure-evaluate-measure.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Measure-evaluate-measure"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Evaluate Measure</h2>
      <p>OPERATION: Evaluate Measure</p>
      <div>
        <p>The evaluate-measure operation is used to invoke an eMeasure and obtain the results</p>

      </div>
      <p>URL: [base]/Measure/$evaluate-measure</p>
      <p>URL: [base]/Measure/[id]/$evaluate-measure</p>
      <p>Parameters</p>
      <table class="grid">
        <tr>
          <td>
            <b>Use</b>
          </td>
          <td>
            <b>Name</b>
          </td>
          <td>
            <b>Cardinality</b>
          </td>
          <td>
            <b>Type</b>
          </td>
          <td>
            <b>Binding</b>
          </td>
          <td>
            <b>Documentation</b>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>periodStart</td>
          <td>1..1</td>
          <td>date</td>
          <td/>
          <td>
            <div>
              <p>The start of the measurement period</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>periodEnd</td>
          <td>1..1</td>
          <td>date</td>
          <td/>
          <td>
            <div>
              <p>The end of the measurement period</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>measure</td>
          <td>0..1</td>
          <td>Reference</td>
          <td/>
          <td>
            <div>
              <p>The measure to evaluate</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>reportType</td>
          <td>0..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The type of measure report, patient, patient-list, or population</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>patient</td>
          <td>0..1</td>
          <td>Reference</td>
          <td/>
          <td>
            <div>
              <p>Patient to evaluate against</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>practitioner</td>
          <td>0..1</td>
          <td>Reference</td>
          <td/>
          <td>
            <div>
              <p>Practitioner to evaluate</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>lastReceivedOn</td>
          <td>0..1</td>
          <td>dateTime</td>
          <td/>
          <td>
            <div>
              <p>The date the results of this measure were last received</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>return</td>
          <td>1..1</td>
          <td>MeasureReport</td>
          <td/>
          <td>
            <div>
              <p>The results of the measure calculation</p>

            </div>
          </td>
        </tr>
      </table>
      <div>
        <p>The effect of invoking this operation is to calculate the measure for the given patient,
           or all patients if no patient is supplied, and return the results as a MeasureReport resource
           of the appropriate type</p>

      </div>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure"/>
  <name value="Evaluate Measure"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-12-06T12:22:34+11:00"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="The evaluate-measure operation is used to invoke an eMeasure and obtain the results"/>
  <code value="evaluate-measure"/>
  <comment value="The effect of invoking this operation is to calculate the measure for the given patient,
   or all patients if no patient is supplied, and return the results as a MeasureReport resource
   of the appropriate type"/>
  <resource value="Measure"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="periodStart"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The start of the measurement period"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="periodEnd"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The end of the measurement period"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="measure"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The measure to evaluate"/>
    <type value="Reference"/>
    <profile>
      <reference value="http://hl7.org/fhir/StructureDefinition/Measure"/>
    </profile>
  </parameter>
  <parameter>
    <name value="reportType"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The type of measure report, patient, patient-list, or population"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Patient to evaluate against"/>
    <type value="Reference"/>
    <profile>
      <reference value="http://hl7.org/fhir/StructureDefinition/Patient"/>
    </profile>
  </parameter>
  <parameter>
    <name value="practitioner"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Practitioner to evaluate"/>
    <type value="Reference"/>
    <profile>
      <reference value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
    </profile>
  </parameter>
  <parameter>
    <name value="lastReceivedOn"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The date the results of this measure were last received"/>
    <type value="dateTime"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The results of the measure calculation"/>
    <type value="MeasureReport"/>
  </parameter>
</OperationDefinition>