FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3

Operation-measure-evaluate-measure

Clinical Quality Information Work Group Maturity Level : N/A Ballot Standards Status : Informative Compartments : Not linked to any defined compartments

This is the narrative for the resource. See also the XML or , JSON or Turtle format.

Evaluate Measure

OPERATION: Evaluate Measure

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure

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

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

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

Parameters

Use Name Cardinality Type Binding Documentation
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 measure 0..1 Reference string
( reference )

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

IN reportType 0..1 code

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

IN patient subject 0..1 Reference string
( reference )

Patient to evaluate against. Subject for which the measure will be calculated. If not specified, the measure will be evaluated calculated for all patients subjects that meet the requirements of the measure. If specified, only the referenced patient measure will only be evaluated calculated for the referenced subject(s)

IN practitioner 0..1 Reference string
( reference )

Practitioner to evaluate. for which the measure will be calculated. If specified, the measure will be evaluated calculated only for patients whose subjects that have a primary practitioner is relationship to the identified practitioner

IN lastReceivedOn 0..1 dateTime

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

OUT return 1..1 MeasureReport

The results of the measure calculation. See the MeasureReport resource for a complete description of the output of this operation 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

The effect of invoking this operation is to calculate the measure for the given patient, subject, or all patients subjects if no patient subject is supplied, and return the results as a MeasureReport resource of the appropriate type 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

 

 

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.