Data Exchange For Quality Measures Implementation Guide
5.0.0-ballot - STU5 Ballot
Data Exchange For Quality Measures Implementation Guide
5.0.0-ballot - STU5 Ballot
This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v5.0.0-ballot: STU5 (v5.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.0.0. For a full list of available versions, see the Directory of published versions
| Active as of 2024-08-27 |
{
"resourceType" : "OperationDefinition",
"id" : "evaluate",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition evaluate</b></p><a name=\"evaluate\"> </a><a name=\"hcevaluate\"> </a><a name=\"evaluate-en-US\"> </a><p>URL: [base]/Measure/$evaluate</p><p>URL: [base]/Measure/[id]/$evaluate</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>periodStart</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>periodEnd</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>manifest</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a> (<a href=\"http://hl7.org/fhir/uv/crmi/1.0.0-snapshot/StructureDefinition-crmi-manifestlibrary.html\" title=\"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary\">CRMI Manifest Library</a>)</td><td/><td><div><p>Specifies an asset-collection library that provides dependency version resolution and expansion rules for the operation. See the description of manifest in the Canonical Resource Management Infrastructure IG 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.</p>\n</div></td></tr><tr><td>IN</td><td>programCode</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td><a href=\"http://hl7.org/fhir/us/cqfmeasures/2024May/ValueSet-quality-programs-example.html\">Quality Programs Example</a> (Extensible)</td><td><div><p>The quality program being reported via code from the <a href=\"http://hl7.org/fhir/us/cqfmeasures/ValueSet/quality-programs-example\">Reporting Program value set</a> indicating which quality program is being reported.</p>\n</div></td></tr><tr><td>IN</td><td>measureId</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#id\">id</a></td><td/><td><div><p>The id of a Measure resource that is on the server for which the measure will be evaluated. E.g., the id of the Measure resource for Breast Cancer Screening measure.</p>\n</div></td></tr><tr><td>IN</td><td>measureIdentifier</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>The business identifier of the measure to be evaluated. E.g., CMS125 is a CMS assigned identifier for the Breast Cancer Screening eCQM in their system.</p>\n</div></td></tr><tr><td>IN</td><td>measureUrl</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>The URL of the measure to be evaluated. A measure URL is specified in the <a href=\"https://www.hl7.org/fhir/measure-definitions.html#Measure.url\">url</a> element of the Measure resource. The measure URL remains the same when the measure is stored on different servers.</p>\n</div></td></tr><tr><td>IN</td><td>measure</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>measureResource</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/measure.html\">Measure</a></td><td/><td><div><p>The measure to be evaluated is provided as a Measure resource.</p>\n</div></td></tr><tr><td>IN</td><td>reportType</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td><div><p>The 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</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Subject for which the measure will be evaluated. If not specified, the measure will be evaluated for all subjects that meet the requirements of the measure. If specified, the measure will only be evaluated for the referenced subject(s)</p>\n</div></td></tr><tr><td>IN</td><td>subjectGroup</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/group.html\">Group</a></td><td/><td><div><p>Subject for which the measure will be evaluated provided as a Group resource.</p>\n</div></td></tr><tr><td>IN</td><td>parameters</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters</a></td><td/><td><div><p>Any input parameters for the Measure evaluation. If the measure uses CQL, the parameter types are mapped to CQL as specified in the Parameters and Data Requirements section of the Using CQL with FHIR Implementation Guide. Any parameters defined in this input will be bound by name to parameters defined in the logic library referenced from library element of the Measure. 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.</p>\n</div></td></tr><tr><td>IN</td><td>practitioner</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Practitioner (references <a href=\"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner\">QICore Practitioner</a>) for which the measure will be evaluated. If specified, the measure will be evaluated only for subjects that have a primary relationship to the identified practitioner</p>\n</div></td></tr><tr><td>IN</td><td>lastReceivedOn</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>reporter</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>A reference to an Organization that will be populated in the MeasureReport.reporter</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>Returns <a href=\"https://www.hl7.org/fhir/parameters.html\">Parameters</a> resource, which contains one or more bundles. The first entry of the bundle is either a <a href=\"StructureDefinition-indv-measurereport-deqm.html\">DEQM Individual MeasureReport</a>, a <a href=\"StructureDefinition-summary-measurereport-deqm.html\">DEQM Summary MeasureReport</a>, or a <a href=\"StructureDefinition-subjectlist-measurereport-deqm.html\">DEQM Subject List MeasureReport</a> and subsequent entries in the bundle are resources created and/or evaluated as part of the measure calculation. Note that the result of the $evaluate operation must be returned using the Parameters resource, even when the result contains only one bundle, because the cardinality of the return parameter is specified as 0..*</p>\n</div></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cqi"
}
],
"url" : "http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/evaluate",
"version" : "5.0.0-ballot",
"name" : "Evaluate",
"title" : "Evaluate Operation",
"status" : "active",
"kind" : "operation",
"date" : "2024-08-27T20:52:56+00:00",
"publisher" : "HL7 International / Clinical Quality Information",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cqi"
}
]
}
],
"description" : "The evaluate operation is used to calculate an eMeasure and obtain the results.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"code" : "evaluate",
"resource" : [
"Measure"
],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [
{
"name" : "periodStart",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "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",
"type" : "date"
},
{
"name" : "periodEnd",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "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",
"type" : "date"
},
{
"name" : "manifest",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Specifies an asset-collection library that provides dependency version resolution and expansion rules for the operation. See the description of manifest in the Canonical Resource Management Infrastructure IG 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.",
"type" : "canonical",
"targetProfile" : [
🔗 "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary"
]
},
{
"name" : "programCode",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The quality program being reported via code from the [Reporting Program value set](http://hl7.org/fhir/us/cqfmeasures/ValueSet/quality-programs-example) indicating which quality program is being reported.",
"type" : "CodeableConcept",
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/us/cqfmeasures/ValueSet/quality-programs-example"
}
},
{
"name" : "measureId",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The id of a Measure resource that is on the server for which the measure will be evaluated. E.g., the id of the Measure resource for Breast Cancer Screening measure.",
"type" : "id"
},
{
"name" : "measureIdentifier",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The business identifier of the measure to be evaluated. E.g., CMS125 is a CMS assigned identifier for the Breast Cancer Screening eCQM in their system.",
"type" : "string",
"searchType" : "token"
},
{
"name" : "measureUrl",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The URL of the measure to be evaluated. A measure URL is specified in the [url](https://www.hl7.org/fhir/measure-definitions.html#Measure.url) element of the Measure resource. The measure URL remains the same when the measure is stored on different servers.",
"type" : "canonical"
},
{
"name" : "measure",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "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",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "measureResource",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The measure to be evaluated is provided as a Measure resource.",
"type" : "Measure"
},
{
"name" : "reportType",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The 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",
"type" : "code"
},
{
"name" : "subject",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Subject for which the measure will be evaluated. If not specified, the measure will be evaluated for all subjects that meet the requirements of the measure. If specified, the measure will only be evaluated for the referenced subject(s)",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "subjectGroup",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Subject for which the measure will be evaluated provided as a Group resource.",
"type" : "Group"
},
{
"name" : "parameters",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Any input parameters for the Measure evaluation. If the measure uses CQL, the parameter types are mapped to CQL as specified in the Parameters and Data Requirements section of the Using CQL with FHIR Implementation Guide. Any parameters defined in this input will be bound by name to parameters defined in the logic library referenced from library element of the Measure. 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.",
"type" : "Parameters"
},
{
"name" : "practitioner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Practitioner (references [QICore Practitioner](http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner)) for which the measure will be evaluated. If specified, the measure will be evaluated only for subjects that have a primary relationship to the identified practitioner",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "lastReceivedOn",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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",
"type" : "dateTime"
},
{
"name" : "reporter",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A reference to an Organization that will be populated in the MeasureReport.reporter",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "return",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Returns [Parameters](https://www.hl7.org/fhir/parameters.html) resource, which contains one or more bundles. The first entry of the bundle is either a [DEQM Individual MeasureReport](StructureDefinition-indv-measurereport-deqm.html), a [DEQM Summary MeasureReport](StructureDefinition-summary-measurereport-deqm.html), or a [DEQM Subject List MeasureReport](StructureDefinition-subjectlist-measurereport-deqm.html) and subsequent entries in the bundle are resources created and/or evaluated as part of the measure calculation. Note that the result of the $evaluate operation must be returned using the Parameters resource, even when the result contains only one bundle, because the cardinality of the return parameter is specified as 0..*",
"type" : "Bundle"
}
]
}
IG © 2020+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.davinci-deqm#5.0.0-ballot based on FHIR 4.0.1. Generated 2024-08-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change