Method: fhir.bulk-export

Full name: projects.locations.datasets.fhirStores.fhir.bulk-export

Bulk exports all resources from the FHIR store to the specified destination.

Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export.

The following headers must be set in the request:

  • Accept: specifies the format of the OperationOutcome response. Only application/fhir+json is supported.
  • Prefer: specifies whether the response is immediate or asynchronous. Must be to respond-async because only asynchronous responses are supported.

Specify the destination for the server to write result files by setting the Cloud Storage ___location bulkExportGcsDestination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced.

Supports the following query parameters:

  • _type: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported.

  • _since: if provided, only the resources that are updated after the specified time are exported.

  • _outputFormat: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resourceType}.ndjson.

On success, the Content-Location header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/operations/{export_id}. See get-fhir-operation-status for more information.

Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$export

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the FHIR store to export resources from, in the format projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirStores.export

Query parameters

Parameters
_since

string

Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z. The time must be specified to the second and include a time zone.
_type

string

Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
outputFormat

string

Optional. Output format of the export. This field is optional and only application/fhir+ndjson is supported.

Request body

The request body must be empty.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.