Data Exchange For Quality Measures Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-deqm/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/deqm/OperationDefinition/evaluate | Version: 1.0.0-cibuild | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: Evaluate | |||
The evaluate operation is used to calculate an eMeasure and obtain the results. It is often the case that the operation should not be performed from the server's timezone, rather the client's timezone is typically a more correct option. Note that even this isn't always correct because the evaluation may be running over data from multiple sources in different timezones. Providing guidance to the measure evaluator with the timezone header can facilitate consistent behavior.
The type of the return parameter of this $evaluate is Bundle.
Language: en
URL: [base]/Measure/$evaluate
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | measureUrl | 1..* | canonical | The URL of the measure(s) to be evaluated. A measure URL is specified in the url element of the Measure resource. The measure URL remains the same when the measure is stored on different servers. | ||
| 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 | reportType | 0..1 | code | The type of measure report: | ||
| IN | subject | 0..1 | string (reference) | Subject(s) for which the measure will be calculated. Subjects provided in this parameter SHALL match the subjectType of the measure being evaluated (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). This parameter cannot be used with the subjectGroup parameter. If no subject or subjectGroup is provided, what subjects are evaluated is up to the server. | ||
| IN | subjectGroup | 0..1 | Group | Subjects provided in this parameter SHALL match the subjectType of the measure being evaluated. (e.g. if the Measure.group.subjectType is Patient, the provided subjectGroup SHALL be a Group of Patients). This parameter cannot be used with the subject parameter. If no subject or subjectGroup is provided, what subjects are evaluated is up to the server. | ||
| IN | reporter | 0..1 | string (reference) | The provider for which the report will be run. This may be a reference to a Practitioner, PractitionerRole, or Organization. If specified, systems MAY use this information to determine subjects for which the measure will be calculated, but how subjects are determined is implementation-specific. This parameter is reflected in the reporter element of the resulting MeasureReport(s). This parameter cannot be used with the reporterResource parameter. | ||
| IN | reporterResource | 0..1 | Practitioner | PractitionerRole | Organization | The provider for which the report will be run, provided as a Practitioner, PractitionerRole, or Organization resource. This is intended to support the use case in which the organization information is not on the server performing the evaluation, for example an ad-hoc group of practitioners that are part of a provider group. This parameter is reflected in the reporter element of the resulting MeasureReport(s). This parameter cannot be used with the reporter parameter. | ||
| IN | location | 0..* | string (reference) | The location(s) for which the report will be run. This parameter is reflected in the location element of the resulting MeasureReport(s). | ||
| IN | parameters | 0..1 | 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 with FHIR implementation guide. 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. | ||
| IN | manifest | 0..1 | canonical (CRMI Manifest Library, Library) | Specifies an asset-collection library that provides dependency version resolution and expansion rules for the operation. See the version manifest discussion in the [Canonical Resource Management Infrastructure IG](http://hl7.org/fhir/uv/crmi/version-manifes t.html) for a complete description of how manifest values are used to provide defaults for dependency version resolution and expansion parameters. Parameters specified directly in the operation override behaviors specified by the manifest parameter. In general, if this parameter is supplied, it is expected to be used in nested operation calls. For example, in evaluating a measure, if the expansion of a value set is required, this parameter SHALL be supplied to that expansion. | ||
| 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 | 0..* | Bundle | The results of the measure evaluation, returned as a Bundle for each input subject for individual reports or a single bundle for summary and subject list reports. The first entries in each Bundle are MeasureReport(s) corresponding to the measures that were calculated. Subsequent entries in each Bundle are resources representing the data that was created or referenced during the calculation of the measures, and referenced from the appropriate element of the corresponding MeasureReport resources. See the guidance on Bundle structure for discussion about the Bundle content and organization. Note that even though there is a single parameter named return of type Bundle, it is a multi-cardinality parameter, and so will still be returned using a Parameters resource, as described in the general operations framework response. |