Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions . Page versions: R5 R4B R4 R3

Operation-measure-data-requirements.xml

Example OperationDefinition/Measure-data-requirements (XML)

Maturity Level : N/A
Responsible Owner: Clinical Quality Information Work Group Standards Status : Informative Compartments : Not linked to any defined compartments

Raw XML ( canonical form + also see XML Format Specification )

Jump past Narrative

Operation Definition

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


  
  
    
    
      
      
      
      
      
        The data-requirements operation aggregates and returns the parameters and data requirements
           for the measure and all its dependencies as a single module definition

      
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
            
          
          
          
            
              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

            
          
        
        
          
          
          
          
            
          
          
          
            
              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

            
          
        
        
          
          
          
          
            
          
          
          
            

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Measure-data-requirements"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: OperationDefinition Measure-data-requirements</b> 
      </p> 
      <a name="Measure-data-requirements"> </a> 
      <a name="hcMeasure-data-requirements"> </a> 
      <p> URL: [base]/Measure/[id]/$data-requirements</p> 
      <h3> Parameters</h3> 
      <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> 0..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 start to be 2014-01-01T00:00:00 inclusive</p> 
            </div>           </td>         </tr>         <tr>           <td> IN</td>           <td> periodEnd</td>           <td/>            <td> 0..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> OUT</td>           <td> return</td>           <td/>            <td> 1..1</td>           <td>             <a href="library.html">Library</a>           </td>           <td/>            <td>             <div> 
              <p> The result of the requirements gathering is a module-definition Library that describes
                 the aggregate parameters, data requirements, and dependencies of the measure

            
          
        
      
      
        The effect of invoking this operation is to determine the aggregate set of data requirements
           and dependencies for the measure. The result is a Library resource with a type of module-definition
           that contains all the parameter definitions and data requirements of the libraries referenced
           by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e.
           by collapsing overlapping data requirements). This operation defines what resources are
           subsequently referenced in the evaluatedResources element of the MeasureReport when submitting
           measure data

      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  
  The data-requirements operation aggregates and returns the parameters and data requirements
   for the measure and all its dependencies as a single module definition
  
  The effect of invoking this operation is to determine the aggregate set of data requirements
   and dependencies for the measure. The result is a Library resource with a type of module-definition
   that contains all the parameter definitions and data requirements of the libraries referenced
   by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e.
   by collapsing overlapping data requirements). This operation defines what resources are
   subsequently referenced in the evaluatedResources element of the MeasureReport when submitting
   measure data
  
  
  
  
  
    
    
    
    
    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
    
  
  
    
    
    
    
    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 aggregate parameters, data requirements, and dependencies of the measure</p> 
            </div>           </td>         </tr>       </table>       <div>         <p> The effect of invoking this operation is to determine the aggregate set of data

           requirements and dependencies for the measure. The result is a Library resource
           with a type of module-definition that contains all the parameter definitions and
           data requirements of the libraries referenced by the measures. Implementations
           SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping
           data requirements). This operation defines what resources are subsequently referenced
           in the evaluatedResources element of the MeasureReport when submitting measure
           data</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="normative"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">    <valueCode value="cqi"/>   </extension>   <url value="http://hl7.org/fhir/OperationDefinition/Measure-data-requirements"/>   <version value="6.0.0-ballot3"/>   <name value="DataRequirements"/>   <title value="Data Requirements"/>   <status value="active"/>   <kind value="operation"/>   <experimental value="false"/>   <date value="2025-11-24T20:46:00+00:00"/>   <publisher value="HL7 International / Clinical Quality Information"/>   <contact>     <telecom>       <system value="url"/>       <value value="http://hl7.org/fhir"/>     </telecom>     <telecom>       <system value="email"/>       <value value="fhir@lists.hl7.org"/>     </telecom>   </contact>   <contact>     <telecom>       <system value="url"/>       <value value="http://www.hl7.org/Special/committees/cqi"/>     </telecom>   </contact>   <description value="The data-requirements operation aggregates and returns the parameters and data

   requirements for the measure and all its dependencies as a single module definition"/> 
  <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="data-requirements"/>   <comment value="The effect of invoking this operation is to determine the aggregate set of data

   requirements and dependencies for the measure. The result is a Library resource
   with a type of module-definition that contains all the parameter definitions and
   data requirements of the libraries referenced by the measures. Implementations
   SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping
   data requirements). This operation defines what resources are subsequently referenced
   in the evaluatedResources element of the MeasureReport when submitting measure
   data"/> 
  <resource value="Measure"/>   <system value="false"/>   <type value="false"/>   <instance value="true"/>   <parameter>     <name value="periodStart"/>     <use value="in"/>     <min value="0"/>     <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="0"/>     <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="return"/>     <use value="out"/>     <min value="1"/>     <max value="1"/> 
    <documentation value="The result of the requirements gathering is a module-definition Library that describes
     the aggregate parameters, data requirements, and dependencies of the measure
    
  

     the aggregate parameters, data requirements, and dependencies of the measure"/> 
    <type value="Library"/>   </parameter> 


</

OperationDefinition

>



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.