FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.287  |  FHIR Version 4.0.0  | User: ANONYMOUS (Unknown)  

Resource "Measure-care-gaps" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Care Gaps

OPERATION: Care Gaps

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/Measure-care-gaps

The care-gaps operation is used to determine gaps-in-care based on the results of quality measures

URL: [base]/Measure/$care-gaps

Parameters

Use Name Cardinality Type Binding Documentation
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 s

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 topic 1..1 string

The topic to be used to determine which measures are considered for the care gaps report. Any measure with the given topic will be included in the report

IN subject 1..1 string
( reference)

Subject for which the care gaps report will be produced

OUT return 1..1 Bundle

The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure

The effect of invoking this operation is to calculate a set of measures for a particular topic (e.g. Preventive Care and Screening) and return a document describing the results of each measure for the given subject. Note that it is up to the server to determine whether or not the generated care gaps report is persisted. If the server does not persist the results, the operation does not affect state and can be invoked with a GET


{
  "resourceType" : "OperationDefinition",
  "id" : "Measure-care-gaps",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2018-12-14T02:02:43.879Z"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Care Gaps</h2>\n <p>OPERATION: Care Gaps</p>\n <p>The official URL for this operation definition is: </p>\n <pre>http://hl7.org/fhir/OperationDefinition/Measure-care-gaps</pre>\n <div>\n <p>The care-gaps operation is used to determine gaps-in-care based on the results of quality measures</p>\n\n </div>\n <p>URL: [base]/Measure/$care-gaps</p>\n <p>Parameters</p>\n <table class=\"grid\">\n <tr>\n <td>\n <b>Use</b>\n </td>\n <td>\n <b>Name</b>\n </td>\n <td>\n <b>Cardinality</b>\n </td>\n <td>\n <b>Type</b>\n </td>\n <td>\n <b>Binding</b>\n </td>\n <td>\n <b>Documentation</b>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>periodStart</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#date\">date</a>\n </td>\n <td/>\n <td>\n <div>\n <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 s</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>periodEnd</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#date\">date</a>\n </td>\n <td/>\n <td>\n <div>\n <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\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>topic</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The topic to be used to determine which measures are considered for the care gaps report. Any measure with the given topic will be included in the report</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>subject</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n <br/>(\n <a href=\"search.html#reference\">reference</a>)\n </td>\n <td/>\n <td>\n <div>\n <p>Subject for which the care gaps report will be produced</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>return</td>\n <td>1..1</td>\n <td>\n <a href=\"bundle.html\">Bundle</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure</p>\n\n </div>\n </td>\n </tr>\n </table>\n <div>\n <p>The effect of invoking this operation is to calculate a set of measures for a particular topic (e.g. Preventive Care and Screening) and return a document describing the results of each measure for the given subject. Note that it is up to the server to determine whether or not the generated care gaps report is persisted. If the server does not persist the results, the operation does not affect state and can be invoked with a GET</p>\n\n </div>\n </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    }
  ],
  "url" : "http://hl7.org/fhir/OperationDefinition/Measure-care-gaps",
  "version" : "4.0.0",
  "name" : "Care Gaps",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2018-12-14T01:14:32+00:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/fhir"
        },
        {
          "system" : "email",
          "value" : "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "The care-gaps operation is used to determine gaps-in-care based on the results of quality measures",
  "code" : "care-gaps",
  "comment" : "The effect of invoking this operation is to calculate a set of measures for a particular topic (e.g. Preventive Care and Screening) and return a document describing the results of each measure for the given subject. Note that it is up to the server to determine whether or not the generated care gaps report is persisted. If the server does not persist the results, the operation does not affect state and can be invoked with a GET",
  "resource" : [
    "Measure"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "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 s",
      "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" : "topic",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The topic to be used to determine which measures are considered for the care gaps report. Any measure with the given topic will be included in the report",
      "type" : "string"
    },
    {
      "name" : "subject",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Subject for which the care gaps report will be produced",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure",
      "type" : "Bundle"
    }
  ]
}