Method: fhir.patch

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

Updates part of an existing resource by applying the operations specified in a JSON Patch document.

Implements the FHIR standard patch interaction.

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 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

PATCH 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.

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