Data Exchange For Quality Measures STU1 for FHIR STU3 Implementation Guide (Release 1.0.0)

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v1.0.0: STU 1) based on FHIR R3. The current version which supercedes this version is 3.1.0. For a full list of available versions, see the Directory of published versions

collect_data

OPERATION: collect_data

The official URL for this operation definition is: 

http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/collect-data

The Collect Measure Data operation returns the MeasureReport resource and required patient resources that satisfy the data requirements for a given Measure definition.

URL: [base]/MeasureReport/[id]/$collect-data

Parameters

UseNameCardinalityTypeBindingDocumentation
INperiodStart0..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 start to be 2014-01-01T00:00:00 inclusive

INperiodEnd0..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

INpatient0..1uri

Patient to evaluate against. This is a reference to a QI Core Patient Profile e.g. 'Patient/123'. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated.

INpractitioner0..1uri

Practitioner to evaluate. This is a reference to a DEQM Practitioner e.g. 'Practitioner/123'. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner

INlastReceivedOn0..1dateTime

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. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response

OUTmeasureReport1..1MeasureReport

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

OUTresource0..*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 for reporting a measure for a patient.
  • The id of the instance endpoint, for example 'measure-mrp' in [base]/MeasureReport/measure-mrp/$collectData determines which measure data is returned.
  • The required data for each measure is discoverable by invoking the $[measure]-requirements operation on the payer's Measure endpoint.
  • If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response

Examples

Scenario:

Payer Z acting in the role of the Consumer collect Patient Z’s MRP data from Provider X which is acting in role of the Producer

Request using GET Syntax

GET [base]/MeasureReport/measure-mrp/$collect-data?patient=Patient/patient-z&provider=Practitioner/provider-x&periodStart=2018-06-19

Request using POST Syntax

POST [base]/MeasureReport/measure-mrp/$collect-data

Request body

{
   "resourceType":"Parameters",
   "parameter":[
      {
         "name":"patient",
         "valueUri":"Patient/patient-z"
      },
      {
         "name":"practitioner",
         "valueUri":"Practitioner/provider-x"
      },
      {
         "name":"periodStart",
         "valueDate":"Practitioner/2018-06-19"
       }
    ]
 }

Response

HTTP/1.1 200 OK
[other headers]

Response body

{
   "resourceType":"Parameters",
   "parameter":[
      {
         "name":"measurereport",
         "resource":"{"resourceType": "MeasureReport",
         ...}
      },
      {
        "name":"resource",
        "resource":"{"resourceType": "Task",
        ...}
      },
      {
        "name":"resource",
        "resource":"{"resourceType": "Patient",
        ...}
      },
      {
        "name":"resource",
        "resource":"{"resourceType": "Location",
          ...}
      },
      {
        "name":"resource",
        "resource":"{"resourceType": "Practitioner",
        ...}
      },
      {
        "name":"resource",
        "resource":"{"resourceType": "Organization",
        ...}
      },
      {
        "name":"resource",
        "resource":"{"resourceType": "Encounter",
        ...}
      },
      {
        "name":"resource",
        "resource":"{"resourceType": "Coverage",
        ...}
      },

    ]
 }