$evaluate-measure

Evaluate Measure

draftFHIR Core package4.3.0operation7 inputs1 output

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

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure
Code
$evaluate-measure
Kind
operation
Affects State
No
Publisher
HL7 (FHIR Project)

Invocation Context

Can be invoked at:
Type LevelInstance Level
Target Resources:
Measure
Affects State:No

Implementation Notes

The effect of invoking this operation is to calculate the measure for the given subject, or all subjects if no subject is supplied, and return the results as a MeasureReport resource of the appropriate type. Note that whether or not this operation affects the state of the server depends on whether the server persists the generated MeasureReport. If the MeasureReport is not persisted, this operation can be invoked with GET

Input Parameters (7)

NameTypeCard.Description
periodStart*date1..1The 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*date1..1The 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
measurestring0..1The measure to evaluate. 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
reportTypecode0..1The type of measure report: subject, subject-list, or population. If not specified, a default value of subject will be used if the subject parameter is supplied, otherwise, population will be used
subjectstring0..1Subject for which the measure will be calculated. If not specified, the measure will be calculated for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s)
practitionerstring0..1Practitioner for which the measure will be calculated. If specified, the measure will be calculated only for subjects that have a primary relationship to the identified practitioner
lastReceivedOndateTime0..1The date the results of this measure were last received. This parameter is only valid for patient-level reports and is used to indicate when the last time a result for this patient was received. This information can be used to limit the set of resources returned for a patient-level report

Output Parameters (1)

NameTypeCard.Description
returnMeasureReport1..1The results of the measure calculation. See the MeasureReport resource for a complete description of the output of this operation. Note that implementations may choose to return a MeasureReport with a status of pending to indicate that the report is still being generated. In this case, the client can use a polling method to continually request the MeasureReport until the status is updated to complete

Additional Information

Version
4.3.0
Date
2022-05-28T12:47:40+10:00