Method: fhir.update

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

Updates the entire contents of a resource.

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

If the specified resource does not exist 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.

The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. The resource must contain an id element having an identical value to the ID in the REST path of the request.

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.

For samples that show how to call update, see Updating a FHIR resource.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The name of the resource to update.

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

  • healthcare.fhirResources.update

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.