FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.329  |  FHIR Version 3.0.2  | User: ANONYMOUS (Unknown)  

Resource "Measure-evaluate-measure" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Evaluate Measure

OPERATION: Evaluate Measure

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure

The evaluate-measure operation is used to invoke an eMeasure and obtain the results

URL: [base]/Measure/$evaluate-measure

URL: [base]/Measure/[id]/$evaluate-measure

Parameters

Use Name Cardinality Type Binding Documentation
IN periodStart 1..1 date

The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive

IN periodEnd 1..1 date

The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive

IN measure 0..1 Reference

The measure to evaluate. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance

IN reportType 0..1 code

The type of measure report, patient, patient-list, or population. If not specified, a default value of patient will be used if the patient parameter is supplied, otherwise, population will be used

IN patient 0..1 Reference

Patient to evaluate against. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated

IN practitioner 0..1 Reference

Practitioner to evaluate. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner

IN lastReceivedOn 0..1 dateTime

The date the results of this measure were last received. This parameter is only valid for patient-level reports and is used to indicate when the last time a result for this patient was received. This information can be used to limit the set of resources returned for a patient-level report

OUT return 1..1 MeasureReport

The results of the measure calculation. See the MeasureReport resource for a complete description of the output of this operation

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


<?xml version="1.0" encoding="UTF-8"?>
<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Measure-evaluate-measure"/>
  <meta>
    <versionId value="1"/>
    <lastUpdated value="2018-09-20T01:09:25.909Z"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Evaluate Measure</h2>
      <p>OPERATION: Evaluate Measure</p>
      <p>The official URL for this operation definition is: </p>
      <pre>http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure</pre>
      <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. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive</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. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive</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. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance</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. If not specified, a default value of patient will be used if the patient parameter is supplied, otherwise, population will be used</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. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated</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. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner</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. This parameter is only valid for patient-level reports and is used to indicate when the last time a result for this patient was received. This information can be used to limit the set of resources returned for a patient-level report</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. See the MeasureReport resource for a complete description of the output of this operation</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="2017-04-19T07:44:43+10: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. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive"/>
    <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. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="measure"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The measure to evaluate. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance"/>
    <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. If not specified, a default value of patient will be used if the patient parameter is supplied, otherwise, population will be used"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Patient to evaluate against. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated"/>
    <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. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner"/>
    <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. This parameter is only valid for patient-level reports and is used to indicate when the last time a result for this patient was received. This information can be used to limit the set of resources returned for a patient-level report"/>
    <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. See the MeasureReport resource for a complete description of the output of this operation"/>
    <type value="MeasureReport"/>
  </parameter>
</OperationDefinition>