R6 Ballot (3rd Draft)
Clinical ReasoningThis page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Clinical Quality Information Work Group | Maturity Level: 3 | Trial Use | Compartments: N/A |
The collect-data operation is used to collect the data-of-interest for the given measure. Note that the use of the X-Provenance header data with data that establishes provenance being submitted/collected SHOULD be supported. This provides the capability for associating the provider with the data submitted through the $collect-data transaction. If the X-Provenance header is used it should be consistent with the reporter element in the DEQM Data Exchange MeasureReport Profile.
The canonical URL for this operation definition is
http://hl7.org/fhir/OperationDefinition/Measure-collect-data
Formal Definition (as a OperationDefinition).
URL: [base]/Measure/$collect-data
URL: [base]/Measure/[id]/$collect-data
This is an idempotent operation
| In Parameters: | ||||||
| Name | Scope | Cardinality | Type | Binding | Profile | Documentation |
| periodStart | 1..1 | date | 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 | |||
| periodEnd | 1..1 | date | 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 | |||
| measureId | 0..* | id | The id of a Measure resource that is on the server for which the data-of-interest will be collected. E.g., the id of the Measure resource for Breast Cancer Screening measure. | |||
| measureIdentifier | 0..* | string (token) |
The business identifier of a measure for which the data-of-interest will be collected. E.g., CMS125 is a CMS assigned identifier for the Breast Cancer Screening eCQM in their system. Note that the type of this parameter is a string with a search type of token, so the $care-gaps operation has only simple input parameters and may be invoked using GET. | |||
| measureUrl | 0..* | canonical | 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. | |||
| measureResource | 0..* | Measure | The measure for which the data-of-interest will be collected is provided as a Measure resource. | |||
| measure | 0..* | string (token) |
The measure for which the data-of-interest will be collected. 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 | |||
| subject | 0..1 | string (reference) |
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). | |||
| subjectGroup | 0..1 | Group | Subject for which the data-of-interest for measure will be collected is provided as a Group resource. | |||
| practitioner | 0..1 | string (reference) |
Practitioner for which the measure will be collected. If specified, measure data will be collected only for subjects that have a primary relationship to the identified practitioner | |||
| lastReceivedOn | 0..1 | dateTime | 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 | |||
| organizationResource | 0..1 | Organization | Organization resource for which data-of-interest for the given measure will be collected. | |||
| organization | 0..1 | string (reference) |
Organization for which data-of-interest for the given measure will be collected. | |||
| validateResources | 0..1 | boolean | Indicates whether data collected conform to the appropriate profiles as specified by the measure. | |||
| Out Parameters: | ||||||
| Name | Scope | Cardinality | Type | Binding | Profile | Documentation |
| return | 0..* | Bundle | Returns Parameters Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource | |||
The effect of invoking this operation is to gather the data required to perform an evaluation of the measure. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response. Note that the resulting MeasureReport is a transient resource
Request: Request the data-of-interest for Measure/measure-mrp for Patient/Practitioner-2178 for all of 2018
GET [base]/Measure/$collect-data?measureId=measure-mrp&periodStart=2018&periodEnd=2018&subject=Patient/Practitioner-2178
Request: Request the data-of-interest since 2018-07-21 for Measure/measure-mrp for Patient/Practitioner-2178
GET [base]/Measure/$collect-data?measureId=measure-mrp&periodStart=2018&periodEnd=2018&subject=Patient/Practitioner-2178&lastReceivedOn=2018-07-21
Request: Request the data-of-interest for Measure/measure-mrp with a subject of group 124
GET [base]/Measure/$collect-data?measureId=measure-mrp&periodStart=2018-01&periodEnd=2018-03&subjectGroup=124
Request: Request the data-of-interest for a measure using measureIdentifier
GET [base]/Measure/$collect-data?measureIdentifier=http://hl7.org/fhir/cqi/ecqm/Measure/Identifier/cms|130&periodStart=2018-01&periodEnd=2018-03&subject=Patient/124
Request: Request the data-of-interest for a measure using the measureUrl
GET [base]/Measure/$collect-data?measureUrl=http://hl7.org/fhir/us/cqfmeasures/Measure/EXM130|7.3.000&periodStart=2018-01&periodEnd=2018-03&subject=Patient/124
Request: Request the data-of-interest for a measure with an organization instead of a subject.
GET [base]/Measure/$collect-data?measureIdentifier=http://hl7.org/fhir/cqi/ecqm/Measure/Identifier/cms|130&periodStart=2014-01&periodEnd=2014-03&organization=Organization/124
Request: Request the data-of-interest for a measure with an organization and practitioner instead of subject
GET [base]/Measure/$collect-data?measureUrl=http://hl7.org/fhir/us/cqfmeasures/Measure/EXM130|7.3.000&periodStart=2014-01&periodEnd=2014-03&organization=Organization/124&practitioner=Practitioner/124
Response: Returned on successful evaluation
HTTP/1.1 200 OK
{
"resourceType": "Parameters",
"parameter": [
{
"name": "measureReport",
"resource": {
"resourceType": "MeasureReport",
"status": "complete",
"type": "data-exchange",
"measure": "Measure/measure-mrp",
"patient": {
"reference": "Patient/Practitioner-2178"
},
"period": {
"start": "2017-01-01T00:00:00+00:00",
"end": "2017-12-31T00:00:00+00:00"
},
"evaluatedResource": [
{
"reference": "Patient/Practitioner-2178"
},
{
"reference": "Encounter/Encounter-62912"
},
{
"reference": "Procedure/Procedure-89972"
}
]
}
},
{
"name": "resource",
"resource": {
"resourceType": "Patient",
"id": "Practitioner-2178",
"meta": {
"versionId": "8",
"lastUpdated": "2018-05-31T07:15:08.000+00:00",
"profile": [
"http://hl7.org/fhir/us/hedis/StructureDefinition/hedis-patient"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Natalie Huff <b>WALTER </b></div><table class=\"hapiPropertyTable\"><tbody><tr><td>Identifier</td><td>000002418</td></tr><tr><td>Address</td><td><span>623 SW French Place </span><br/><span>Westland </span><span>MI </span></td></tr><tr><td>Date of birth</td><td><span>26 July 1974</span></td></tr></tbody></table></div>"
},
"extension": [
{
"url": "http://mihin.org/extension/copyright",
"valueString": "Copyright 2014-2017 Michigan Health Information Network Shared Services. Licensed under the Apache License, Version 2.0 (the 'License'); you can not use this file except in compliance with the License. You can obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License."
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/Race",
"code": "2106-3",
"display": "White"
}
]
}
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/Ethnicity",
"code": "2186-5",
"display": "Not Hispanic or Latino"
}
]
}
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-religion",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/ReligiousAffiliation",
"code": "1020",
"display": "Hinduism"
}
]
}
}
],
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SB",
"display": "Social Beneficiary Identifier"
}
],
"text": "US Social Security Number"
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "000002418"
}
],
"active": true,
"name": [
{
"family": "Walter",
"given": [
"Natalie",
"Huff"
]
}
],
"telecom": [
{
"system": "phone",
"value": "248-555-3608",
"use": "home"
},
{
"system": "phone",
"value": "248-555-4649",
"use": "mobile"
}
],
"gender": "female",
"birthDate": "1974-07-26",
"address": [
{
"use": "home",
"type": "postal",
"line": [
"623 SW French Place"
],
"city": "Westland",
"district": "Wayne County",
"state": "MI",
"postalCode": "48185"
}
]
}
},
{
"name": "resource",
"resource": {
"resourceType": "Encounter",
"id": "Encounter-62912",
"meta": {
"versionId": "1",
"lastUpdated": "2018-05-31T08:21:50.000+00:00",
"profile": [
"http://hl7.org/fhir/us/hedis/StructureDefinition/hedis-encounter"
]
},
"extension": [
{
"url": "http://mihin.org/extension/copyright",
"valueString": "Copyright 2014-2017 Michigan Health Information Network Shared Services. Licensed under the Apache License, Version 2.0 (the 'License'); you can not use this file except in compliance with the License. You can obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License."
}
],
"status": "finished",
"class": {
"system": "http://hl7.org/fhir/encounter-class",
"code": "inpatient",
"display": "Inpatient"
},
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "56876005",
"display": "Drug rehabilitation and detoxification"
}
]
}
],
"subject": {
"reference": "Patient/Practitioner-2178",
"display": "Natalie Huff Walter"
},
"period": {
"start": "2018-05-29T11:00:00-04:00",
"end": "2018-05-29T11:00:00-04:00"
},
"hospitalization": {
"dischargeDisposition": {
"coding": [
{
"system": "http://hl7.org/fhir/discharge-disposition",
"code": "home",
"display": "Home"
}
]
}
}
}
},
{
"name": "resource",
"resource": {
"resourceType": "Procedure",
"id": "Procedure-89972",
"meta": {
"versionId": "1",
"lastUpdated": "2018-05-30T23:56:19.000+00:00",
"profile": [
"http://hl7.org/fhir/us/hedis/StructureDefinition/hedis-procedure"
]
},
"extension": [
{
"url": "http://mihin.org/extension/copyright",
"valueString": "Copyright 2014-2017 Michigan Health Information Network Shared Services. Licensed under the Apache License, Version 2.0 (the 'License'); you can not use this file except in compliance with the License. You can obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License."
}
],
"identifier": [
{
"system": "mihin.org/fhir/sid/elementId",
"value": "ca097928-b18c-406c-a01b-6ad4a321fc28"
}
],
"status": "completed",
"code": {
"coding": [
{
"system": "http://www.ama-assn.org/go/cpt",
"code": "1111F",
"display": "Medication reconciliation postdischarge"
}
]
},
"subject": {
"reference": "Patient/Practitioner-2178",
"display": "Natalie Huff Walter"
},
"performedPeriod": {
"start": "2018-06-02T14:00:00-05:00",
"end": "2018-06-02T14:00:00-05:00"
}
}
}
]
}
For more information about operations, including how they are invoked, see Operations.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot3 generated on Tue, Apr 1, 2025 12:25+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change