Method: fhirStores.bulkDelete

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

Bulk deletes the FHIR resources from the given FHIR store.

This method returns an Operation that can be used to track the progress of the deletion by calling operations.get. The success and secondarySuccess counters correspond to the deleted current version and historical versions, respectively.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

The request body contains data with the following structure:

JSON representation 
{
  "versionConfig": enum(VersionConfig),
  "until": string,
  "type": string,
  "gcsDestination": {
    object(GcsDestination)
  }
}
Fields
versionConfig

enum(VersionConfig)

Optional. Specifies which version of the resources to delete.
until

string

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. 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) will be deleted.
gcsDestination

object(GcsDestination)

Optional. The Cloud Storage output destination.

The Healthcare Service Agent account requires the roles/storage.objectAdmin role on the Cloud Storage location.

The deleted resources outputs are organized by FHIR resource types. The server creates one or more objects per resource type. Each object contains newline delimited strings in the format {resourceType}/{resourceId}.

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.

VersionConfig

List of version configs for bulk delete FHIR resources.

Enums
VERSION_CONFIG_UNSPECIFIED Unspecified version config. Defaults to ALL.
ALL Delete the current version and all history versions.
CURRENT_ONLY Delete the current version only and create a historical version of the deleted resource.
HISTORY_ONLY Delete all history versions only.