Method: fhir.conditionalUpdate

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

If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource.

Implements the FHIR standard conditional update interaction (DSTU2, STU3, R4).

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

If the search criteria identify more than one match, the request returns a 412 Precondition Failed error. If the search criteria identify zero matches, and the supplied resource body contains an id, and the FHIR store has enableUpdateCreate set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an id, the resource is created with a server-assigned ID as per the create method.

The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json.

On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

This method requires thehealthcare.fhirStores.searchResources and healthcare.fhirResources.update permissions on the parent FHIR store.

For samples that show how to call conditionalUpdate, see Conditionally updating a FHIR resource.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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

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

  • healthcare.fhirResources.update


Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). Must match the resource type in the provided content.

Request body

The request body contains an instance of HttpBody.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.