Package google.cloud.healthcare.v1alpha2.fhir

Index

FhirStoreService

A service for handling FHIR stores inside a healthcare dataset.

CreateFhirStore

rpc CreateFhirStore(CreateFhirStoreRequest) returns (FhirStore)

Creates a new FHIR store within the parent dataset.

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.

DeleteFhirStore

rpc DeleteFhirStore(DeleteFhirStoreRequest) returns (Empty)

Deletes the specified FHIR store and removes all resources within it.

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.

GetFhirStore

rpc GetFhirStore(GetFhirStoreRequest) returns (FhirStore)

Gets the configuration of the specified FHIR store.

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.

GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

Gets the access control policy for a FHIR store or security label within a FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

Authorization requires the Google IAM permission 'healthcare.fhirStores.getIamPolicy' for a FHIR store or 'healthcare.securityLabels.getIamPolicy' for a security label

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.

ListFhirStores

rpc ListFhirStores(ListFhirStoresRequest) returns (ListFhirStoresResponse)

Lists the FHIR stores in the given dataset.

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.

SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

Sets the access control policy for a FHIR store or security label within a FHIR store. Replaces any existing policy.

Authorization requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a security label

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.

TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

There is no permission required to make this API call.

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.

UpdateFhirStore

rpc UpdateFhirStore(UpdateFhirStoreRequest) returns (FhirStore)

Updates the configuration of the specified FHIR store.

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.

BigQueryDestination

The configuration for exporting to BigQuery.

Fields
dataset_uri

string

BigQuery URI to a dataset, up to 2000 characters long, in the format bq://projectId.bqDatasetId

schema_config

SchemaConfig

The configuration for the exported BigQuery schema.

CreateFhirStoreRequest

Creates a new FHIR store.

Fields
parent

string

The name of the dataset this FHIR store belongs to.

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

  • healthcare.fhirStores.create

fhir_store_id

string

The ID of the FHIR store that is being created. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}.

fhir_store

FhirStore

Configuration info for this FHIR store.

DeleteFhirStoreRequest

Deletes the specified FHIR store.

Fields
name

string

The resource name of the FHIR store to delete.

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

  • healthcare.fhirStores.delete

FhirStore

Represents a FHIR store.

Fields
name

string

Output only. Resource name of the FHIR store, of the form projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

enable_update_create

bool

Whether this FHIR store has the updateCreate capability. This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications.

notification_config

NotificationConfig

If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes will contain a map with a string describing the action that has triggered the notification, e.g. "action":"CreateResource".

disable_referential_integrity

bool

Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as GetPatientEverything, will not return all the results if broken references exist.

disable_resource_versioning

bool

Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations will cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for attempts to read the historical versions.

labels

map<string, string>

User-supplied key-value pairs used to organize FHIR stores.

Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}

Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

No more than 64 labels can be associated with a given store.

stream_configs[]

StreamConfig

A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation will be streamed to the new location in addition to the existing ones. When a location is removed from the list, the server will simply stop streaming to that location. Before adding a new config, you must add the required bigquery.dataEditor role to your project's Cloud Healthcare Service Agent service account. Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.

enable_history_import

bool

Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error.

StreamConfig

This structure contains configuration for streaming FHIR export.

Fields
resource_types[]

string

Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server will treat an empty list as an intent to stream all the supported resource types in this FHIR store.

bigquery_destination

BigQueryDestination

The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output will be organized in one table per resource type. The server will inspect and potentially create new tables (if they don't exist) in the given BigQuery dataset. Results will be appended to the corresponding BigQuery tables. The views of the latest snapshot will also be automatically created in the dataset.

GetFhirStoreRequest

Gets a FHIR store.

Fields
name

string

The resource name of the FHIR store to get.

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

  • healthcare.fhirStores.get

ListFhirStoresRequest

Lists the FHIR stores in the given dataset.

Fields
parent

string

Name of the dataset.

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

  • healthcare.fhirStores.list

page_size

int32

Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used.

page_token

string

The next_page_token value returned from the previous List request, if any.

filter

string

Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example labels.key=value.

ListFhirStoresResponse

Lists the FHIR stores in the given dataset.

Fields
fhir_stores[]

FhirStore

The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request.

next_page_token

string

Token to retrieve the next page of results or empty if there are no more results in the list.

SchemaConfig

Configuration for the FHIR BigQuery and Cloud Storage schema. Determines how the server generates the schema.

Fields
schema_type

SchemaType

Specifies the output schema type. If unspecified, the default is LOSSLESS.

recursive_structure_depth

int64

The depth for all recursive structures in the output analytics schema. For example, concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2.

SchemaType

An enum consisting of the supported output schema types.

Enums
SCHEMA_TYPE_UNSPECIFIED No schema type specified. Same as LOSSLESS.
LOSSLESS A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification.
ANALYTICS Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.

UpdateFhirStoreRequest

Updates a FHIR store.

Fields
fhir_store

FhirStore

The FHIR store that updates the resource in the server. Only fields listed in the update_mask will be applied.

update_mask

FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Healthcare API