Current Build
Clinical Quality Information Work Group Maturity Level: 2Trial Use Compartments: N/A

The collect-data operation is used to collect the data-of-interest for the given measure.

The official 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 not an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
periodStart1..1date

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 s

periodEnd1..1date

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

measure0..1string
(reference)

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

subject0..1string
(reference)

Subject for which 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 calculated for the referenced subject(s)

practitioner0..1string
(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

lastReceivedOn0..1dateTime

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

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
measureReport1..1MeasureReport

A MeasureReport of type data-collection detailing the results of the operation

resource0..*Resource

The result resources that make up the data-of-interest for the measure

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 since 2018-07-21 for Measure/measure-mrp for Patient/Practitioner-2178

GET [base]/Measure/measure-mrp/$collect-data?periodStart=2018&periodEnd=2018&subject=Patient/Practitioner-2178

GET [base]/Measure/measure-mrp/$collect-data?periodStart=2018&periodEnd=2018&subject=Patient/Practitioner-2178&lastReceivedOn=2018-07-21

Response: Returned on successful evaluation

HTTP/1.1 200 OK

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "measureReport",
      "resource": {
		  "resourceType": "MeasureReport",
		  "status": "complete",
		  "type": "data-collection",
		  "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.