Class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ExecuteBundleRequest
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.
Inheritance
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ExecuteBundleRequest : CloudHealthcareBaseServiceRequest<HttpBody>, IClientServiceRequest<HttpBody>, IClientServiceRequest
Constructors
ExecuteBundleRequest(IClientService, HttpBody, string)
Constructs a new ExecuteBundle request.
Declaration
public ExecuteBundleRequest(IClientService service, HttpBody body, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
HttpBody | body | |
string | parent |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Parent
Required. Name of the FHIR store in which this bundle will be executed.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes ExecuteBundle parameter list.
Declaration
protected override void InitParameters()