Operation Definition

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


  
  
    
    
      
      
      
      
      
        

      
      
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
            
          
          
          
            
              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 s

            
          
        
        
          
          
          
          
            
          
          
          
            
              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

            
          
        
        
          
          
          
          
            
            (
            )
          
          
          
            
              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

            
          
        
        
          
          
          
          
            
            (
            )
          
          
          
            
              Subject for which the measure will be collected. If not specified, measure data will be
                 collected for all subjects that meet the requirements of the measure. If specified, the
                 measure will only be calculated for the referenced subject(s)

            
          
        
        
          
          
          
          
            
            (
            )
          
          
          
            
              Practitioner for which the measure will be collected. If specified, measure data will
                 be collected only for subjects that have a primary relationship to the identified practitioner

            
          
        
        
          
          
          
          
            
          
          
          
            
              The date the results of this measure were last received. This parameter used to indicate
                 when the last time data for this measure was collected. This information is used to support
                 incremental data collection scenarios

            
          
        
        
          
          
          
          
            
          
          
          
            
              

            
          
        
        
          
          
          
          
            
          
          
          
            
              

            
          
        
      
      
        The effect of invoking this operation is to gather the data required to perform an evaluation
           of the measure. If the lastReceivedOn parameter is supplied, only data that is new or
           has been changed since the lastReceivedOn date is included in the response. Note that
           the resulting MeasureReport is a transient resource

      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  
  
  
  
  The effect of invoking this operation is to gather the data required to perform an evaluation
   of the measure. If the lastReceivedOn parameter is supplied, only data that is new or
   has been changed since the lastReceivedOn date is included in the response. Note that
   the resulting MeasureReport is a transient resource
  
  
  
  
  
    
    
    
    
    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 s
    
  
  
    
    
    
    
    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
    
  
  
    
    
    
    
    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
    
    
  
  
    
    
    
    
    Subject for which the measure will be collected. If not specified, measure data will be
     collected for all subjects that meet the requirements of the measure. If specified, the
     measure will only be calculated for the referenced subject(s)
    
    
  
  
    
    
    
    
    Practitioner for which the measure will be collected. If specified, measure data will
     be collected only for subjects that have a primary relationship to the identified practitioner
    
    
  
  
    
    
    
    
    The date the results of this measure were last received. This parameter used to indicate
     when the last time data for this measure was collected. This information is used to support
     incremental data collection scenarios
    
  
  
    
    
    
    
    
    
  
  
    
    
    
    
    
    
  

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Measure-collect-data"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> URL: [base]/Measure/$collect-data</p> 
      <p> URL: [base]/Measure/[id]/$collect-data</p> 
      <p> Parameters</p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Scope</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/>  
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#date">date</a> 
          </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 s</p> 
            </div>           </td>         </tr>         <tr>           <td> IN</td>           <td> periodEnd</td>           <td/>            <td> 1..1</td>           <td>             <a href="datatypes.html#date">date</a>           </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> type</td>           <td> 0..1</td>           <td>             <a href="datatypes.html#string">string</a>             <br/>  (            <a href="search.html#reference">reference</a> )          </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> subject</td>           <td/>            <td> 0..1</td>           <td>             <a href="datatypes.html#string">string</a>             <br/>  (            <a href="search.html#reference">reference</a> )          </td>           <td/>            <td>             <div>               <p> Subject for which the measure will be collected. If not specified, measure data

                 will be collected for all subjects that meet the requirements of the measure. If
                 specified, the measure will only be calculated for the referenced subject(s)</p> 
            </div>           </td>         </tr>         <tr>           <td> IN</td>           <td> practitioner</td>           <td/>            <td> 0..1</td>           <td>             <a href="datatypes.html#string">string</a>             <br/>  (            <a href="search.html#reference">reference</a> )          </td>           <td/>            <td>             <div>               <p> Practitioner for which the measure will be collected. If specified, measure data

                 will be collected only for subjects that have a primary relationship to the identified
                 practitioner</p> 
            </div>           </td>         </tr>         <tr>           <td> IN</td>           <td> lastReceivedOn</td>           <td/>            <td> 0..1</td>           <td>             <a href="datatypes.html#dateTime">dateTime</a>           </td>           <td/>            <td>             <div>               <p> The date the results of this measure were last received. This parameter used to

                 indicate when the last time data for this measure was collected. This information
                 is used to support incremental data collection scenarios</p> 
            </div>           </td>         </tr>         <tr>           <td> OUT</td>           <td> measureReport</td>           <td/>            <td> 1..1</td>           <td>             <a href="measurereport.html">MeasureReport</a>           </td>           <td/>            <td>             <div>               <p> A MeasureReport of type data-exchange detailing the results of the operation</p>             </div>           </td>         </tr>         <tr>           <td> OUT</td>           <td> resource</td>           <td/>            <td> 0..*</td>           <td>             <a href="resource.html">Resource</a>           </td>           <td/>            <td>             <div>               <p> The result resources that make up the data-of-interest for the measure</p>             </div>           </td>         </tr>       </table>       <div>         <p> The effect of invoking this operation is to gather the data required to perform

           an evaluation of the measure. If the lastReceivedOn parameter is supplied, only
           data that is new or has been changed since the lastReceivedOn date is included
           in the response. Note that the resulting MeasureReport is a transient resource</p> 
      </div>     </div>   </text>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">    <valueInteger value="3"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">    <valueCode value="trial-use"/>   </extension>   <url value="http://hl7.org/fhir/OperationDefinition/Measure-collect-data"/>   <version value="5.0.0"/>   <name value="CollectData"/>   <title value="Collect Data"/>   <status value="draft"/>   <kind value="operation"/>   <experimental value="false"/>   <date value="2023-03-26T15:21:02+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 collect-data operation is used to collect the data-of-interest for the given

   measure."/> 
  <jurisdiction>     <coding>       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>       <code value="001"/>       <display value="World"/>     </coding>   </jurisdiction>   <affectsState value="false"/>   <code value="collect-data"/>   <comment value="The effect of invoking this operation is to gather the data required to perform

   an evaluation of the measure. If the lastReceivedOn parameter is supplied, only
   data that is new or has been changed since the lastReceivedOn date is included
   in the response. Note that the resulting MeasureReport is a transient resource"/> 
  <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 s"/> 
    <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"/>     <scope value="type"/>     <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="string"/>     <searchType value="reference"/>   </parameter>   <parameter>     <name value="subject"/>     <use value="in"/>     <min value="0"/>     <max value="1"/>     <documentation value="Subject for which the measure will be collected. If not specified, measure data

     will be collected for all subjects that meet the requirements of the measure. If
     specified, the measure will only be calculated for the referenced subject(s)"/> 
    <type value="string"/>     <searchType value="reference"/>   </parameter>   <parameter>     <name value="practitioner"/>     <use value="in"/>     <min value="0"/>     <max value="1"/>     <documentation value="Practitioner for which the measure will be collected. If specified, measure data

     will be collected only for subjects that have a primary relationship to the identified
     practitioner"/> 
    <type value="string"/>     <searchType value="reference"/>   </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 used to

     indicate when the last time data for this measure was collected. This information
     is used to support incremental data collection scenarios"/> 
    <type value="dateTime"/>   </parameter>   <parameter>     <name value="measureReport"/>     <use value="out"/>     <min value="1"/>     <max value="1"/>     <documentation value="A MeasureReport of type data-exchange detailing the results of the operation"/>     <type value="MeasureReport"/>   </parameter>   <parameter>     <name value="resource"/>     <use value="out"/>     <min value="0"/>     <max value="*"/>     <documentation value="The result resources that make up the data-of-interest for the measure"/>     <type value="Resource"/>   </parameter> 


</

OperationDefinition

>