FHIR CI-Build

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)

Clinical Quality Information Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: 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

UseNameScopeCardinalityTypeBindingDocumentation
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 0..* string
(token)

The business identifier of a measure for which the data-of-interest will be collected. E.g., CMS125 is a CMS assigned identifier for the Breast Cancer Screening eCQM in their system. Note that the type of this parameter is a string with a search type of token, so the $care-gaps operation has only simple input parameters and may be invoked using GET.

IN measureUrl 0..* 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 measureResource 0..* Measure

The measure for which the data-of-interest will be collected is provided as a Measure resource.

IN measure 0..* string
(token)

The measure for which the data-of-interest will be collected. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance

IN subject 0..1 string
(reference)

Subject for which the data-of-interest for the measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be collected for the referenced subject(s).

IN subjectGroup 0..1 Group

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

IN practitioner 0..1 string
(reference)

Practitioner for which the measure will be collected. If specified, measure data will be collected only for subjects that have a primary relationship to the identified practitioner

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 0..1 Organization

Organization resource for which data-of-interest for the given measure will be collected.

IN organization 0..1 string
(reference)

Organization for which data-of-interest for the given measure will be collected.

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 of the bundle is a MeasureReport and subsequent entries in the bundle are resources created and/or evaluated as part of the measure calculation. Note that the result of the $evaluate operation must be returned using the Parameters resource, even when the result contains only one bundle, because the cardinality of the return parameter is specified as 0..*

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.