Quality Measure Implementation Guide (STU3)
3.0.0 - STU 3 US

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v3.0.0: STU3) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Measure Data Requirements - XML Representation

Active as of 2019-11-01

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Measure-data-requirements"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>MeasureDataRequirements</h2><p>OPERATION: MeasureDataRequirements</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/cqfmeasures/OperationDefinition/Measure-data-requirements</pre><div><p>Determines the effective data requirements for the measure, including known components and dependencies, and optionally informed by a version manifest.</p>
</div><p>URL: [base]/Measure/$data-requirements</p><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>id</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The logical id of the measure to analyze. The server must know the measure (e.g. it is defined explicitly in the server's measures)</p>
</div></td></tr><tr><td>IN</td><td>url</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</a></td><td/><td><div><p>A canonical reference to a measure. The server must know the measure (e.g. it is defined explicitly in the server's measures</p>
</div></td></tr><tr><td>IN</td><td>version</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The version of the measure to analyze</p>
</div></td></tr><tr><td>IN</td><td>identifier</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#token">token</a>)</td><td/><td><div><p>A business identifier of the measure to be analyzed. The server must know the measure and the identifier must resolve unambiguously to a single measure on the server.</p>
</div></td></tr><tr><td>IN</td><td>periodStart</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/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>0..1</td><td><a href="http://hl7.org/fhir/R4/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>parameters</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/parameters.html">Parameters</a></td><td/><td><div><p>Any additional input parameters for the measure. Parameters defined in this input will be bound by name to parameters defined in the measure library (or referenced libraries). Parameter types are mapped to CQL as specified in the Using CQL section of this implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.</p>
</div></td></tr><tr><td>IN</td><td>system-version</td><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Specifies a version to use for a system, if the measure or value set does not already specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56</p>
</div></td></tr><tr><td>IN</td><td>check-system-version</td><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a system. If a measure or value set specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56</p>
</div></td></tr><tr><td>IN</td><td>force-system-version</td><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the measure and value sets (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters</p>
</div></td></tr><tr><td>IN</td><td>manifest</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Specifies an asset-collection library that defines version bindings for code systems referenced by value set(s) or other artifacts used in the artifact. When specified, code systems identified as <code>depends-on</code> related artifacts in the measure or dependent libraries have the same meaning as specifying that code system version in the <code>system-version</code> parameter.</p>
</div></td></tr><tr><td>IN</td><td>include-dependencies</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Specifies whether to follow known dependencies of the artifact as part of the analysis, recursively (default = true)</p>
</div></td></tr><tr><td>IN</td><td>include-components</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Specifies whether to follow known components of the artifact as part of the analysis, recursively (default = true)</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>The result of the requirements operation is a <em>module-definition</em> Library that returns the computed effective requirements of the artifact.</p>
</div></td></tr></table><div><p>The requirements operation supports the ability of a repository to determine the effective requirements of an artifact, including terminology usage (code systems, value sets, and direct-reference codes), parameters, dependencies (artifacts), and data requirements</p>
</div></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/cqfmeasures/OperationDefinition/Measure-data-requirements"/>
  <version value="3.0.0"/>
  <name value="MeasureDataRequirements"/>
  <title value="Measure Data Requirements"/>
  <status value="active"/>
  <kind value="operation"/>
  <experimental value="false"/>
  <date value="2019-11-01T09:29:23+11:00"/>
  <publisher value="Clinical Quality Information WG"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cqi"/>
    </telecom>
  </contact>
  <description
               value="Determines the effective data requirements for the measure, including known components and dependencies, and optionally informed by a version manifest."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <code value="data-requirements"/>
  <comment
           value="The requirements operation supports the ability of a repository to determine the effective requirements of an artifact, including terminology usage (code systems, value sets, and direct-reference codes), parameters, dependencies (artifacts), and data requirements"/>
  <base
        value="http://hl7.org/fhir/OperationDefinition/Measure-data-requirements"/>
  <resource value="Measure"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="id"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The logical id of the measure to analyze. The server must know the measure (e.g. it is defined explicitly in the server's measures)"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="url"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="A canonical reference to a measure. The server must know the measure (e.g. it is defined explicitly in the server's measures"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The version of the measure to analyze"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="identifier"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="A business identifier of the measure to be analyzed. The server must know the measure and the identifier must resolve unambiguously to a single measure on the server."/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <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="parameters"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Any additional input parameters for the measure. Parameters defined in this input will be bound by name to parameters defined in the measure library (or referenced libraries). Parameter types are mapped to CQL as specified in the Using CQL section of this implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL."/>
    <type value="Parameters"/>
  </parameter>
  <parameter>
    <name value="system-version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Specifies a version to use for a system, if the measure or value set does not already specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56"/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="check-system-version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Edge Case: Specifies a version to use for a system. If a measure or value set specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56"/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="force-system-version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the measure and value sets (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters"/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="manifest"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Specifies an asset-collection library that defines version bindings for code systems referenced by value set(s) or other artifacts used in the artifact. When specified, code systems identified as `depends-on` related artifacts in the measure or dependent libraries have the same meaning as specifying that code system version in the `system-version` parameter."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="include-dependencies"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Specifies whether to follow known dependencies of the artifact as part of the analysis, recursively (default = true)"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="include-components"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Specifies whether to follow known components of the artifact as part of the analysis, recursively (default = true)"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The result of the requirements operation is a _module-definition_ Library that returns the computed effective requirements of the artifact."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>