Method: fhirStores.export

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.

To improve performance, it is recommended to make the type filter as specific as possible, including only the resource types that are absolutely needed. This minimizes the size of the initial dataset to be processed and is the most effective way to improve performance. While post-filters like _since are useful for refining results, they do not speed up the initial data retrieval phase, which is primarily governed by the type filter.

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/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:export

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` 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`

name

string

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

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`. }

{
  "_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 give the consumer Cloud Healthcare API service account the proper permissions. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that contains the source FHIR store. To get the project number, go to the GCP Console Dashboard. `destination` can be only one of the following:
`gcsDestination`	`object(GcsDestination)` The Cloud Storage output destination. The Healthcare Service Agent account requires the `roles/storage.objectAdmin` role 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.
`bigqueryDestination`	`object(BigQueryDestination)` The BigQuery output destination. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output is one BigQuery table per resource type. Unlike when setting `BigQueryDestination` for `StreamConfig`, `fhirStores.export` does not create BigQuery views.

Response body

If successful, the response body contains an instance of Operation.

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.

GcsDestination

The configuration for exporting to Cloud Storage.

JSON representation
{ "uriPrefix": string }

Fields

Fields
`uriPrefix`	`string` URI for a Cloud Storage directory where result files should be written, in the format of `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 in `uriPrefix`.

uriPrefix