STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

14.7.10 Resource Measure - Operations

This resource has 2 operations associated with it:

$evaluate-measure Evaluate Measure
$data-requirements Data Requirements

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

14.7.10.1 Evaluate Measure

The evaluate-measure operation is used to invoke an eMeasure and obtain the results

Formal Definition (as a OperationDefinition ).

URL: [base]/Measure/$evaluate-measure

URL: [base]/Measure/[id]/$evaluate-measure

In Parameters:
Name Cardinality Type Binding Profile Documentation
periodStart 1..1 date

The start of the measurement period

periodEnd 1..1 date

The end of the measurement period

measure 0..1 Reference ( Measure )

The measure to evaluate

reportType 0..1 code

The type of measure report, patient, patient-list, or population

patient 0..1 Reference ( Patient )

Patient to evaluate against

practitioner 0..1 Reference ( Practitioner )

Practitioner to evaluate

lastReceivedOn 0..1 dateTime

The date the results of this measure were last received

Out Parameters:
Name Cardinality Type Binding Profile Documentation
return 1..1 MeasureReport

The results of the measure calculation

Note: as this 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 calculate the measure for the given patient, or all patients if no patient is supplied, and return the results as a MeasureReport resource of the appropriate type

 

14.7.10.2 Data Requirements

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

Formal Definition (as a OperationDefinition ).

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

In Parameters:
Name Cardinality Type Binding Profile Documentation
periodStart 1..1 date

The start of the measurement period

periodEnd 1..1 date

The end of the measurement period

Out Parameters:
Name Cardinality Type Binding Profile Documentation
return 1..1 Library

The result of the requirements gathering

Note: as this 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)