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 will contain 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 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.
For samples that show how to call executeBundle
, see Managing FHIR resources using FHIR bundles.
HTTP request
POST https://healthcare.googleapis.com/v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Name of the FHIR store in which this bundle will be executed. Authorization requires the following IAM permission on the specified resource
|
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.