Method: fhir.Resource-purge

Full name: projects.locations.datasets.fhirStores.fhir.Resource-purge

Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method.

This is not a FHIR standard operation.

For samples that show how to call Resource-purge, see Deleting historical versions of a FHIR resource.

HTTP request

DELETE https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/$purge

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the resource to purge.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.purge

Request body

The request body must be empty.

Response body

If successful, the response body will be empty.

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.