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

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

Tags:

XML or JSON representation . provenance for this resource

Da Vinci Collect Measure Data OperationDefinition

OPERATION: Da Vinci Collect Measure Data OperationDefinition

The official URL for this operation definition is:

http://hl7.org/fhir/ig/davinci/OperationDefinition/collect-data

The Collect Measure Data operation returns a Bundle of profiled resources that satisfy the required data requirements for a measure definition for a patient.

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

Parameters

UseNameCardinalityTypeBindingDocumentation
INperiodStart0..1date

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

INperiodEnd0..1date

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

INpatient0..1uri

Patient to evaluate against. This is a reference to a Da Vinci Patient Profile e.g. 'Patient/123'. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated.

INpractitioner0..1uri

Practitioner to evaluate. This is a reference to a Da Vinci Practitioner Profile e.g. 'Practitioner/123'. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner

INlastReceivedOn0..1dateTime

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

OUTreturn0..1Bundle

Bundle of required profiles for the measure

The effect of invoking this operation on is to fetch a Bundle of resources needed for reporting a measure for a patient. The id of the instance endpoint, for example 'measure-mrp' in [base]/MeasureReport/measure-mrp/$collectData determines which measure data is returned. The required data for each measure is discoverable by invoking the $[measure]-requirements operation on the payer's Measure endpoint.


<?xml version="1.0" encoding="UTF-8"?>
<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="collect-data"/>
  <meta>
    <versionId value="1"/>
    <lastUpdated value="2018-09-06T12:43:04.250Z"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Da Vinci Collect Measure Data OperationDefinition</h2>
      <p>OPERATION: Da Vinci Collect Measure Data OperationDefinition</p>
      <p>The official URL for this operation definition is: </p>
      <pre>http://hl7.org/fhir/ig/davinci/OperationDefinition/collect-data</pre>
      <div>
        <p>The Collect Measure Data operation returns a
          <code>Bundle</code>of profiled resources that satisfy the required data requirements for a measure definition for a patient.</p> </div>
      <p>URL: [base]/MeasureReport/[id]/$collect-data</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>0..1</td>
          <td>date</td>
          <td/>
          <td>
            <div>
              <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 start to be 2014-01-01T00:00:00 inclusive</p> </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>periodEnd</td>
          <td>0..1</td>
          <td>date</td>
          <td/>
          <td>
            <div>
              <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> </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>patient</td>
          <td>0..1</td>
          <td>uri</td>
          <td/>
          <td>
            <div>
              <p>Patient to evaluate against. This is a reference to a
                <a href="StructureDefinition-patient-davinci.html">Da Vinci Patient Profile</a>e.g. 'Patient/123'. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated.</p> </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>practitioner</td>
          <td>0..1</td>
          <td>uri</td>
          <td/>
          <td>
            <div>
              <p>Practitioner to evaluate. This is a reference to a
                <a href="StructureDefinition-practitioner-davinci.html">Da Vinci Practitioner Profile</a>e.g. 'Practitioner/123'. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner</p> </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>lastReceivedOn</td>
          <td>0..1</td>
          <td>dateTime</td>
          <td/>
          <td>
            <div>
              <p>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</p> </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>return</td>
          <td>0..1</td>
          <td>Bundle</td>
          <td/>
          <td>
            <div>
              <p>
                <code>Bundle</code>of required profiles for the measure</p> </div>
          </td>
        </tr>
      </table>
      <div>
        <p>The effect of invoking this operation on is to fetch a
          <code>Bundle</code>of resources needed for reporting a measure for a patient. The id of the instance endpoint, for example 'measure-mrp' in
          <code>[base]/MeasureReport/measure-mrp/$collectData</code>determines which measure data is returned. The required data for each measure is discoverable by invoking the
          <a href="todo.html">
            <code>$[measure]-requirements</code>
          </a>operation on the payer's
          <code>Measure</code>endpoint.</p> </div>
    </div>
  </text>
  <url value="http://hl7.org/fhir/ig/davinci/OperationDefinition/collect-data"/>
  <version value="0.0.0"/>
  <name value="Da Vinci Collect Measure Data OperationDefinition"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2018-06-30T00:00:00+00:00"/>
  <publisher value="Da Vinci Project"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="https://github.com/Healthedata1/DaVinci"/>
    </telecom>
  </contact>
  <description value="The Collect Measure Data operation returns a `Bundle` of profiled resources that satisfy the required data requirements for a measure definition for a patient."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <idempotent value="true"/>
  <code value="collect-data"/>
  <comment value="The effect of invoking this operation on is to fetch a `Bundle` of resources needed for reporting a measure for a patient. The id of the instance endpoint, for example &apos;measure-mrp&apos; in `[base]/MeasureReport/measure-mrp/$collectData` determines which measure data is returned. The required data for each measure is discoverable by invoking the [`$[measure]-requirements`](todo.html) operation on the payer&apos;s `Measure` endpoint."/>
  <resource value="MeasureReport"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="periodStart"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="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 value="date"/>
  </parameter>
  <parameter>
    <name value="periodEnd"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="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 value="date"/>
  </parameter>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Patient to evaluate against. This is a reference to a [Da Vinci Patient Profile](StructureDefinition-patient-davinci.html) e.g. &apos;Patient/123&apos;. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated."/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="practitioner"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Practitioner to evaluate. This is a reference to a [Da Vinci Practitioner Profile](StructureDefinition-practitioner-davinci.html) e.g. &apos;Practitioner/123&apos;. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="lastReceivedOn"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="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 value="dateTime"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="`Bundle` of required profiles for the measure"/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>