Method: fhir.executeBundle

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

Executes all the requests in the given Bundle.

Implements the FHIR standard batch/transaction interaction (DSTU2, STU3, R4).

Supports all interactions within a bundle, except search. This method accepts Bundles of type batch and transaction, processing them according to the batch processing rules (DSTU2, STU3, R4) and transaction processing rules (DSTU2, STU3, R4).

The request body must contain a JSON-encoded FHIR Bundle resource, and the request headers must contain Content-Type: application/fhir+json.

For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a Bundle resource of type batch-response or transaction-response containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains 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 checks permissions for each request in the bundle. The executeBundle permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the healthcare.fhirResources.create permission.

You can use audit logs to view the permissions for executeBundle and each request in the bundle. For more information, see Viewing Cloud Audit logs.

For samples that show how to call executeBundle, see Managing FHIR resources using FHIR bundles.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Name of the FHIR store in which this bundle will be executed.

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

  • healthcare.fhirStores.executeBundle

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:


For more information, see the Authentication Overview.