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> 
      <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> subject</td> 
          <td> 0..1</td> 
          <td> Reference</td> 
          <td/>  
          <td> 
            <div> 
              <p> Subject to evaluate against. If not specified, the measure will be evaluated for all subjects
                 that meet the requirements of the measure. If specified, only the referenced subject(s)
                 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-12-20T15:52: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. 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"/> 
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure"/> 
  </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="subject"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Subject to evaluate against. If not specified, the measure will be evaluated for all subjects
     that meet the requirements of the measure. If specified, only the referenced subject(s)
     will be evaluated"/> 
    <type value="Reference"/> 
  </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"/> 
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> 
  </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>