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/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$export
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis service allows for the bulk export of all FHIR resources from a specified FHIR store to a designated Cloud Storage location.\u003c/p\u003e\n"],["\u003cp\u003eThe request must include specific headers (\u003ccode\u003eAccept\u003c/code\u003e and \u003ccode\u003ePrefer\u003c/code\u003e) and is limited to asynchronous responses, as only those are supported.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter the exported resources by type using the \u003ccode\u003e_type\u003c/code\u003e query parameter and by update time using the \u003ccode\u003e_since\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe export output format can be set using the \u003ccode\u003e_outputFormat\u003c/code\u003e parameter, with the only supported option being \u003ccode\u003endjson\u003c/code\u003e format.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful initiation, the service provides a URL in the \u003ccode\u003eContent-Location\u003c/code\u003e header that can be used to monitor the export operation's status.\u003c/p\u003e\n"]]],[],null,["# Method: fhir.bulk-export\n\n**Full name**: projects.locations.datasets.fhirStores.fhir.bulk-export\n\nBulk exports all resources from the FHIR store to the specified destination.\n\nImplements the FHIR implementation guide \\[system level $export\\](\u003chttps://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export\u003e.\n\nThe following headers must be set in the request:\n\n- `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported.\n- `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported.\n\nSpecify the destination for the server to write result files by setting the Cloud Storage location [bulkExportGcsDestination](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores#FhirStore.FIELDS.bulk_export_gcs_destination) 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.\n\nSupports the following query parameters:\n\n- `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported.\n\n- `_since`: if provided, only the resources that are updated after the specified time are exported.\n\n- `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resourceType}.ndjson.\n\nOn 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](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.operations/get-fhir-operation-status#google.cloud.healthcare.v1.fhir.rest.FhirService.GetFHIROperationStatus) for more information.\n\nErrors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$export`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-healthcare`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
