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.

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 will return 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. If the search criteria identify zero matches, and the supplied resource body does not contain an id, the resource will be 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 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/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The name of the FHIR store this resource belongs to.

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

  • healthcare.fhirResources.update

type

string

The type of the resource to 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