Data Exchange For Quality Measures Implementation Guide
4.0.0 - STU4
Data Exchange For Quality Measures Implementation Guide
4.0.0 - STU4
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 4.0.0 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
| Active as of 2024-05-07 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="deqm.evaluate-measure"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Measure/$deqm.evaluate-measure</p><p>URL: [base]/Measure/[id]/$deqm.evaluate-measure</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="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>program</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/us/cqfmeasures/STU4/StructureDefinition-library-cqfm.html" title="http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-cqfm">CQFM Library</a>)</td><td/><td><div><p>The quality program being reported via canonical reference to (<a href="http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-cqfm">Library{CQFMQualityProgram}</a>) indicating which quality program is being reported.</p>
</div></td></tr><tr><td>IN</td><td>programCode</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td><a href="http://hl7.org/fhir/us/cqfmeasures/STU4/ValueSet-quality-programs.html">Quality Programs</a> (Extensible)</td><td><div><p>The quality program being reported via code from the <a href="http://hl7.org/fhir/us/cqfmeasures/ValueSet/quality-programs">Reporting Program value set</a> indicating which quality program is being reported.</p>
</div></td></tr><tr><td>IN</td><td>measure</td><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#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>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: subject, subject-list, or population. If not specified, a default value of subject will be used if the subject parameter is supplied, otherwise, population will be used</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="http://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>Subject for which the measure will be calculated. If not specified, the measure will be calculated 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="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>Practitioner (references <a href="http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner">QICore Practitioner</a>) for which the measure will be calculated. If specified, the measure will be calculated 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="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>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>Returns <a href="https://www.hl7.org/fhir/parameters.html">Parameters</a> resource, which contains one or more bundles. The first entry of the bundle is either a <a href="StructureDefinition-indv-measurereport-deqm.html">DEQM Individual MeasureReport</a> or a <a href="StructureDefinition-summary-measurereport-deqm.html">DEQM Summary MeasureReport</a> and subsequent entries in the bundle are resources created and/or evaluated as part of the measure calculation. Note that the result of the $evaluate-measure operation must be returned using the Parameters resource, even when the result contains only one bundle, because the cardinality of the return parameter is specified as 0..*</p>
</div></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cqi"/>
</extension>
<url
value="http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/deqm.evaluate-measure"/>
<version value="4.0.0"/>
<name value="DEQMEvaluateMeasure"/>
<title value="DEQM Evaluate Measure"/>
<status value="active"/>
<kind value="operation"/>
<date value="2024-05-07T07:46:47+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 deqm.evaluate-measure operation is used to calculate an eMeasure and obtain the results."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<code value="deqm.evaluate-measure"/>
<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 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="program"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The quality program being reported via canonical reference to ([Library{CQFMQualityProgram}](http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-cqfm)) indicating which quality program is being reported."/>
<type value="canonical"/>
<targetProfile
value="http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-cqfm"/>
</parameter>
<parameter>
<name value="programCode"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The quality program being reported via code from the [Reporting Program value set](http://hl7.org/fhir/us/cqfmeasures/ValueSet/quality-programs) indicating which quality program is being reported."/>
<type value="CodeableConcept"/>
<binding>
<strength value="extensible"/>
<valueSet
value="http://hl7.org/fhir/us/cqfmeasures/ValueSet/quality-programs"/>
</binding>
</parameter>
<parameter>
<name value="measure"/>
<use value="in"/>
<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="reportType"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The type of measure report: subject, subject-list, or population. If not specified, a default value of subject will be used if the subject parameter is supplied, otherwise, population will be used"/>
<type value="code"/>
</parameter>
<parameter>
<name value="subject"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Subject for which the measure will be calculated. If not specified, the measure will be calculated 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 (references [QICore Practitioner](http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner)) for which the measure will be calculated. If specified, the measure will be calculated 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 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="return"/>
<use value="out"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Returns [Parameters](https://www.hl7.org/fhir/parameters.html) resource, which contains one or more bundles. The first entry of the bundle is either a [DEQM Individual MeasureReport](StructureDefinition-indv-measurereport-deqm.html) or a [DEQM Summary MeasureReport](StructureDefinition-summary-measurereport-deqm.html) and subsequent entries in the bundle are resources created and/or evaluated as part of the measure calculation. Note that the result of the $evaluate-measure operation must be returned using the Parameters resource, even when the result contains only one bundle, because the cardinality of the return parameter is specified as 0..*"/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>
IG © 2020+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.davinci-deqm#4.0.0 based on FHIR 4.0.1. Generated 2024-05-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change