Method: fhir.conditionalDelete

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

Deletes a FHIR resource that match an identifier search query.

Implements the FHIR standard conditional delete interaction, limited to searching by resource identifier. If multiple resources match, 412 Precondition Failed error will be returned.

Search term for identifier should be in the pattern identifier=system|value or identifier=value - similar to the search method on resources with a specific identifier.

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

For samples that show how to call conditionalDelete, see Conditionally deleting a FHIR resource.

HTTP request

DELETE https://healthcare.googleapis.com/v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the FHIR store this resource belongs to.

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

  • healthcare.fhirResources.delete
type

string

Required. 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 is 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.