Patch a FHIR resource.
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
Go
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
healthcare "google.golang.org/api/healthcare/v1"
)
// patchFHIRResource patches an FHIR resource to be active or not.
func patchFHIRResource(w io.Writer, projectID, location, datasetID, fhirStoreID, resourceType, fhirResourceID string, active bool) error {
ctx := context.Background()
healthcareService, err := healthcare.NewService(ctx)
if err != nil {
return fmt.Errorf("healthcare.NewService: %v", err)
}
fhirService := healthcareService.Projects.Locations.Datasets.FhirStores.Fhir
// The following payload works with a Patient resource and is not intended to work with
// other types of FHIR resources. If necessary, supply a new payload with data that
// corresponds to the FHIR resource you are patching.
payload := []map[string]interface{}{
{
"op": "replace",
"path": "/active",
"value": active,
},
}
jsonPayload, err := json.Marshal(payload)
if err != nil {
return fmt.Errorf("json.Encode: %v", err)
}
name := fmt.Sprintf("projects/%s/locations/%s/datasets/%s/fhirStores/%s/fhir/%s/%s", projectID, location, datasetID, fhirStoreID, resourceType, fhirResourceID)
call := fhirService.Patch(name, bytes.NewReader(jsonPayload))
call.Header().Set("Content-Type", "application/json-patch+json")
resp, err := call.Do()
if err != nil {
return fmt.Errorf("Patch: %v", err)
}
defer resp.Body.Close()
respBytes, err := ioutil.ReadAll(resp.Body)
if err != nil {
return fmt.Errorf("could not read response: %v", err)
}
if resp.StatusCode > 299 {
return fmt.Errorf("Patch: status %d %s: %s", resp.StatusCode, resp.Status, respBytes)
}
fmt.Fprintf(w, "%s", respBytes)
return nil
}
Java
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.healthcare.v1.CloudHealthcare;
import com.google.api.services.healthcare.v1.CloudHealthcareScopes;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Collections;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.HttpClients;
public class FhirResourcePatch {
private static final String FHIR_NAME =
"projects/%s/locations/%s/datasets/%s/fhirStores/%s/fhir/%s/%s";
private static final JsonFactory JSON_FACTORY = new JacksonFactory();
private static final NetHttpTransport HTTP_TRANSPORT = new NetHttpTransport();
public static void fhirResourcePatch(String resourceName, String data)
throws IOException, URISyntaxException {
// String resourceName =
// String.format(
// FHIR_NAME, "project-id", "region-id", "dataset-id", "store-id", "resource-type",
// "resource-id");
// The following data works with a Patient resource and is not intended to work with
// other types of FHIR resources. If necessary, supply new values for data that
// correspond to the FHIR resource you are patching.
// String data = "[{\"op\": \"replace\", \"path\": \"/active\", \"value\": false}]";
// Initialize the client, which will be used to interact with the service.
CloudHealthcare client = createClient();
HttpClient httpClient = HttpClients.createDefault();
String uri = String.format("%sv1/%s", client.getRootUrl(), resourceName);
URIBuilder uriBuilder = new URIBuilder(uri).setParameter("access_token", getAccessToken());
StringEntity requestEntity = new StringEntity(data);
HttpUriRequest request =
RequestBuilder.patch(uriBuilder.build())
.setEntity(requestEntity)
.addHeader("Content-Type", "application/json-patch+json")
.addHeader("Accept-Charset", "utf-8")
.addHeader("Accept", "application/fhir+json; charset=utf-8")
.build();
// Execute the request and process the results.
HttpResponse response = httpClient.execute(request);
HttpEntity responseEntity = response.getEntity();
if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
System.err.print(
String.format(
"Exception patching FHIR resource: %s\n", response.getStatusLine().toString()));
responseEntity.writeTo(System.err);
throw new RuntimeException();
}
System.out.println("FHIR resource patched: ");
responseEntity.writeTo(System.out);
}
private static CloudHealthcare createClient() throws IOException {
// Use Application Default Credentials (ADC) to authenticate the requests
// For more information see https://cloud.google.com/docs/authentication/production
GoogleCredentials credential =
GoogleCredentials.getApplicationDefault()
.createScoped(Collections.singleton(CloudHealthcareScopes.CLOUD_PLATFORM));
// Create a HttpRequestInitializer, which will provide a baseline configuration to all requests.
HttpRequestInitializer requestInitializer =
request -> {
new HttpCredentialsAdapter(credential).initialize(request);
request.setConnectTimeout(60000); // 1 minute connect timeout
request.setReadTimeout(60000); // 1 minute read timeout
};
// Build the client for interacting with the service.
return new CloudHealthcare.Builder(HTTP_TRANSPORT, JSON_FACTORY, requestInitializer)
.setApplicationName("your-application-name")
.build();
}
private static String getAccessToken() throws IOException {
GoogleCredentials credential =
GoogleCredentials.getApplicationDefault()
.createScoped(Collections.singleton(CloudHealthcareScopes.CLOUD_PLATFORM));
return credential.refreshAccessToken().getTokenValue();
}
}Python
def patch_resource(
project_id,
location,
dataset_id,
fhir_store_id,
resource_type,
resource_id,
):
"""Updates part of an existing resource.
See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/fhir
before running the sample."""
# Imports Python's built-in "os" module
import os
# Imports the google.auth.transport.requests transport
from google.auth.transport import requests
# Imports a module to allow authentication using a service account
from google.oauth2 import service_account
# Gets credentials from the environment.
credentials = service_account.Credentials.from_service_account_file(
os.environ["GOOGLE_APPLICATION_CREDENTIALS"]
)
scoped_credentials = credentials.with_scopes(
["https://www.googleapis.com/auth/cloud-platform"]
)
# Creates a requests Session object with the credentials.
session = requests.AuthorizedSession(scoped_credentials)
# URL to the Cloud Healthcare API endpoint and version
base_url = "https://healthcare.googleapis.com/v1"
# TODO(developer): Uncomment these lines and replace with your values.
# project_id = 'my-project' # replace with your GCP project ID
# location = 'us-central1' # replace with the parent dataset's location
# dataset_id = 'my-dataset' # replace with the parent dataset's ID
# fhir_store_id = 'my-fhir-store' # replace with the FHIR store ID
# resource_type = 'Patient' # replace with the FHIR resource type
# resource_id = 'b682d-0e-4843-a4a9-78c9ac64' # replace with the FHIR resource's ID
url = "{}/projects/{}/locations/{}".format(base_url, project_id, location)
resource_path = "{}/datasets/{}/fhirStores/{}/fhir/{}/{}".format(
url, dataset_id, fhir_store_id, resource_type, resource_id
)
# Sets required application/json-patch+json header.
# See https://tools.ietf.org/html/rfc6902 for more information.
headers = {"Content-Type": "application/json-patch+json"}
# The body shown works with a Patient resource and is not guaranteed
# to work with other types of FHIR resources. If necessary,
# supply a new body with data that corresponds to the resource you
# are patching.
body = json.dumps([{"op": "replace", "path": "/active", "value": False}])
response = session.patch(resource_path, headers=headers, data=body)
response.raise_for_status()
resource = response.json()
print("Patched {} resource:".format(resource["resourceType"]))
print(json.dumps(resource, indent=2))
return resource
What's next
To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser.