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="care-gaps"/>
<language value="en"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition care-gaps</b></p><a name="care-gaps"> </a><a name="hccare-gaps"> </a><p>URL: [base]/Measure/$care-gaps</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> (<a href="http://hl7.org/fhir/R4/measure.html" title="http://hl7.org/fhir/StructureDefinition/Measure">Measure</a>)</td><td/><td><div><p>The URL of a measure for which the gaps in care report will be created. 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 a <a href="glossary.html">gaps through period</a>. This may be the start of the measurement period defined by a measure, or a customized desired performance period start date determined by a payer, a provider, a measure program, and etc.</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 a <a href="glossary.html">gaps through period</a> (the gaps through date). The gaps through date could be a past date or a future date. For example, today's date is 2020-06-18, 1) if periodEnd date is 2020-09-30, it returns gaps through 2020-09-30, and 2) if the periodEnd date is 2020-05-31, it returns gaps through 2020-05-31.</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> (<a href="http://hl7.org/fhir/R4/patient.html" title="http://hl7.org/fhir/StructureDefinition/Patient">Patient</a>, <a href="http://hl7.org/fhir/R4/group.html" title="http://hl7.org/fhir/StructureDefinition/Group">Group</a>)<br/>(<a href="https://hl7.org/fhir/R4/search.html#reference">reference</a>)</td><td/><td><div><p>Subject SHALL be a reference to either a Patient or Group (e.g. Patient/123 or Group/123) Note this is a reference, providing only an id (such as 123) will not be resolvable.</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>Subject for which the gaps in care report will be created is provided as a Group resource.</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> (<a href="http://hl7.org/fhir/R4/location.html" title="http://hl7.org/fhir/StructureDefinition/Location">Location</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 gaps in care 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>status</td><td/><td>1..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-deqm-gaps-status.html">DEQM Gaps In Care Gap Status Value Set</a> (Extensible)</td><td><div><p>Indicates status of a care gap. For all [open, closed, and prospective gaps], three seperate status parameters must be provided. For a positive proportion measure, gap means the patient is not in the numerator. For an inverse (negative) proportion measure (e.g., Diabetes: Hemoglobin A1c (HbA1c) Poor Control (> 9%)), gap means the patient is in the numerator.</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></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>isDocument</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>The isDocument parameter controls whether a Gaps in Care Composition is returned in the Bundle (i.e. if the Bundle is of type 'Document'). When 'true,' the returned Bundles contain the Gaps in Care Composition. This parameter defaults to 'true.'</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 $care-gaps operation returns <a href="https://www.hl7.org/fhir/parameters.html">Parameters</a> resource, containing zero or more document bundles that conform to the <a href="StructureDefinition-deqm-gapsincarebundle.html">DEQM Gaps In Care Bundle Profile</a>. Note that the result of the $care-gaps 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..*. When these Bundles optionally contain <a href="StructureDefinition-deqm-gapsincarecomposition.html">DEQM Gaps In Care Composition Profile</a>, then they are limited to a single subject. If these Bundles do not contain the Composition Profile, they SHOULD be for a single subject. See the <a href="guidance.html#deqm-operation-bundles-organized-by-subject">guidance on Bundle structure</a> for discussion about the Bundle content and organization.</p>
</div></td></tr></table><div><p>The effect of invoking this operation is to calculate a measure or a set of measures based on the In Parameters provided and to return Parameters resource containing one or more document bundles describing the gaps in care results of each measure, for the specified gaps through period and for the given subject (a patient or a group of patients). Because more than one bundle may be returned, the operation parameter must always be returned. Note that it is up to the Server to determine whether or not the generated gaps in care report is persisted. If the Server does not persist the results, the operation does not affect state and can be invoked with a GET. Note that this operation is intended to replace the existing base Measure $care-gaps operation in FHIR R5.</p>
</div></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/care-gaps"/>
<version value="1.0.0-ballot"/>
<name value="CareGaps"/>
<title value="Care Gaps Operation"/>
<status value="active"/>
<kind value="operation"/>
<date value="2021-04-23"/>
<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 care-gaps operation is used to determine gaps in care for a specified gaps through period based on the results of quality measures.
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="care-gaps"/>
<comment
value="The effect of invoking this operation is to calculate a measure or a set of measures based on the In Parameters provided and to return Parameters resource containing one or more document bundles describing the gaps in care results of each measure, for the specified gaps through period and for the given subject (a patient or a group of patients). Because more than one bundle may be returned, the operation parameter must always be returned. Note that it is up to the Server to determine whether or not the generated gaps in care report is persisted. If the Server does not persist the results, the operation does not affect state and can be invoked with a GET. Note that this operation is intended to replace the existing base Measure $care-gaps operation in FHIR R5."/>
<base value="http://hl7.org/fhir/OperationDefinition/Measure-care-gaps"/>
<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 a measure for which the gaps in care report will be created. 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"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure"/>
</parameter>
<parameter>
<name value="periodStart"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The start of a [gaps through period](glossary.html). This may be the start of the measurement period defined by a measure, or a customized desired performance period start date determined by a payer, a provider, a measure program, and etc."/>
<type value="date"/>
</parameter>
<parameter>
<name value="periodEnd"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The end of a [gaps through period](glossary.html) (the gaps through date). The gaps through date could be a past date or a future date. For example, today's date is 2020-06-18, 1) if periodEnd date is 2020-09-30, it returns gaps through 2020-09-30, and 2) if the periodEnd date is 2020-05-31, it returns gaps through 2020-05-31."/>
<type value="date"/>
</parameter>
<parameter>
<name value="subject"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Subject SHALL be a reference to either a Patient or Group (e.g. Patient/123 or Group/123) Note this is a reference, providing only an id (such as 123) will not be resolvable."/>
<type value="string"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/>
<searchType value="reference"/>
</parameter>
<parameter>
<name value="subjectGroup"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Subject for which the gaps in care report will be created is provided as a Group resource."/>
<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">
<valueUri value="Practitioner"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="PractitionerRole"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri 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 gaps in care report will be run. This parameter is reflected in the location element of the resulting MeasureReport(s)."/>
<type value="string"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Location"/>
<searchType value="reference"/>
</parameter>
<parameter>
<name value="status"/>
<use value="in"/>
<min value="1"/>
<max value="*"/>
<documentation
value="Indicates status of a care gap. For all [open, closed, and prospective gaps], three seperate status parameters must be provided. For a positive proportion measure, gap means the patient is not in the numerator. For an inverse (negative) proportion measure (e.g., Diabetes: Hemoglobin A1c (HbA1c) Poor Control (> 9%)), gap means the patient is in the numerator."/>
<type value="code"/>
<binding>
<strength value="extensible"/>
<valueSet
value="http://hl7.org/fhir/uv/deqm/ValueSet/deqm-gaps-status"/>
</binding>
</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"/>
</parameter>
<parameter>
<name value="isDocument"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The isDocument parameter controls whether a Gaps in Care Composition is returned in the Bundle (i.e. if the Bundle is of type 'Document'). When 'true,' the returned Bundles contain the Gaps in Care Composition. This parameter defaults to 'true.'"/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="0"/>
<max value="*"/>
<documentation
value="The $care-gaps operation returns [Parameters](https://www.hl7.org/fhir/parameters.html) resource, containing zero or more document bundles that conform to the [DEQM Gaps In Care Bundle Profile](StructureDefinition-deqm-gapsincarebundle.html). Note that the result of the $care-gaps 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..*. When these Bundles optionally contain [DEQM Gaps In Care Composition Profile](StructureDefinition-deqm-gapsincarecomposition.html), then they are limited to a single subject. If these Bundles do not contain the Composition Profile, they SHOULD be for a single subject. See the [guidance on Bundle structure](guidance.html#deqm-operation-bundles-organized-by-subject) for discussion about the Bundle content and organization."/>
<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-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change