This page is part of the FHIR Bulk Data Access (Flat FHIR) (v1.0.1: STU 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Bulk Data

OperationDefinition: export

Formats: Narrative, XML, JSON

Raw xml

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="export"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>BulkDataExport</h2><p>OPERATION: BulkDataExport</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export</pre><div><p>Export data from a FHIR server whether or not it is associated with a patient. This supports use cases like backing up a server or exporting terminology data by restricting the resources returned using the _type parameter. The FHIR server SHALL support invocation of this operation using the <a href="http://hl7.org/fhir/async.html">FHIR Asynchronous Request Pattern</a></p>
</div><p>URL: [base]/$export</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>_outputFormat</td><td>0..1</td><td><a href="http://hl7.org/fhir/datatypes.html#string">string</a></td><td/><td><div><p>The format for the requested bulk data files to be generated as per <a href="http://hl7.org/fhir/async.html">FHIR Asynchronous Request Pattern</a>. Defaults to <code>application/fhir+ndjson</code>.</p>
</div></td></tr><tr><td>IN</td><td>_since</td><td>0..1</td><td><a href="http://hl7.org/fhir/datatypes.html#instant">instant</a></td><td/><td><div><p>Resources updated after this period will be included in the response.</p>
</div></td></tr><tr><td>IN</td><td>_type</td><td>0..1</td><td><a href="http://hl7.org/fhir/datatypes.html#string">string</a></td><td/><td><div><p>A string of comma-delimited FHIR resource types. Only resources of the specified resource types(s) SHOULD be included in the response. If this parameter is omitted, the server SHOULD return all supported resources within the scope of the client authorization. Resource references MAY be relative URIs with the format {resource type}/{id}, or absolute URIs with the same structure rooted in the base URI for the server from which the export was performed. References will be resolved looking for a resource with the specified type and id within the file set. Note: Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the Argonaut Implementation Guide.</p>
</div></td></tr></table></div>
  </text>
  <url value="http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export"/>
  <version value="1.0.1"/>
  <name value="BulkDataExport"/>
  <title value="FHIR Bulk Data Export (Flat FHIR) - System Level Export"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2020-07-02"/>
  <publisher value="SMART Health IT"/>
  <contact>
    <name value="Ricky Sahu"/>
    <telecom>
      <system value="email"/>
      <value value="ricky@1up.health"/>
    </telecom>
  </contact>
  <contact>
    <name value="Dan Gottlieb"/>
    <telecom>
      <system value="email"/>
      <value value="daniel.gottlieb@childrens.harvard.edu"/>
    </telecom>
  </contact>
  <contact>
    <name value="Josh Mandel"/>
    <telecom>
      <system value="email"/>
      <value value="joshua.mandel@childrens.harvard.edu"/>
    </telecom>
  </contact>
  <contact>
    <name value="Vlad Ignatov"/>
    <telecom>
      <system value="email"/>
      <value value="Vladimir.Ignatov@childrens.harvard.edu"/>
    </telecom>
  </contact>
  <description
               value="Export data from a FHIR server whether or not it is associated with a patient. This supports use cases like backing up a server or exporting terminology data by restricting the resources returned using the _type parameter. The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html)"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <code value="export"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="_outputFormat"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The format for the requested bulk data files to be generated as per [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html). Defaults to `application/fhir+ndjson`."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_since"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Resources updated after this period will be included in the response."/>
    <type value="instant"/>
  </parameter>
  <parameter>
    <name value="_type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="A string of comma-delimited FHIR resource types. Only resources of the specified resource types(s) SHOULD be included in the response. If this parameter is omitted, the server SHOULD return all supported resources within the scope of the client authorization. Resource references MAY be relative URIs with the format {resource type}/{id}, or absolute URIs with the same structure rooted in the base URI for the server from which the export was performed. References will be resolved looking for a resource with the specified type and id within the file set. Note: Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the Argonaut Implementation Guide."/>
    <type value="string"/>
  </parameter>
</OperationDefinition>