Da Vinci Risk Adjustment Implementation Guide
2.0.0-ballot - STU2 Ballot

Publication Build: This will be filled in by the publication tooling

## : Evaluate Measure - JSON Representation

Draft as of 2023-03-28

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "ra.evaluate-measure",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Measure/$ra.evaluate-measure</p><p>URL: [base]/Measure/[id]/$ra.evaluate-measure</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 a clinical evaluation period. The periodStart and periodEnd parameters will be compared with the clinical evaluation period (<code>MeasureReport.period.start</code> and <code>MeasureReport.period.end</code>)           of a <a href=\"StructureDefinition-ra-measurereport.html\">Risk Adjustment Coding Gap MeasureReport</a> available on the Server. The MeasureReport will be returned if there is an overlap of the two periods.</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 a clinical evaluation period.</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>1..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 will be a reference to either Patient (<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html\">US Core Patient</a>) or Group (<a href=\"StructureDefinition-ra-patient-group.html\">Patient Group</a>). Must provide either Patient/123 or Group/123, cannot simply provide 123. If only 123 is provided, then the operation would not know if it is a Patient reference or a Group reference.</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 for risk adjustment model, e.g., CMS HCC v24</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 a Measure resource for risk adjustment model, e.g., CMS HCC v24.</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>This the URL of a Measure resource for risk adjustment model, e.g., CMS HCC v24</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The $ra.evaluate-measure operation will always return one <a href=\"https://www.hl7.org/fhir/parameters.html\">Parameters</a> whether the subject is a single patient or a group of patients. <a href=\"StructureDefinition-ra-measurereport-bundle.html\">Risk Adjustment Coding Gap Report Bundle</a> for a patient is in a <code>Parameters.parameter</code> element. A Risk Adjustment Coding Gap Report Bundle contains the Risk Adjustment Coding Gap Reports for the same patient. For example, if a Group has 10 valid patients, then a <a href=\"https://www.hl7.org/fhir/parameters.html\">Parameters</a> will contain 10 <code>Parameters.parameter</code>elements, with each <code>Parameters.parameter</code> for a unique patient.</p>\n</div></td></tr></table></div>"
      },
      "url" : "http://hl7.org/fhir/us/davinci-ra/OperationDefinition/ra.evaluate-measure",
      "version" : "2.0.0-ballot",
      "name" : "RAEvaluateMeasure",
      "title" : "Evaluate Measure",
      "status" : "draft",
      "kind" : "operation",
      "date" : "2023-03-28T02:02:49+00:00",
      "publisher" : "HL7 Clinical Quality Information Work Group",
      "contact" : [
        {
          "name" : "HL7 Clinical Quality Information Work Group",
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/cqi"
            }
          ]
        }
      ],
      "description" : "The ra.evaluate-measure operation is used to evaluate Digital Condition Category and obtain the results.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US",
              "display" : "United States of America"
            }
          ]
        }
      ],
      "code" : "ra.evaluate-measure",
      "base" : "http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure",
      "resource" : [
        "Measure"
      ],
      "system" : false,
      "type" : true,
      "instance" : true,
      "parameter" : [
        {
          "name" : "periodStart",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The start of a clinical evaluation period. The periodStart and periodEnd parameters will be compared with the clinical evaluation period (`MeasureReport.period.start` and `MeasureReport.period.end`)           of a [Risk Adjustment Coding Gap MeasureReport](StructureDefinition-ra-measurereport.html) available on the Server. The MeasureReport will be returned if there is an overlap of the two periods.",
          "type" : "date"
        },
        {
          "name" : "periodEnd",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The end of a clinical evaluation period.",
          "type" : "date"
        },
        {
          "name" : "subject",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Subject will be a reference to either Patient ([US Core Patient](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html)) or Group ([Patient Group](StructureDefinition-ra-patient-group.html)). Must provide either Patient/123 or Group/123, cannot simply provide 123. If only 123 is provided, then the operation would not know if it is a Patient reference or a Group reference.",
          "type" : "string",
          "searchType" : "reference"
        },
        {
          "name" : "measureId",
          "use" : "in",
          "min" : 0,
          "max" : "*",
          "documentation" : "The id of a Measure resource for risk adjustment model, e.g., CMS HCC v24",
          "type" : "id"
        },
        {
          "name" : "measureIdentifier",
          "use" : "in",
          "min" : 0,
          "max" : "*",
          "documentation" : "The business identifier of a Measure resource for risk adjustment model, e.g., CMS HCC v24.",
          "type" : "string",
          "searchType" : "token"
        },
        {
          "name" : "measureUrl",
          "use" : "in",
          "min" : 0,
          "max" : "*",
          "documentation" : "This the URL of a Measure resource for risk adjustment model, e.g., CMS HCC v24",
          "type" : "canonical"
        },
        {
          "name" : "return",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "The $ra.evaluate-measure operation will always return one [Parameters](https://www.hl7.org/fhir/parameters.html) whether the subject is a single patient or a group of patients. [Risk Adjustment Coding Gap Report Bundle](StructureDefinition-ra-measurereport-bundle.html) for a patient is in a `Parameters.parameter` element. A Risk Adjustment Coding Gap Report Bundle contains the Risk Adjustment Coding Gap Reports for the same patient. For example, if a Group has 10 valid patients, then a [Parameters](https://www.hl7.org/fhir/parameters.html) will contain 10 `Parameters.parameter`elements, with each `Parameters.parameter` for a unique patient.",
          "type" : "Bundle"
        }
      ]
    }