Operation-measure-evaluate-measure.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "Measure-evaluate-measure",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure",
  "name": "Evaluate Measure",
  "status": "draft",
  "kind": "operation",
  "date": "2017-12-20T15:52:34+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "The evaluate-measure operation is used to invoke an eMeasure and obtain the results",
  "code": "evaluate-measure",
  "comment": "The effect of invoking this operation is to calculate the measure for the given patient, or all patients if no patient is supplied, and return the results as a MeasureReport resource of the appropriate type",
  "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": "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": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Measure"
      ]
    },
    {
      "name": "reportType",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The type of measure report, patient, patient-list, or population. If not specified, a default value of patient will be used if the patient parameter is supplied, otherwise, population will be used",
      "type": "code"
    },
    {
      "name": "subject",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Subject to evaluate against. If not specified, the measure will be evaluated for all subjects that meet the requirements of the measure. If specified, only the referenced subject(s) will be evaluated",
      "type": "Reference"
    },
    {
      "name": "practitioner",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Practitioner to evaluate. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner",
      "type": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Practitioner"
      ]
    },
    {
      "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": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The results of the measure calculation. See the MeasureReport resource for a complete description of the output of this operation",
      "type": "MeasureReport"
    }
  ]
}