<status value="active"/> <kind value="operation"/> <date value="2020-08-16"/> <publisher value="HL7 International - FHIR Infrastructure Work Group"/> <contact> <telecom> <system value="url"/> <value value="https://www.hl7.org/Special/committees/fiwg/index.cfm"/> </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"/> </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. 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 will be included in the response if their state has changed after the supplied time (e.g. if Resource.meta.lastUpdated is later than the supplied `_since` time)."/> <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. The response SHALL be filtered to only include resources of the specified resource types(s)."/> <type value="string"/> </parameter> <parameter> <name value="_elements"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Experimental. String of comma-delimited FHIR Elements. The server SHOULD omit unlisted, non-mandatory elements from the resources returned. Elements should be of the form `[resource type].[element name]` (eg. `Patient.id`) or `[element name]` (eg. `id`) and only root elements in a resource are permitted. If the resource type is omitted, the element should be returned for all resources in the response where it is applicable. Servers are not obliged to return just the requested elements. Servers SHOULD always return mandatory elements whether they are requested or not. Servers SHOULD mark the resources with the tag SUBSETTED to ensure that the incomplete resource is not actually used to overwrite a complete resource."/> <type value="string"/> </parameter> <parameter> <name value="includeAssociatedData"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Experimental. Servers with support for the requested values SHALL return or omit a pre-defined set of FHIR resources associated with the request."/> <type value="code"/> <binding> <strength value="extensible"/> <valueSet value="http://hl7.org/fhir/uv/bulkdata/ValueSet/include-associated-data"/> </binding> </parameter> <parameter> <name value="_typeFilter"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Experimental. String of comma separated FHIR REST search queries. Servers with support for the requested search queries SHALL filter the data in the response to only include resources that meet the specified criteria."/> <type value="string"/> </parameter> </OperationDefinition>

BulkDataExport

OPERATION: BulkDataExport

The official URL for this operation definition is:

http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export

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

URL: [base]/$export

Parameters

Use Name Cardinality Type Binding Documentation

_outputFormat

0..1

string

The format for the requested bulk data files to be generated. Defaults to application/fhir+ndjson.

_since

0..1

instant

Resources will be included in the response if their state has changed after the supplied time (e.g. if Resource.meta.lastUpdated is later than the supplied _since time).

_type

0..1

string

A string of comma-delimited FHIR resource types. The response SHALL be filtered to only include resources of the specified resource types(s).

_elements

0..1

string

Experimental. String of comma-delimited FHIR Elements. The server SHOULD omit unlisted, non-mandatory elements from the resources returned. Elements should be of the form [resource type].[element name] (eg. Patient.id) or [element name] (eg. id) and only root elements in a resource are permitted. If the resource type is omitted, the element should be returned for all resources in the response where it is applicable.

Servers are not obliged to return just the requested elements. Servers SHOULD always return mandatory elements whether they are requested or not. Servers SHOULD mark the resources with the tag SUBSETTED to ensure that the incomplete resource is not actually used to overwrite a complete resource.

includeAssociatedData

0..1

code

http://hl7.org/fhir/uv/bulkdata/ValueSet/include-associated-data (Extensible)

Experimental. Servers with support for the requested values SHALL return or omit a pre-defined set of FHIR resources associated with the request.

_typeFilter

0..1

string

Experimental. String of comma separated FHIR REST search queries. Servers with support for the requested search queries SHALL filter the data in the response to only include resources that meet the specified criteria.