Data Exchange For Quality Measures Implementation Guide
1.0.0-ballot - STU 1 Ballot
Data Exchange For Quality Measures Implementation Guide
1.0.0-ballot - STU 1 Ballot
Data Exchange For Quality Measures Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-deqm/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 4 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="evaluate"/>
<language value="en"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition evaluate</b></p><a name="evaluate"> </a><a name="hcevaluate"> </a><p>URL: [base]/Measure/$evaluate</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>measureUrl</td><td/><td>1..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>The URL of the measure to be evaluated. A measure URL is specified in the <a href="https://www.hl7.org/fhir/measure-definitions.html#Measure.url">url</a> element of the Measure resource. The measure URL remains the same when the measure is stored on different servers.</p>
</div></td></tr><tr><td>IN</td><td>periodStart</td><td/><td>1..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/><td>1..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>reportType</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td/><td><div><p>The type of measure report: <code>individual</code>, <code>subject-list</code>, or <code>summary</code>. If not specified, a default value of <code>summary</code> will be used if the subject parameter is supplied and is a <code>Group</code> resource; a default value of <code>individual</code> will be used if the subject parameter is supplied and is not a <code>Group</code> resource; otherwise, a default value of <code>summary</code> will be used. NOTE: Implementations should support the use of <code>subject</code> for <code>individual</code> and <code>population</code> for <code>summary</code> for backwards compatibility with existing implementations.</p>
</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="https://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>Subject(s) for which the measure will be calculated. Subjects provided in this parameter SHALL match the subjectType of the measure being evaluated (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). This parameter cannot be used with the subjectGroup parameter. If no subject or subjectGroup is provided, what subjects are evaluated is up to the server.</p>
</div></td></tr><tr><td>IN</td><td>subjectGroup</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/group.html">Group</a></td><td/><td><div><p>Subjects for which the measure will be evaluated, provided as a Group resource. Subjects provided in this parameter SHALL match the subjectType of the measure being evaluated. (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). This parameter cannot be used with the subject parameter. If no subject or subjectGroup is provided, what subjects are evaluated is up to the server.</p>
</div></td></tr><tr><td>IN</td><td>reporter</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a> (<a href="http://hl7.org/fhir/R4/practitioner.html" title="http://hl7.org/fhir/StructureDefinition/Practitioner">Practitioner</a>, <a href="http://hl7.org/fhir/R4/practitionerrole.html" title="http://hl7.org/fhir/StructureDefinition/PractitionerRole">PractitionerRole</a>, <a href="http://hl7.org/fhir/R4/organization.html" title="http://hl7.org/fhir/StructureDefinition/Organization">Organization</a>)<br/>(<a href="https://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>The provider for which the report will be run. This may be a reference to a Practitioner, PractitionerRole, or Organization. If specified, systems MAY use this information to determine subjects for which the measure will be calculated, but how subjects are determined is implementation-specific. This parameter is reflected in the reporter element of the resulting MeasureReport(s). This parameter cannot be used with the reporterResource parameter.</p>
</div></td></tr><tr><td>IN</td><td>reporterResource</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/practitioner.html">Practitioner</a> | <a href="http://hl7.org/fhir/R4/practitionerrole.html">PractitionerRole</a> | <a href="http://hl7.org/fhir/R4/organization.html">Organization</a></td><td/><td><div><p>The provider for which the report will be run, provided as a Practitioner, PractitionerRole, or Organization resource. This is intended to support the use case in which the organization information is not on the server performing the evaluation, for example an <a href="guidance.html#ad-hoc-organizations-for-deqm-operations">ad-hoc group of practitioners</a> that are part of a provider group. This parameter is reflected in the reporter element of the resulting MeasureReport(s). This parameter cannot be used with the reporter parameter.</p>
</div></td></tr><tr><td>IN</td><td>location</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="https://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>The location(s) for which the report will be run. This parameter is reflected in the location element of the resulting MeasureReport(s).</p>
</div></td></tr><tr><td>IN</td><td>parameters</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/parameters.html">Parameters</a></td><td/><td><div><p>Any input parameters for the Measure evaluation. If the measure uses CQL, the parameter types are mapped to CQL as specified in the Parameters and Data Requirements section of the Using CQL with FHIR Implementation Guide. Any parameters defined in this input will be bound by name to parameters defined in the logic library referenced from library element of the Measure. 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>manifest</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a> (<a href="http://hl7.org/fhir/uv/crmi/STU1/StructureDefinition-crmi-manifestlibrary.html" title="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary">CRMI Manifest Library</a>)</td><td/><td><div><p>Specifies an asset-collection library that provides dependency version resolution and expansion rules for the operation. See the description of manifest in the Canonical Resource Management Infrastructure IG for a complete description of how manifest values are used to provide defaults for dependency version resolution and expansion parameters. Parameters specified directly in the operation override behaviors specified by the manifest parameter. In general, if this parameter is supplied, it is expected to be used in nested operation calls. For example, in evaluating a measure, if the expansion of a value set is required, this parameter SHALL be supplied to that expansion.</p>
</div></td></tr><tr><td>IN</td><td>lastReceivedOn</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></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>IN</td><td>excludeEvaluatedResources</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Indicates that evaluated resources and supplemental data referenced by the MeasureReport(s) should not be included in the resulting bundles. The default for this parameter is false, so that evaluated resources are NOT included. Note that this parameter does not apply to the contained resources that are created by evaluation to communicate the results of stratification or supplemental data counts.</p>
</div></td></tr><tr><td>IN</td><td>stratifier</td><td/><td>0..*</td><td/><td/><td><div><p>Additional stratifier criteria for the measure. The resulting MeasureReport will contain this additional stratifier information as well as any stratifiers defined in the Measure being reported.</p>
</div></td></tr><tr><td>IN</td><td>stratifier.measureUrl</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>If the evaluate operation is for multiple measures, this parameter may be used to specify which measures the additional stratifier should be reported on. If not specified, the stratifier will be reported on all the measures. Note that if this results in a stratifier definition that cannot be interpreted correctly for the measure being reported, the behavior is at server discretion; it may throw an error, or simply ignore the additional stratifier definition.</p>
</div></td></tr><tr><td>IN</td><td>stratifier.groupId</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>If the measure being evaluated has multiple groups, this parameter may be used to specify which groups the additional stratifier should be reported on. If not specified, the stratifier will be reported on all groups in the measure being reported. Note that if this results in a stratifier definition that cannot be interpreted correctly for the measure group being reported, the behavior is at server discretion; it may throw an error, or simply ignore the additional stratifier definition.</p>
</div></td></tr><tr><td>IN</td><td>stratifier.component</td><td/><td>1..*</td><td/><td/><td><div><p>One or more components of the stratifier definition. Additional stratifiers are reported in the MeasureReport in the same way as stratifiers defined in the Measure.</p>
</div></td></tr><tr><td>IN</td><td>stratifier.component.code</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td>http://hl7.org/fhir/ValueSet/measure-stratifier-example (Example)</td><td><div><p>Meaning of the stratifier component.</p>
</div></td></tr><tr><td>IN</td><td>stratifier.component.description</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#markdown">markdown</a></td><td/><td><div><p>Human readable description of the stratifier component</p>
</div></td></tr><tr><td>IN</td><td>stratifier.component.criteria</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Expression">Expression</a></td><td/><td><div><p>An expression that returns the value of this component of the stratifier for a member of the population. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element, evaluated from the perspective of the measure subject. If this is a non-subject-based measure, the expression may be a reference to a function that takes an argument of the type of the measure basis, allowing the stratifier value to be determined for each member of the population.</p>
</div></td></tr><tr><td>IN</td><td>stratifier.component.valueSet</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a> (<a href="http://hl7.org/fhir/R4/valueset.html" title="http://hl7.org/fhir/StructureDefinition/ValueSet">ValueSet</a>)</td><td/><td><div><p>A value set defining possible stratifier values. If both expression and valueset are specified, they SHALL be consistent (i.e. the expression SHALL evaluate to a code that is a member of the specified valueset).</p>
</div></td></tr><tr><td>IN</td><td>stratifier.component.unit</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Indicates what units, if any, stratifier values are expected to be expressed in. This element SHOULD be specified in UCUM units or calendar units. This information SHOULD be provided if it cannot be inferred from the stsratifier expression directly.</p>
</div></td></tr><tr><td>IN</td><td>supplementalData</td><td/><td>0..*</td><td/><td/><td><div><p>What additional supplemental data should be reported with the measure. This additional data is specified in the same was as supplemental data in the Measure resource, and is reported in the same way in the MeasureReport.</p>
</div></td></tr><tr><td>IN</td><td>supplementalData.measureUrl</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>If the evaluate operation is for multiple measures, this parameter may be used to specify which measures the additional supplemental data should be reported on. If not specified, the stratifier will be reported on all the measures. Note that if this results in a stratifier definition that cannot be interpreted correctly for the measure being reported, the behavior is at server discretion; it may throw an error, or simply ignore the additional stratifier definition.</p>
</div></td></tr><tr><td>IN</td><td>supplementalData.code</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td>http://hl7.org/fhir/ValueSet/measure-supplemental-data-example (Example)</td><td><div><p>Meaning of the supplemental data.</p>
</div></td></tr><tr><td>IN</td><td>supplementalData.usage</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td><a href="http://terminology.hl7.org/7.1.0/ValueSet-measure-data-usage.html">MeasureDataUsage</a> (Extensible)</td><td><div><p>supplemental-data | risk-adjustment | factor</p>
</div></td></tr><tr><td>IN</td><td>supplementalData.description</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#markdown">markdown</a></td><td/><td><div><p>Human readable description of this supplemental data element</p>
</div></td></tr><tr><td>IN</td><td>supplementalData.criteria</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Expression">Expression</a></td><td/><td><div><p>Expression describing the additional data to be reported. This may be the name of an expression in a library, or it may be a path to a specific data element, reachable from the subject being evaluated.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>The result of this operation is a Bundle for each input subject. These Bundles SHALL contain 1..* DEQM MeasureReport resources conforming to the appropriate MeasureReport profile for the type of report, one for each measure evaluated by the operation. Subsequent entries in the bundle are evaluated resources referenced by the MeasureReport(s). See the <a href="https://hl7.org/fhir/uv/deqm/guidance.html#deqm-operation-bundles-organized-by-subject">guidance on Bundle structure</a> for discussion about the Bundle content and organization. Note that even though there is a single parameter named return of type Bundle, it is a multi-cardinality parameter, and so will still be returned using a Parameters resource, as described in the <a href="https://hl7.org/fhir/R4/operations.html#response">general operations framework</a>.</p>
</div></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cqi"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="4">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/uv/deqm/ImplementationGuide/hl7.fhir.uv.deqm"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/uv/deqm/ImplementationGuide/hl7.fhir.uv.deqm"/>
</extension>
</valueCode>
</extension>
<url value="http://hl7.org/fhir/uv/deqm/OperationDefinition/evaluate"/>
<version value="1.0.0-ballot"/>
<name value="Evaluate"/>
<title value="Evaluate Operation"/>
<status value="active"/>
<kind value="operation"/>
<date value="2026-03-23T23:41:55+00:00"/>
<publisher value="HL7 International / Clinical Quality Information"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cqi"/>
</telecom>
</contact>
<description
value="The evaluate operation is used to calculate an eMeasure and obtain the results.
It is often the case that the operation should not be performed from the server's timezone, rather the client's timezone is typically a more correct option. Note that even this isn't always correct because the evaluation may be running over data from multiple sources in different timezones. Providing guidance to the measure evaluator with the timezone header can facilitate consistent behavior."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<code value="evaluate"/>
<resource value="Measure"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="measureUrl"/>
<use value="in"/>
<min value="1"/>
<max value="*"/>
<documentation
value="The URL of the measure to be evaluated. A measure URL is specified in the [url](https://www.hl7.org/fhir/measure-definitions.html#Measure.url) element of the Measure resource. The measure URL remains the same when the measure is stored on different servers."/>
<type value="canonical"/>
</parameter>
<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="reportType"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The type of measure report: `individual`, `subject-list`, or `summary`. If not specified, a default value of `summary` will be used if the subject parameter is supplied and is a `Group` resource; a default value of `individual` will be used if the subject parameter is supplied and is not a `Group` resource; otherwise, a default value of `summary` will be used. NOTE: Implementations should support the use of `subject` for `individual` and `population` for `summary` for backwards compatibility with existing implementations."/>
<type value="code"/>
</parameter>
<parameter>
<name value="subject"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Subject(s) for which the measure will be calculated. Subjects provided in this parameter SHALL match the subjectType of the measure being evaluated (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). This parameter cannot be used with the subjectGroup parameter. If no subject or subjectGroup is provided, what subjects are evaluated is up to the server."/>
<type value="string"/>
<searchType value="reference"/>
</parameter>
<parameter>
<name value="subjectGroup"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Subjects for which the measure will be evaluated, provided as a Group resource. Subjects provided in this parameter SHALL match the subjectType of the measure being evaluated. (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). This parameter cannot be used with the subject parameter. If no subject or subjectGroup is provided, what subjects are evaluated is up to the server."/>
<type value="Group"/>
</parameter>
<parameter>
<name value="reporter"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The provider for which the report will be run. This may be a reference to a Practitioner, PractitionerRole, or Organization. If specified, systems MAY use this information to determine subjects for which the measure will be calculated, but how subjects are determined is implementation-specific. This parameter is reflected in the reporter element of the resulting MeasureReport(s). This parameter cannot be used with the reporterResource parameter."/>
<type value="string"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Organization"/>
<searchType value="reference"/>
</parameter>
<parameter>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueCode value="Practitioner"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueCode value="PractitionerRole"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueCode value="Organization"/>
</extension>
<name value="reporterResource"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The provider for which the report will be run, provided as a Practitioner, PractitionerRole, or Organization resource. This is intended to support the use case in which the organization information is not on the server performing the evaluation, for example an [ad-hoc group of practitioners](guidance.html#ad-hoc-organizations-for-deqm-operations) that are part of a provider group. This parameter is reflected in the reporter element of the resulting MeasureReport(s). This parameter cannot be used with the reporter parameter."/>
<type value="DomainResource"/>
</parameter>
<parameter>
<name value="location"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="The location(s) for which the report will be run. This parameter is reflected in the location element of the resulting MeasureReport(s)."/>
<type value="string"/>
<searchType value="reference"/>
</parameter>
<parameter>
<name value="parameters"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Any input parameters for the Measure evaluation. If the measure uses CQL, the parameter types are mapped to CQL as specified in the Parameters and Data Requirements section of the Using CQL with FHIR Implementation Guide. Any parameters defined in this input will be bound by name to parameters defined in the logic library referenced from library element of the Measure. 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="manifest"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Specifies an asset-collection library that provides dependency version resolution and expansion rules for the operation. See the description of manifest in the Canonical Resource Management Infrastructure IG for a complete description of how manifest values are used to provide defaults for dependency version resolution and expansion parameters. Parameters specified directly in the operation override behaviors specified by the manifest parameter. In general, if this parameter is supplied, it is expected to be used in nested operation calls. For example, in evaluating a measure, if the expansion of a value set is required, this parameter SHALL be supplied to that expansion."/>
<type value="canonical"/>
<targetProfile
value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary"/>
</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="excludeEvaluatedResources"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Indicates that evaluated resources and supplemental data referenced by the MeasureReport(s) should not be included in the resulting bundles. The default for this parameter is false, so that evaluated resources are NOT included. Note that this parameter does not apply to the contained resources that are created by evaluation to communicate the results of stratification or supplemental data counts."/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="stratifier"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Additional stratifier criteria for the measure. The resulting MeasureReport will contain this additional stratifier information as well as any stratifiers defined in the Measure being reported."/>
<part>
<name value="measureUrl"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="If the evaluate operation is for multiple measures, this parameter may be used to specify which measures the additional stratifier should be reported on. If not specified, the stratifier will be reported on all the measures. Note that if this results in a stratifier definition that cannot be interpreted correctly for the measure being reported, the behavior is at server discretion; it may throw an error, or simply ignore the additional stratifier definition."/>
<type value="canonical"/>
</part>
<part>
<name value="groupId"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="If the measure being evaluated has multiple groups, this parameter may be used to specify which groups the additional stratifier should be reported on. If not specified, the stratifier will be reported on all groups in the measure being reported. Note that if this results in a stratifier definition that cannot be interpreted correctly for the measure group being reported, the behavior is at server discretion; it may throw an error, or simply ignore the additional stratifier definition."/>
<type value="string"/>
</part>
<part>
<name value="component"/>
<use value="in"/>
<min value="1"/>
<max value="*"/>
<documentation
value="One or more components of the stratifier definition. Additional stratifiers are reported in the MeasureReport in the same way as stratifiers defined in the Measure."/>
<part>
<name value="code"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="Meaning of the stratifier component."/>
<type value="code"/>
<binding>
<strength value="example"/>
<valueSet
value="http://hl7.org/fhir/ValueSet/measure-stratifier-example"/>
</binding>
</part>
<part>
<name value="description"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Human readable description of the stratifier component"/>
<type value="markdown"/>
</part>
<part>
<name value="criteria"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="An expression that returns the value of this component of the stratifier for a member of the population. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element, evaluated from the perspective of the measure subject. If this is a non-subject-based measure, the expression may be a reference to a function that takes an argument of the type of the measure basis, allowing the stratifier value to be determined for each member of the population."/>
<type value="Expression"/>
</part>
<part>
<name value="valueSet"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A value set defining possible stratifier values. If both expression and valueset are specified, they SHALL be consistent (i.e. the expression SHALL evaluate to a code that is a member of the specified valueset)."/>
<type value="canonical"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/ValueSet"/>
</part>
<part>
<name value="unit"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Indicates what units, if any, stratifier values are expected to be expressed in. This element SHOULD be specified in UCUM units or calendar units. This information SHOULD be provided if it cannot be inferred from the stsratifier expression directly."/>
<type value="string"/>
</part>
</part>
</parameter>
<parameter>
<name value="supplementalData"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="What additional supplemental data should be reported with the measure. This additional data is specified in the same was as supplemental data in the Measure resource, and is reported in the same way in the MeasureReport."/>
<part>
<name value="measureUrl"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="If the evaluate operation is for multiple measures, this parameter may be used to specify which measures the additional supplemental data should be reported on. If not specified, the stratifier will be reported on all the measures. Note that if this results in a stratifier definition that cannot be interpreted correctly for the measure being reported, the behavior is at server discretion; it may throw an error, or simply ignore the additional stratifier definition."/>
<type value="canonical"/>
</part>
<part>
<name value="code"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="Meaning of the supplemental data."/>
<type value="CodeableConcept"/>
<binding>
<strength value="example"/>
<valueSet
value="http://hl7.org/fhir/ValueSet/measure-supplemental-data-example"/>
</binding>
</part>
<part>
<name value="usage"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation value="supplemental-data | risk-adjustment | factor"/>
<type value="CodeableConcept"/>
<binding>
<strength value="extensible"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/measure-data-usage|1.0.1"/>
</binding>
</part>
<part>
<name value="description"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Human readable description of this supplemental data element"/>
<type value="markdown"/>
</part>
<part>
<name value="criteria"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Expression describing the additional data to be reported. This may be the name of an expression in a library, or it may be a path to a specific data element, reachable from the subject being evaluated."/>
<type value="Expression"/>
</part>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="0"/>
<max value="*"/>
<documentation
value="The result of this operation is a Bundle for each input subject. These Bundles SHALL contain 1..* DEQM MeasureReport resources conforming to the appropriate MeasureReport profile for the type of report, one for each measure evaluated by the operation. Subsequent entries in the bundle are evaluated resources referenced by the MeasureReport(s). See the [guidance on Bundle structure](https://hl7.org/fhir/uv/deqm/guidance.html#deqm-operation-bundles-organized-by-subject) for discussion about the Bundle content and organization. Note that even though there is a single parameter named return of type Bundle, it is a multi-cardinality parameter, and so will still be returned using a Parameters resource, as described in the [general operations framework](https://hl7.org/fhir/R4/operations.html#response)."/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>
IG © 2020+ HL7 International / Clinical Quality Information.
Package hl7.fhir.uv.deqm#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-03-23
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change