R6 Ballot (3rd Draft) FHIR CI-Build

Publish-box (todo) This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example OperationDefinition/Measure-collect-data (Narrative)

Maturity Level : N/A
Responsible Owner: Clinical Quality Information Work Group Standards Status : Informative Compartments : 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


Generated Narrative: OperationDefinition Measure-collect-data

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 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 measureId 0..* id The id of a Measure resource that is on the server for which the data-of-interest will be collected. E.g., the id of the Measure resource for Breast Cancer Screening measure. IN measureIdentifier subject 0..* 0..1 string
( token reference )

The business identifier of a measure Subject(s) for which the data-of-interest for the measure will be collected. E.g., CMS125 is The subject may be a CMS assigned identifier for the Breast Cancer Screening eCQM Patient, Practitioner, PractitionerRole, Organization, Location, Device, or Group. Subjects provided in their system. Note that the type of 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 string with reference to a search type Patient or a Group of token, so Patients). If no subject is provided, subjects for which data is collected is up to the $care-gaps operation has only simple input parameters and may server. This parameter cannot be invoked using GET. used with the subjectGroup parameter.

IN measureUrl subjectGroup 0..* 0..1 canonical Group

This the the URL of a measure Subjects for which the data-of-interest for the measure will be collected. A measure URL is specified collected, provided as a Group resource. Subjects provided in this parameter SHALL match the url element subjectType of the Measure resource. The measure URL remains for which data is being collected. (e.g. if the same when Measure.group.subjectType is Patient, the measure subject SHALL be a reference to a Patient or a Group of Patients). If no subject is stored on different servers. IN measureResource 0..* Measure The measure provided, subjects for which the data-of-interest will be data is collected is provided as a Measure resource. up to the server. This parameter cannot be used with the subject parameter.

IN measure reporter 0..* 0..1 string
( token reference )

The measure 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 only required when reflected in the operation is invoked on reporter element of the resource type, it is not resulting MeasureReport(s). This parameter cannot be used when invoking with the operation on a Measure instance reporterResource parameter.

IN subject reporterResource 0..1 string
( reference )

Subject The provider for which the data-of-interest for the measure will be collected. If collected, provided as an Organization resource. This is intended to support the use case in which the organization information is not specified, measure data will be collected on the server performing the evaluation, for all subjects example an ad-hoc group of practitioners that meet the requirements are part of a provider group. This parameter is reflected in the measure. If specified, reporter element of the measure will only resulting MeasureReport(s). This parameter cannot be collected for used with the referenced subject(s). reporter parameter.

IN subjectGroup organizationResource 0..1 Group Organization

Subject Organization resource for which the data-of-interest for the given measure will be collected is provided as a Group resource. collected.

IN practitioner location 0..1 0..* string
( reference )

Practitioner The location(s) for which the measure data-of-interest will be collected. If specified, measure data will be collected only for subjects that have a primary relationship to 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

IN organizationResource parameters 0..1 Organization Parameters

Organization resource for which data-of-interest Any input parameters for the given measure evaluation. Parameters defined in this input will be collected. 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 organization manifest 0..1 string canonical ( reference Library )

Organization Specifies an asset-collection library that provides dependency version resolution and expansion rules for which data-of-interest 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 given measure will operation override behaviors specified by the manifest parameter. In general, if this parameter is supplied, it is expected to be collected. 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 return 0..* Bundle

Returns Parameters resource, which contains one or more bundles. The first entry results of the bundle is data collection, returned as a MeasureReport and subsequent Bundle for each input subject. The first entries in the bundle each Bundle are MeasureReport(s) corresponding to the measures for which data was collected. The MeasureReport resources created and/or evaluated as part SHALL have a type of data-exchange. Subsequent entries in each Bundle are resources representing the measure calculation. Note that data-of-interest for the result measures, and referenced from the evaluatedResource element of the $evaluate operation must 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 the a Parameters resource, even when the result contains only one bundle, because the cardinality of the return parameter is specified as 0..* 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.