Da Vinci Risk Adjustment Implementation Guide
1.0.0 - STU 1 US

This page is part of the Da Vinci Risk Adjustment FHIR Implementation Guide (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Report Operation - JSON Representation

Active as of 2022-06-16

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "report",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>Report</h2><p>OPERATION: Report</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/davinci-ra/OperationDefinition/report</pre><div><p>Generate a measure report</p>\n</div><p>URL: [base]/MeasureReport/$report</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 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>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>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>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 $report 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><tr><td>OUT</td><td>outcome</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>If subject is a patient and the patient is not found on the Server, or if subject is a Group and the group is not found on the Server, then the $report returns a <code>Parameters.parameter</code> with an <a href=\"https://www.hl7.org/fhir/operationOutcome.html\">OperationOutcome</a>.           If subject is a Group, the group is valid but one or more patients within the Group can not be found on the Server, then the $report returns a separate <code>Parameters.parameter</code> with an OperationOutcome for each of the invalid patients.           For example, if a Group has 10 patients and two of the patients cannot be found on the Server, then the $report returns a Parameters resource containing 10 <code>parameter</code> elements (two <code>parameter</code> elements containing OperationOutcome for the two invalid patients and eight <code>parameter</code> elements containing <a href=\"StructureDefinition-ra-measurereport-bundle.html\">Risk Adjustment Coding Gap Report Bundle</a> for the eight valid patients).</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://hl7.org/fhir/us/davinci-ra/OperationDefinition/report",
  "version" : "1.0.0",
  "name" : "Report",
  "title" : "Report Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2022-06-16T14:23:36+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" : "Generate a measure report",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "code" : "report",
  "resource" : [
    "MeasureReport"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "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" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "The $report 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"
    },
    {
      "name" : "outcome",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "If subject is a patient and the patient is not found on the Server, or if subject is a Group and the group is not found on the Server, then the $report returns a `Parameters.parameter` with an [OperationOutcome](https://www.hl7.org/fhir/operationOutcome.html).           If subject is a Group, the group is valid but one or more patients within the Group can not be found on the Server, then the $report returns a separate `Parameters.parameter` with an OperationOutcome for each of the invalid patients.           For example, if a Group has 10 patients and two of the patients cannot be found on the Server, then the $report returns a Parameters resource containing 10 `parameter` elements (two `parameter` elements containing OperationOutcome for the two invalid patients and eight `parameter` elements containing [Risk Adjustment Coding Gap Report Bundle](StructureDefinition-ra-measurereport-bundle.html) for the eight valid patients).",
      "type" : "OperationOutcome"
    }
  ]
}