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

Resource "Measure-collect-data" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Collect Data

OPERATION: Collect Data

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/Measure-collect-data

The collect-data operation is used to collect the data-of-interest for the given measure.

URL: [base]/Measure/$collect-data

URL: [base]/Measure/[id]/$collect-data

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 measure 0..1 string
( reference)

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

IN subject 0..1 string
( reference)

Subject for which the measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s)

IN practitioner 0..1 string
( reference)

Practitioner for which the measure will be collected. If specified, measure data will be collected only for subjects that have a primary relationship to the identified practitioner

IN lastReceivedOn 0..1 dateTime

The date the results of this measure were last received. This parameter used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios

OUT measureReport 1..1 MeasureReport

A MeasureReport of type data-collection detailing the results of the operation

OUT resource 0..* Resource

The result resources that make up the data-of-interest for the measure

The effect of invoking this operation is to gather the data required to perform an evaluation of the measure. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response. Note that the resulting MeasureReport is a transient resource


{
  "resourceType" : "OperationDefinition",
  "id" : "Measure-collect-data",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2018-12-14T02:02:43.910Z"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Collect Data</h2>\n <p>OPERATION: Collect Data</p>\n <p>The official URL for this operation definition is: </p>\n <pre>http://hl7.org/fhir/OperationDefinition/Measure-collect-data</pre>\n <div>\n <p>The collect-data operation is used to collect the data-of-interest for the given measure.</p>\n\n </div>\n <p>URL: [base]/Measure/$collect-data</p>\n <p>URL: [base]/Measure/[id]/$collect-data</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>measure</td>\n <td>0..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>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\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>subject</td>\n <td>0..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 measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s)</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>practitioner</td>\n <td>0..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>Practitioner for which the measure will be collected. If specified, measure data will be collected only for subjects that have a primary relationship to the identified practitioner</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>lastReceivedOn</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#dateTime\">dateTime</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The date the results of this measure were last received. This parameter used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>measureReport</td>\n <td>1..1</td>\n <td>\n <a href=\"measurereport.html\">MeasureReport</a>\n </td>\n <td/>\n <td>\n <div>\n <p>A MeasureReport of type data-collection detailing the results of the operation</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>resource</td>\n <td>0..*</td>\n <td>\n <a href=\"resource.html\">Resource</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The result resources that make up the data-of-interest for the measure</p>\n\n </div>\n </td>\n </tr>\n </table>\n <div>\n <p>The effect of invoking this operation is to gather the data required to perform an evaluation of the measure. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response. Note that the resulting MeasureReport is a transient resource</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-collect-data",
  "version" : "4.0.0",
  "name" : "Collect Data",
  "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 collect-data operation is used to collect the data-of-interest for the given measure.",
  "code" : "collect-data",
  "comment" : "The effect of invoking this operation is to gather the data required to perform an evaluation of the measure. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response. Note that the resulting MeasureReport is a transient resource",
  "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 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" : "measure",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "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" : "subject",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Subject for which the measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s)",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "practitioner",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Practitioner for which the measure will be collected. If specified, measure data will be collected 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 used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios",
      "type" : "dateTime"
    },
    {
      "name" : "measureReport",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "A MeasureReport of type data-collection detailing the results of the operation",
      "type" : "MeasureReport"
    },
    {
      "name" : "resource",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "The result resources that make up the data-of-interest for the measure",
      "type" : "Resource"
    }
  ]
}