R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.18.10.2 Operation $data-requirements on Measure

Clinical Quality Information icon Work Group Maturity Level: 3Trial Use Compartments: N/A

The data-requirements operation aggregates and returns the parameters and data requirements for the measure and all its dependencies as a single module definition.

The canonical URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/Measure-data-requirements

Formal Definition (as a OperationDefinition).

URL: [base]/Measure/[id]/$data-requirements

This is an idempotent operation

In Parameters:
NameScopeCardinalityTypeBindingProfileDocumentation
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 start to be 2014-01-01T00:00:00 inclusive

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

Out Parameters:
NameScopeCardinalityTypeBindingProfileDocumentation
return1..1Library

The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the measure

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 determine the aggregate set of data requirements and dependencies for the measure. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the libraries referenced by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements). This operation defines what resources are subsequently referenced in the evaluatedResources element of the MeasureReport when submitting measure data

14.18.10.2.1 Examples

Request: Request data requirements for the CMS146 measure

GET [base]/Measure/CMS146/$data-requirements?periodStart=2014&periodEnd=2014

Response: Returned on successful evaluation

HTTP/1.1 200 OK

{
  "resourceType" : "Library",
  "type" : {
    "coding" : [{
      "code" : "module-definition"
    }]
  },
  "relatedArtifact" : [{
    "type" : "depends-on",
    "resource" : "http://hl7.org/fhir/Library/library-quick-model-definition"
  }],
  "dataRequirement" : [{
    "type" : "Condition",
    "codeFilter" : [{
      "path" : "code"
    }]
  },
  {
    "type" : "Patient"
  },
  {
    "type" : "Condition",
    "codeFilter" : [{
      "path" : "category"
    },
    {
      "path" : "clinicalStatus"
    },
    {
      "path" : "code"
    }]
  },
  {
    "type" : "Condition",
    "codeFilter" : [{
      "path" : "category"
    },
    {
      "path" : "clinicalStatus"
    },
    {
      "path" : "code"
    }]
  },
  {
    "type" : "Encounter",
    "codeFilter" : [{
      "path" : "status"
    },
    {
      "path" : "class"
    },
    {
      "path" : "type"
    }]
  },
  {
    "type" : "DiagnosticReport",
    "codeFilter" : [{
      "path" : "diagnosis"
    }]
  },
  {
    "type" : "Medication",
    "codeFilter" : [{
      "path" : "code"
    }]
  },
  {
    "type" : "MedicationRequest",
    "codeFilter" : [{
      "path" : "status"
    },
    {
      "path" : "medication.code"
    }]
  },
  {
    "type" : "MedicationUsage",
    "codeFilter" : [{
      "path" : "status"
    },
    {
      "path" : "medication.code"
    }]
  }]
}

 

For more information about operations, including how they are invoked, see Operations.