measure $collect-data

Collect Data

Description: 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.

Comments: 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

Affects State: false

System: false

Type: true

Instance: false

URL: http://hl7.org/fhir/build/OperationDefinition/Measure-collect-data

Parameters

• measureUrl [in] 1..* 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.
• periodStart [in] 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 [in] 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
• subject [in] 0..1 string — Subject(s) for which the data-of-interest for the measure will be collected. The subject may be a Patient, Practitioner, PractitionerRole, Organization, Location, Device, or Group. Subjects provided in this parameter SHALL match the subjectType of the measure for which data is being collected (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). If no subject is provided, subjects for which data is collected is up to the server. This parameter cannot be used with the subjectGroup parameter.
• subjectGroup [in] 0..1 Group — Subjects for which the data-of-interest for the measure will be collected, provided as a Group resource. Subjects provided in this parameter SHALL match the subjectType of the measure for which data is being collected. (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). If no subject is provided, subjects for which data is collected is up to the server. This parameter cannot be used with the subject parameter.
• reporter [in] 0..1 string — 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.
• reporterResource [in] 0..1 string — The provider for which the data-of-interest will be collected, provided as an 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 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.
• organizationResource [in] 0..1 Organization — Organization resource for which data-of-interest for the given measure will be collected.
• location [in] 0..* string — 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).
• lastReceivedOn [in] 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
• parameters [in] 0..1 Parameters — 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 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.
• manifest [in] 0..1 canonical — 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 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.
• validateResources [in] 0..1 boolean — Indicates whether data collected conform to the appropriate profiles as specified by the measure.
• return [out] 0..* Bundle — The results of the data collection, returned as a Bundle for each input subject. The first entries in each Bundle are MeasureReport(s) corresponding to the measures for which data was collected. The MeasureReport resources SHALL have a type of data-exchange. Subsequent entries in each Bundle are resources representing the data-of-interest for the measures, and referenced from the evaluatedResource element of the corresponding MeasureReport resources. See the guidance on Bundle structure for discussion about the Bundle content and organization.\n\nNote that even though there is a single parameter named return of type Bundle, it is a multi-cardinality parameter, and so will still be returned using a Parameters resource, as described in the general operations framework response.