Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version 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

Operation-measure-evaluate-measure

Example OperationDefinition/Measure-evaluate-measure (Narrative)

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

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

Evaluate Measure OPERATION: Evaluate Measure The official URL for

Note that this operation is the formal definition is: http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure The for the evaluate-measure operation is used to calculate as an eMeasure and obtain OperationDefinition on Measure. See the results Operation documentation

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

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

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN measure type 0..1 Measure

The measure to evaluate. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required, or a url (and optionally version) must be supplied.

IN url type 0..1 canonical

The url of the plan measure to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter (and optionally the version), or the measure parameter must be supplied

IN version type 0..1 string

The version of the measure to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter may only be used if the url parameter is supplied.

IN subject 0..1 string
( reference )

Subject for which the measure will be calculated. The subject may be a Patient, Practitioner, PractitionerRole, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the measure based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined

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 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: subject, individual, subject-list, or population. summary. If not specified, a default value of subject individual will be used if the subject parameter is supplied, otherwise, population summary will be used used. NOTE: Implementations should support the use of subject for individual and population for summary for backwards compatibility with existing implementations.

IN subject provider 0..1 string
( reference )

Subject The provider for which the measure report will be calculated. run. This may be a reference to a Practitioner, PractitionerRole, or Organization. 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 have a primary relationship to the referenced subject(s) identified provider. How this relationship is determined is implementation-specific.

IN practitioner location 0..1 string
( reference )

Practitioner The location for which the measure will be calculated. If specified, the measure report will be calculated only for subjects that have a primary relationship to the identified practitioner run.

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 IN return parameters 1..1 0..1 MeasureReport Parameters

Any input parameters for the evaluation. Parameters defined in this input will be made available by name to the CQL expression. Parameter types are mapped to CQL as specified in the Using CQL topic of the Clinical Reasoning Module. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.

OUT return 0..* Bundle

The results of the measure calculation. The result of this operation will be a Bundle for each input subject, where the first entry of the Bundle is a MeasureReport representing the results of the calculation, and subsequent entries in the Bundle are resources created and/or evaluated as part of the 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

The effect of invoking this operation is to calculate the measure for the given subject, subject(s), or all subjects if no subject is supplied, supplied. For individual and return subject-list reports, the results as result is a set of Bundles, one for each evaluated subject, where the first entry in each bundle is a MeasureReport resource resource, and subsequent entries in the Bundle are resources evaluated or created as part of the appropriate type. measure evaluation. For the summary report, the result of this operation is a single bundle with a single MeasureReport of type summary. 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.