Package google.cloud.healthcare.v1beta1.fhir.stu3.grpc

Index

FhirService

gRPC service for handling FHIR resources in a FHIR store inside a healthcare dataset. This service supports version 3 of the FHIR standard: http://hl7.org/fhir/STU3/index.html

ConditionalDeleteResource

rpc ConditionalDeleteResource(ConditionalDeleteResourceRequest) returns (Empty)

Deletes FHIR resources matching a search query.

Note: unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through GetResourceVersion and related methods, unless they are removed by the DeleteResourceVersions 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.

ConditionalUpdateResource

rpc ConditionalUpdateResource(ConditionalUpdateResourceRequest) returns (ContainedResource)

Updates the entire resource if the resource exists based on the search criteria specified via query parameters.

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.

CreateResource

rpc CreateResource(CreateResourceRequest) returns (ContainedResource)

Creates a FHIR resource.

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.

DeleteResource

rpc DeleteResource(DeleteResourceRequest) returns (Empty)

Deletes a FHIR resource.

Note: unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through GetResourceVersion and related methods, unless they are removed by the DeleteResourceVersions 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.

ExecuteBundle

rpc ExecuteBundle(ExecuteBundleRequest) returns (ContainedResource)

Executes all the requests in the given Bundle. Bundle is a FHIR resource that contains multiple actions on multiple resources; These actions may be run as a batch or single transaction. Conforms to http://hl7.org/fhir/http.html#transaction

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.

GetLastNObservations

rpc GetLastNObservations(GetLastNObservationsRequest) returns (ContainedResource)

Get N most recent observations for patient matching the criteria, grouped by code.

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.

GetResource

rpc GetResource(GetResourceRequest) returns (ContainedResource)

Gets a FHIR resource in GRPC.

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.

GetResourceVersion

rpc GetResourceVersion(GetResourceVersionRequest) returns (ContainedResource)

Gets a version (current or historical) of FHIR resource by version id.

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.

SearchResources

rpc SearchResources(SearchResourcesRequest) returns (ContainedResource)

Searches resources in the given FHIR store.

The server's capability statement, retrieved through GetCapabilityStatement, indicates which search parameters are supported on each FHIR resource.

Modifier Supported
:missing Yes
:exact Yes
:contains Yes
:text Yes
:in Yes
:not-in Yes
:above Yes
:below Yes
:[type] Yes
:not Yes
:recurse No
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.

UpdateResource

rpc UpdateResource(UpdateResourceRequest) returns (ContainedResource)

Updates the entire resource or creates a new resource with a client specified ID if the resource does not exist and the FHIR store has enable_update_create set.

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.

ConditionalDeleteResourceRequest

Deletes a resource from the specified FHIR store that matches the conditions.

Fields
parent

string

The name of the FHIR store this resource belongs to.

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

  • healthcare.fhirResources.delete

type

string

The type of the resource to update.

conditions[]

SearchParameter

Delete conditions.

ConditionalUpdateResourceRequest

Fields
parent

string

The name of the FHIR store this resource belongs to.

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

  • healthcare.fhirResources.update

type

string

The type of the resource to update.

resource

ContainedResource

Resource to be updated.

conditions[]

SearchParameter

Update conditions

CreateResourceRequest

Fields
parent

string

The name of the FHIR store this resource belongs to.

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

  • healthcare.fhirResources.create

type

string

The type of the resource to create.

resource

ContainedResource

Resource to be created.

DeleteResourceRequest

Deletes a resource from the specified FHIR store.

Fields
name

string

The name of the resource to delete.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.fhirResources.delete

ExecuteBundleRequest

Request to execute all included operations in a Bundle.

Fields
parent

string

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

bundle

ContainedResource

The bundle to execute.

GetLastNObservationsRequest

Get N most recent observations for patient matching the criteria, grouped by code.

Fields
parent

string

Name of the FHIR store to retrieve resources from.

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

  • healthcare.fhirResources.get

conditions[]

SearchParameter

Observation conditions.

GetResourceRequest

Gets a resource from the specified FHIR store.

Fields
name

string

The name of the resource to retrieve.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.fhirResources.get

GetResourceVersionRequest

Gets a specific version of a resource from the specified FHIR store.

Fields
name

string

The name of the resource version to retrieve.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.fhirResources.get

SearchParameter

Fields
key

string

value[]

string

SearchResourcesRequest

Request to search the resources in the specified FHIR store.

Fields
parent

string

Name of the FHIR store to retrieve resources from.

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

  • healthcare.fhirResources.get

resource_type

string

The type of the resource to search.

params[]

SearchParameter

Search parameters.

UpdateResourceRequest

Fields
name

string

The name of the resource to update.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.fhirResources.update

resource

ContainedResource

The updated resource to store. The entire resource is updated.

Var denne siden nyttig? Si fra hva du synes:

Send tilbakemelding om ...

Cloud Healthcare API