Operation-measure-data-requirements.xml

Operation Definition

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

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Measure-data-requirements"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> Data Requirements</h2> 
      <p> OPERATION: Data Requirements</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Measure-data-requirements</pre> 
      <div> 
        <p> The data-requirements operation aggregates and returns the parameters and data requirements
           for the measure and all its dependencies as a single module definition</p> 

      </div> 
      <p> URL: [base]/Measure/[id]/$data-requirements</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> 
            <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> 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> OUT</td> 
          <td> return</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</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="2"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/Measure-data-requirements"/> 
  <version value="4.2.0"/> 
  <name value="Data Requirements"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2019-12-31T21:03:40+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 data-requirements operation aggregates and returns the parameters and data requirements
   for the measure and all its dependencies as a single module definition"/> 
  <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="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="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"/> 
    <type value="Library"/> 
  </parameter> 
</OperationDefinition>