Method: fhir.conditionalPatch

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

If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a JSON Patch document.

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

DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3.

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.

The request body must contain a JSON Patch document, and the request headers must contain Content-Type: application/json-patch+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 permission on the parent FHIR store and the healthcare.fhirResources.patch permission on the requested FHIR store resource.

For samples that show how to call conditionalPatch, see Conditionally patching a FHIR resource.

HTTP request

PATCH https://healthcare.googleapis.com/v1beta1/{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 IAM permission on the specified resource parent:

  • healthcare.fhirResources.patch
type

string

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

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.