Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions . Page versions: R5 R4B R4

Operation-measure-collect-data

Example OperationDefinition/Measure-collect-data (Narrative)

Maturity Level : N/A
Responsible Owner: Clinical Quality Information Work Group Standards Status : Informative Compartments : Not linked to any No defined compartments

This is the narrative for the resource. See also the XML , JSON or Turtle format.

Note that this is the formal definition for the collect-data operation as an OperationDefinition on Measure. See the Operation documentation


Collect Data

OPERATION: Collect Data Generated Narrative: OperationDefinition Measure-collect-data The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/Measure-collect-data The collect-data operation is used to collect the data-of-interest for the given measure.

URL: [base]/Measure/$collect-data

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

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN measureUrl 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.

IN 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 s start to be 2014-01-01T00:00:00 inclusive

IN 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

IN measure subject 0..1 string
( reference )

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

IN subjectGroup 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 only required when being collected. (e.g. if the operation Measure.group.subjectType is invoked on Patient, the resource type, it subject SHALL be a reference to a Patient or a Group of Patients). If no subject is not provided, subjects for which data is collected is up to the server. This parameter cannot be used when invoking with the operation on a Measure instance subject parameter.

IN subject reporter 0..1 string
( reference )

Subject The provider for which the measure data-of-interest will be collected. This may be a reference to a Practitioner, PractitionerRole, or Organization. If not specified, measure data systems MAY use this information to determine subjects for which the data-of-interest will be collected for all calculated, but how subjects that meet are determined is implementation-specific. This parameter is reflected in the requirements reporter element of the measure. If specified, the measure will only resulting MeasureReport(s). This parameter cannot be calculated for used with the referenced subject(s) reporterResource parameter.

IN practitioner reporterResource 0..1 string
( reference )

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.

IN organizationResource 0..1 Organization

Practitioner Organization resource for which data-of-interest for the given measure will be collected. If specified, measure data

IN location 0..* string
( reference )

The location(s) for which the data-of-interest will be collected only for subjects that have a primary relationship to collected. This parameter is reflected in the identified practitioner location element of the resulting MeasureReport(s).

IN 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

OUT IN measureReport parameters 1..1 0..1 Parameters MeasureReport

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.

IN manifest 0..1 canonical ( Library )

A MeasureReport of type data-collection detailing Specifies an asset-collection library that provides dependency version resolution and expansion rules for the results 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.

IN validateResources 0..1 boolean

Indicates whether data collected conform to the appropriate profiles as specified by the measure.

OUT resource return 0..* Resource Bundle

The result 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 that make up SHALL have a type of data-exchange. Subsequent entries in each Bundle are resources representing the data-of-interest for the measure 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 .

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


 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.