Method: fhirStores.bulkDelete

Full name: projects.locations.datasets.fhirStores.bulkDelete

Bulk-delete multiple FHIR resources from a FHIR store based on filters.

This method returns an Operation that can be used to track the status of the deletion by calling operations.get.

HTTP request

POST https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:bulkDelete

Path parameters

Parameters
name

Required. The name of the FHIR store to delete resources 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.bulkDelete

Request body

Fields
versionConfig

Required. Specifies which versions of the resource to delete. One of ALL, HISTORY_ONLY, or CURRENT_ONLY.
type

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

Optional. If provided, only resources updated before or at this time are deleted. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.
gcsDestination

Optional. The Cloud Storage destination to copy the deleted resource keys to. The summary file contains only the IDs of deleted current version resources.

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