Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.fhirStores.export
Export resources from the FHIR store to the specified destination.
This method returns an Operation that can be used to track the status of the export by calling operations.get.
Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
HTTP request
POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:export
Required. The name of the FHIR store to export resource from, in the format of projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}.
Authorization requires the following IAM permission on the specified resource name:
healthcare.fhirStores.export
Request body
The request body contains data with the following structure:
JSON representation
{"_since": string,"_type": string,// Union field destination can be only one of the following:"gcsDestination": {object(GcsDestination)},"bigqueryDestination": {object(BigQueryDestination)}// End of list of possible types for union field destination.}
Fields
_since
string
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
String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
Union field destination. The output destination of the export.
To enable the Cloud Healthcare API to write to resources in your project such as Cloud Storage buckets, you must grant the Healthcare Service Agent account the required permissions. For steps to assign the permissions, see Importing data from Cloud Storage. destination can be only one of the following:
The Cloud Healthcare Service Agent requires the roles/storage.objectAdmin Cloud IAM roles on the Cloud Storage location.
The exported outputs are organized by FHIR resource types. The server creates one object per resource type. Each object contains newline delimited JSON, and each line is a FHIR resource.
[[["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 method allows you to export FHIR resources from a specified FHIR store to either a Cloud Storage destination or a BigQuery destination.\u003c/p\u003e\n"],["\u003cp\u003eThe export operation's status can be tracked using the \u003ccode\u003eoperations.get\u003c/code\u003e method, which returns an \u003ccode\u003eOperation\u003c/code\u003e object, and errors are logged in Cloud Logging.\u003c/p\u003e\n"],["\u003cp\u003eThe export can be filtered to include only resources updated after a specific date and time or resources of certain types, by providing the \u003ccode\u003e_since\u003c/code\u003e or \u003ccode\u003e_type\u003c/code\u003e parameters, respectively.\u003c/p\u003e\n"],["\u003cp\u003eTo use this feature, you will need to provide a FHIR store name and authorize the request with either the \u003ccode\u003ehealthcare.fhirStores.export\u003c/code\u003e IAM permission or one of the specified OAuth scopes, as well as granting the Healthcare Service Agent account the necessary permissions to the destination location.\u003c/p\u003e\n"]]],[],null,["# Method: fhirStores.export\n\n**Full name**: projects.locations.datasets.fhirStores.export\n\nExport resources from the FHIR store to the specified destination.\n\nThis method returns an [Operation](/healthcare-api/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation) that can be used to track the status of the export by calling `operations.get`.\n\nImmediate fatal errors appear in the [error](/healthcare-api/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation.FIELDS.error) field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type `ExportResourcesResponse` is returned in the [response](/healthcare-api/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation.FIELDS.response) field. The [metadata](/healthcare-api/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation.FIELDS.metadata) field type for this operation is [OperationMetadata](/healthcare-api/docs/reference/rest/v1beta1/OperationMetadata).\n\n### HTTP request\n\n`POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:export`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/healthcare-api/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\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)."]]
