Invocations

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

Parameters (In)

NameCardinalityTypeStructureDefinitionDocumentation
periodStart1..1Date

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

periodEnd1..1Date

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

measure0..1ReferenceMeasure

The 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

reportType0..1Code

The type of measure report, patient, patient-list, or population. If not specified, a default value of patient will be used if the patient parameter is supplied, otherwise, population will be used

patient0..1ReferencePatient

Patient to evaluate against. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated

practitioner0..1ReferencePractitioner

Practitioner to evaluate. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner

lastReceivedOn0..1DateTime

The 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

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1MeasureReport

The results of the measure calculation. See the MeasureReport resource for a complete description of the output of this operation

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