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: 2 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="collect-data"/>
<language value="en"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition collect-data</b></p><a name="collect-data"> </a><a name="hccollect-data"> </a><p>URL: [base]/Measure/$collect-data</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>This the the URL of a measure for which the data-of-interest will be collected. A measure URL is specified in the url 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>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 for which the data-of-interest for the measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be collected for the referenced subject(s).</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 data-of-interest for measure will be collected 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>)</td><td/><td><div><p>The provider for which the data-of-interest will be collected. This may be a reference to a Practitioner, PractitionerRole, or Organization. If specified, systems MAY use this information to determine subjects for which the data-of-interest 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 data-of-interest will be collected, 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="clinicalreasoning-quality-reporting.html#ad-hoc-organizations">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 data-of-interest will be collected. This parameter is reflected in the location element of the resulting MeasureReport(s).</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 used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios.</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 evaluation. Parameters defined in this input will be made available by name to the CQL expression. Parameter types are mapped to CQL as specified in the <a href="https://hl7.org/fhir/uv/cql/">Using CQL with FHIR</a> 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>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/R4/library.html" title="http://hl7.org/fhir/StructureDefinition/Library">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 version manifest discussion in the <a href="http://hl7.org/fhir/uv/crmi/version-manifest.html">Canonical Resource Management Infrastructure IG</a> 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>validateResources</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 whether data collected conform to the appropriate profiles as specified by the measure.</p>
</div></td></tr><tr><td>IN</td><td>dataEndpoint</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/endpoint.html">Endpoint</a></td><td/><td><div><p>An endpoint to use to collect the data of interest for the specified measures. If provided, this endpoint SHALL be used instead of data available on the server. This is useful when a provider system wants to submit the data of interest for a measure or set of measures, but wants that data gathered from its public endpoint, rather than determining the data requirements of the measures directly. Note that when this parameter is provided, the bundles resulting from the operation SHALL NOT contain the referenced data, only the MeasureReport resources, since the requesting system already has the data in the provided endpoint.</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>These Bundles SHALL contain 1..* DEQM Data Exchange MeasureReports with data-of-interest and 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>
</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>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cqi"/>
</extension>
<url value="http://hl7.org/fhir/uv/deqm/OperationDefinition/collect-data"/>
<version value="1.0.0-ballot"/>
<name value="CollectData"/>
<title value="Collect Data"/>
<status value="active"/>
<kind value="operation"/>
<date value="2024-07-24T10:53:32-05: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 collect-data operation is used to collect the data-of-interest for the given measure."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<code value="collect-data"/>
<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="This the the URL of a measure for which the data-of-interest will be collected. A measure URL is specified in the 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="subject"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Subject for which the data-of-interest for the measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be collected for the referenced subject(s)."/>
<type value="string"/>
<searchType value="reference"/>
</parameter>
<parameter>
<name value="subjectGroup"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Subject for which the data-of-interest for measure will be collected 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 data-of-interest will be collected. This may be a reference to a Practitioner, PractitionerRole, or Organization. If specified, systems MAY use this information to determine subjects for which the data-of-interest 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"/>
</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 data-of-interest will be collected, 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](clinicalreasoning-quality-reporting.html#ad-hoc-organizations) 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 data-of-interest will be collected. 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="lastReceivedOn"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The date the results of this measure were last received. This parameter used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios."/>
<type value="dateTime"/>
</parameter>
<parameter>
<name value="parameters"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Any input parameters for the evaluation. Parameters defined in this input will be made available by name to the CQL expression. Parameter types are mapped to CQL as specified in the [Using CQL with FHIR](https://hl7.org/fhir/uv/cql/) 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="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 version manifest discussion in the [Canonical Resource Management Infrastructure IG](http://hl7.org/fhir/uv/crmi/version-manifest.html) 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/StructureDefinition/Library"/>
</parameter>
<parameter>
<name value="validateResources"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Indicates whether data collected conform to the appropriate profiles as specified by the measure."/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="dataEndpoint"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="An endpoint to use to collect the data of interest for the specified measures. If provided, this endpoint SHALL be used instead of data available on the server. This is useful when a provider system wants to submit the data of interest for a measure or set of measures, but wants that data gathered from its public endpoint, rather than determining the data requirements of the measures directly. Note that when this parameter is provided, the bundles resulting from the operation SHALL NOT contain the referenced data, only the MeasureReport resources, since the requesting system already has the data in the provided endpoint."/>
<type value="Endpoint"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="0"/>
<max value="*"/>
<documentation
value="These Bundles SHALL contain 1..* DEQM Data Exchange MeasureReports with data-of-interest and 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-24
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change