Data Exchange For Quality Measures Implementation Guide
5.0.0-ballot - STU5 Ballot United States of America flag

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v5.0.0-ballot: STU5 (v5.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.0.0. For a full list of available versions, see the Directory of published versions

: Bulk Submit Data - XML Representation

Page standards status: Trial-use Maturity Level: 0

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="bulk-submit-data"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Measure/$bulk-submit-data</p><p>URL: [base]/Measure/[id]/$bulk-submit-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>measureReport</td><td>1..*</td><td><a href="http://hl7.org/fhir/R4/measurereport.html">MeasureReport</a></td><td/><td><div><p>The measure report that is being submitted</p>
</div></td></tr><tr><td>IN</td><td>exportType</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td/><td><div><p>(Optional) String of <code>static</code> or <code>dynamic</code>. Defaults to <code>dynamic</code> if omitted.</p>
<p>If the value is <code>dynamic</code>, the Data Consumer will issue a POST request to the <code>exportUrl</code> to obtain a dataset from the Data Provider.</p>
<p>If the value is <code>static</code>, the Data Consumer will issue a GET request to the <code>exportUrl</code> to retrieve a Bulk Data manifest file with the location of the Bulk Data files.</p>
</div></td></tr><tr><td>IN</td><td>exportUrl</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#url">url</a></td><td/><td><div><p>The absolute URL of the bulk export endpoint of a Data Provider (if the <code>exportType</code> parameter is <code>dynamic</code>) OR the location of a FHIR Bulk Data Export manifest file (if the <code>exportType</code> parameter is <code>static</code>)</p>
</div></td></tr><tr><td>IN</td><td>_type</td><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>(Optional) Restrict the data exported to only be specific FHIR resource types. See <a href="https://hl7.org/fhir/uv/bulkdata/export/index.html#query-parameters">the bulk data $export spec</a> for more information on '_type'</p>
</div></td></tr><tr><td>IN</td><td>useTypeFilters</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>(Optional) If enabled, data exported by the 'exportUrl' system will be filtered according to the data requirements of the Measure. Requires support of the _typeFilter experimental parameter in the export server. See <a href="https://hl7.org/fhir/uv/bulkdata/export/index.html#example-request-with-_typefilter">the bulk data $export spec</a> for more information on '_typeFilter'</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cqi"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/bulk-submit-data"/>
  <version value="5.0.0-ballot"/>
  <name value="BulkSubmitData"/>
  <title value="Bulk Submit Data"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2022-11-09T10:53:32-05:00"/>
  <publisher value="HL7 International / Clinical Quality Information"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cqi"/>
    </telecom>
  </contact>
  <description
               value="The bulk-submit-data operation sends a bulk import request based on the data requirements of a FHIR Measure. This operation is modeled off the existing draft of the [Bulk Data Import Ping and Pull Approach](https://github.com/smart-on-fhir/bulk-import/blob/master/import-pnp.md)."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <code value="bulk-submit-data"/>
  <resource value="Measure"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="measureReport"/>
    <use value="in"/>
    <min value="1"/>
    <max value="*"/>
    <documentation value="The measure report that is being submitted"/>
    <type value="MeasureReport"/>
  </parameter>
  <parameter>
    <name value="exportType"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="(Optional) String of `static` or `dynamic`. Defaults to `dynamic` if omitted.

If the value is `dynamic`, the Data Consumer will issue a POST request to the `exportUrl` to obtain a dataset from the Data Provider.

If the value is `static`, the Data Consumer will issue a GET request to the `exportUrl` to retrieve a Bulk Data manifest file with the location of the Bulk Data files."/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="exportUrl"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The absolute URL of the bulk export endpoint of a Data Provider (if the `exportType` parameter is `dynamic`) OR the location of a FHIR Bulk Data Export manifest file (if the `exportType` parameter is `static`)"/>
    <type value="url"/>
  </parameter>
  <parameter>
    <name value="_type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="(Optional) Restrict the data exported to only be specific FHIR resource types. See [the bulk data $export spec](https://hl7.org/fhir/uv/bulkdata/export/index.html#query-parameters) for more information on '_type'"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="useTypeFilters"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="(Optional) If enabled, data exported by the 'exportUrl' system will be filtered according to the data requirements of the Measure. Requires support of the _typeFilter experimental parameter in the export server. See [the bulk data $export spec](https://hl7.org/fhir/uv/bulkdata/export/index.html#example-request-with-_typefilter) for more information on '_typeFilter'"/>
    <type value="boolean"/>
  </parameter>
</OperationDefinition>