Method: fhir.conditionalDelete

Full name: projects.locations.datasets.fhirStores.fhir.conditionalDelete

Deletes FHIR resources that match a search query.

Implements the FHIR standard conditional delete interaction (DSTU2, STU3, R4). If multiple resources match, all of them will be deleted.

Search terms are provided as query parameters following the same pattern as the search method.

Note: Unless resource versioning is disabled by setting the disableResourceVersioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The name of the FHIR store this resource belongs to.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.fhirResources.delete


The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4).

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:


For more information, see the Authentication Overview.