Data Exchange For Quality Measures STU3 for FHIR R4
2.1.0 - Ballot

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v2.1.0: STU 3) based on FHIR R4. The current version which supercedes this version is 3.1.0. For a full list of available versions, see the Directory of published versions

: Care Gaps Operation - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "care-gaps",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>CareGaps</h2><p>OPERATION: CareGaps</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/care-gaps</pre><div><p>The care-gaps operation is used to determine gaps in care for a specified gaps through period based on the results of quality measures.</p>\n</div><p>URL: [base]/Measure/$care-gaps</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</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>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 gaps through period. This maybe the start of the measurement period defined by a measure, or a customized desired performance period start date determined by a payer, a provider, a measure program, and etc.</p>\n</div></td></tr><tr><td>IN</td><td>periodEnd</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 gaps through period (the gaps through date). The gaps through date could be a past date or a future date.  For example, today's date is 2020-06-18, 1) if periodEnd date is 2020-09-30, it returns gaps through 2020-09-30, and 2) if the periodEnd date is 2020-05-31, it returns gaps through 2020-05-31.</p>\n</div></td></tr><tr><td>IN</td><td>topic</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td><a href=\"http://hl7.org/fhir/R4/valueset-definition-topic.html\">http://hl7.org/fhir/ValueSet/definition-topic</a> (Example)</td><td><div><p>The category of the measures that is of interest for the care gaps report. This references the topic element in the Measure Resource. Examples of topic may be screening measures, HEDIS measure domains, chronic disease measures. For example, setting topic to be a screening caregory will run care gaps on all screening measures. Topic may also be a &quot;value set&quot; that is defined with a list of domains/categories, etc. Topic examples: &quot;screening&quot;, &quot;pediatric&quot;. When multiple topics are provided, it is expected to be union of measures in those topics.</p>\n</div></td></tr><tr><td>IN</td><td>subject</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 will be a reference to either Patient <a href=\"http://hl7.org/fhir/us/qicore/STU4/StructureDefinition-qicore-patient.html\">QI Core Patient</a> or Group <a href=\"StructureDefinition-gaps-group-deqm.html\">DEQM Gaps In Care Group Profile</a>. Must provide either Patient/123 or Group/123, cannot simply provide 123. If only provide 123, 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>practitioner</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Reference to a practitioner <a href=\"StructureDefinition-practitioner-deqm.html\">DEQM Practitioner</a> for which the gaps in care report will be created. For a practitioner focused gaps in care report, this is a required In Parameter. The Server needs to make sure that practitioner is authorized to get the gaps in care report for and know what measures the practitioner are eligible or qualified.</p>\n</div></td></tr><tr><td>IN</td><td>organization</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Reference to an organization <a href=\"StructureDefinition-organization-deqm.html\">DEQM Organization</a> for which the gaps in care report will be created. For a provider organization focused gaps in care report, this is a required In Parameter.</p>\n</div></td></tr><tr><td>IN</td><td>status</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-gaps-status.html\">http://hl7.org/fhir/us/davinci-deqm/ValueSet/gaps-status</a> (Required)</td><td><div><p>Indicates status of a care gap. Status can be either open gap or closed gap. If no status is provided, the default is all gaps including both open and closed gaps. For a positive proportion measure, gap means the patient is not in the numerator. For an inverse (negative) proportion measure (e.g., Diabetes: Hemoglobin A1c (HbA1c) Poor Control (&gt; 9%)), gap means the patient is in the numerator.</p>\n</div></td></tr><tr><td>IN</td><td>measure</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The measure(s) for which the gaps in care will be reported. E.g., Breast Cancer Screening measure, Colorectal Cancer Screening measure</p>\n</div></td></tr><tr><td>IN</td><td>program</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The programs that a provider (either practitioner or provider organization) participates in, e.g., risk based, value based, or other performance program such as CMS Merit-based Incentive Payment Program (MIPS), Hospital Quality Reporting (HQR) programs. Program is represented in Measure using element useContext (useageContext). When the code attribute of useContext is program, then the value attribute of useContext represents a specific program.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The result of the care-gaps operation will be returned as a document bundle using the <a href=\"StructureDefinition-gaps-bundle-deqm.html\">DEQM Gaps In Care Bundle Profile</a>.</p>\n</div></td></tr></table><div><p>The effect of invoking this operation is to calculate a measure or a set of measures based on the In Parameters provided and return a document bundle describing the gaps in care results      of each measure for the specified gaps through period for the given subject (a patient or a group of patients). Note that it is up to the Server to determine whether      or not the generated gaps in care report is persisted. If the Server does not persist the results, the operation does not affect state and can be invoked with a GET. Note that this operation is intended to replace the existing Measure $care-gaps operation.</p>\n</div></div>"
  },
  "url" : "http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/care-gaps",
  "version" : "2.1.0",
  "name" : "CareGaps",
  "title" : "Care Gaps Operation",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2020-07-03T00:00:00-07:00",
  "publisher" : "HL7 International - Clinical Quality Information Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cqi/index.cfm"
        }
      ]
    }
  ],
  "description" : "The care-gaps operation is used to determine gaps in care for a specified gaps through period based on the results of quality measures.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "care-gaps",
  "comment" : "The effect of invoking this operation is to calculate a measure or a set of measures based on the In Parameters provided and return a document bundle describing the gaps in care results      of each measure for the specified gaps through period for the given subject (a patient or a group of patients). Note that it is up to the Server to determine whether      or not the generated gaps in care report is persisted. If the Server does not persist the results, the operation does not affect state and can be invoked with a GET. Note that this operation is intended to replace the existing Measure $care-gaps operation.",
  "base" : "http://hl7.org/fhir/OperationDefinition/Measure-care-gaps",
  "resource" : [
    "Measure"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "periodStart",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The start of a gaps through period. This maybe the start of the measurement period defined by a measure, or a customized desired performance period start date determined by a payer, a provider, a measure program, and etc.",
      "type" : "date"
    },
    {
      "name" : "periodEnd",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The end of a gaps through period (the gaps through date). The gaps through date could be a past date or a future date.  For example, today's date is 2020-06-18, 1) if periodEnd date is 2020-09-30, it returns gaps through 2020-09-30, and 2) if the periodEnd date is 2020-05-31, it returns gaps through 2020-05-31.",
      "type" : "date"
    },
    {
      "name" : "topic",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The category of the measures that is of interest for the care gaps report. This references the topic element in the Measure Resource. Examples of topic may be screening measures, HEDIS measure domains, chronic disease measures. For example, setting topic to be a screening caregory will run care gaps on all screening measures. Topic may also be a \"value set\" that is defined with a list of domains/categories, etc. Topic examples: \"screening\", \"pediatric\". When multiple topics are provided, it is expected to be union of measures in those topics.",
      "type" : "string",
      "binding" : {
        "strength" : "example",
        "valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
      }
    },
    {
      "name" : "subject",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Subject will be a reference to either Patient [QI Core Patient](http://hl7.org/fhir/us/qicore/STU4/StructureDefinition-qicore-patient.html) or Group [DEQM Gaps In Care Group Profile](StructureDefinition-gaps-group-deqm.html). Must provide either Patient/123 or Group/123, cannot simply provide 123. If only provide 123, then the operation would not know if it is a Patient reference or a Group reference.",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "practitioner",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Reference to a practitioner [DEQM Practitioner](StructureDefinition-practitioner-deqm.html) for which the gaps in care report will be created. For a practitioner focused gaps in care report, this is a required In Parameter. The Server needs to make sure that practitioner is authorized to get the gaps in care report for and know what measures the practitioner are eligible or qualified.",
      "type" : "string"
    },
    {
      "name" : "organization",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Reference to an organization [DEQM Organization](StructureDefinition-organization-deqm.html) for which the gaps in care report will be created. For a provider organization focused gaps in care report, this is a required In Parameter.",
      "type" : "string"
    },
    {
      "name" : "status",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Indicates status of a care gap. Status can be either open gap or closed gap. If no status is provided, the default is all gaps including both open and closed gaps. For a positive proportion measure, gap means the patient is not in the numerator. For an inverse (negative) proportion measure (e.g., Diabetes: Hemoglobin A1c (HbA1c) Poor Control (> 9%)), gap means the patient is in the numerator.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/us/davinci-deqm/ValueSet/gaps-status"
      }
    },
    {
      "name" : "measure",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The measure(s) for which the gaps in care will be reported. E.g., Breast Cancer Screening measure, Colorectal Cancer Screening measure",
      "type" : "string"
    },
    {
      "name" : "program",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The programs that a provider (either practitioner or provider organization) participates in, e.g., risk based, value based, or other performance program such as CMS Merit-based Incentive Payment Program (MIPS), Hospital Quality Reporting (HQR) programs. Program is represented in Measure using element useContext (useageContext). When the code attribute of useContext is program, then the value attribute of useContext represents a specific program.",
      "type" : "string"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "The result of the care-gaps operation will be returned as a document bundle using the [DEQM Gaps In Care Bundle Profile](StructureDefinition-gaps-bundle-deqm.html).",
      "type" : "Bundle"
    }
  ]
}