Method: fhir.update

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

Updates the entire contents of a resource.

Implements the FHIR standard update interaction.

If the specified resource does not exist and the FHIR store has enableUpdateCreate set, creates the resource with the client-specified ID.

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 will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will 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.

HTTP request

PUT https://healthcare.googleapis.com/v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the resource to update.

Authorization requires the following Google 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:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Healthcare API