Index
FhirStoreService
(interface)BigQueryDestination
(message)BigQueryDestination.WriteDisposition
(enum)CreateFhirStoreRequest
(message)DeleteFhirStoreRequest
(message)ExportResourcesRequest
(message)ExportResourcesResponse
(message)FhirStore
(message)FhirStore.StreamConfig
(message)FhirStore.Version
(enum)GcsDestination
(message)GcsSource
(message)GetFhirStoreRequest
(message)ImportResourcesRequest
(message)ImportResourcesRequest.ContentStructure
(enum)ImportResourcesResponse
(message)ListFhirStoresRequest
(message)ListFhirStoresResponse
(message)SchemaConfig
(message)SchemaConfig.SchemaType
(enum)UpdateFhirStoreRequest
(message)
FhirStoreService
A service for handling FHIR stores inside a healthcare dataset.
CreateFhirStore | |
---|---|
Creates a new FHIR store within the parent dataset.
|
DeleteFhirStore | |
---|---|
Deletes the specified FHIR store and removes all resources within it.
|
ExportResources | |
---|---|
Export resources from the FHIR store to the specified destination. This method returns an Immediate fatal errors appear in the
|
GetFhirStore | |
---|---|
Gets the configuration of the specified FHIR store.
|
ImportResources | |
---|---|
Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using [ExecuteBundle][] to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the The import process does not enforce referential integrity, regardless of the The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by [Patient-everything][GetPatientEverything] where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in This method returns an Immediate fatal errors appear in the
|
ListFhirStores | |
---|---|
Lists the FHIR stores in the given dataset.
|
UpdateFhirStore | |
---|---|
Updates the configuration of the specified FHIR store.
|
BigQueryDestination
The configuration for exporting to BigQuery.
Fields | |
---|---|
dataset_uri |
BigQuery URI to an existing dataset, up to 2000 characters long, in the format |
schema_config |
The configuration for the exported BigQuery schema. |
force |
If this flag is If |
write_disposition |
Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the |
WriteDisposition
The BigQuery WriteDispostion used by the export operation.
Enums | |
---|---|
WRITE_DISPOSITION_UNSPECIFIED |
Default behavior is the same as WRITE_EMPTY. |
WRITE_EMPTY |
Only export data if the destination tables are empty. |
WRITE_TRUNCATE |
Erase all existing data in a tables before writing the instances. |
WRITE_APPEND |
Append data to the existing tables. |
CreateFhirStoreRequest
Creates a new FHIR store.
Fields | |
---|---|
parent |
The name of the dataset this FHIR store belongs to. Authorization requires the following IAM permission on the specified resource
|
fhir_store_id |
The ID of the FHIR store that is being created. The string must match the following regex: |
fhir_store |
Configuration info for this FHIR store. |
DeleteFhirStoreRequest
Deletes the specified FHIR store.
Fields | |
---|---|
name |
The resource name of the FHIR store to delete. Authorization requires the following IAM permission on the specified resource
|
ExportResourcesRequest
Request to export resources.
Fields | ||
---|---|---|
name |
The name of the FHIR store to export resource from, in the format of Authorization requires the following IAM permission on the specified resource
|
|
Union field To enable the Cloud Healthcare API to write to resources in your project such as Cloud Storage buckets, you must give the consumer Cloud Healthcare API service account the proper permissions. The service account is: |
||
gcs_destination |
The Cloud Storage output destination. The Healthcare Service Agent account requires the The exported outputs are organized by FHIR resource types. The server creates one object per resource type. Each object contains newline delimited JSON, and each line is a FHIR resource. |
|
bigquery_destination |
The BigQuery output destination. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: The output is one BigQuery table per resource type. |
ExportResourcesResponse
Response when all resources export successfully. This structure is included in the response
to describe the detailed outcome after the operation finishes successfully.
FhirStore
Represents a FHIR store.
Fields | |
---|---|
name |
Output only. Resource name of the FHIR store, of the form |
enable_update_create |
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 return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. |
notification_config |
If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". |
disable_referential_integrity |
Immutable. 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 enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. |
disable_resource_versioning |
Immutable. 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 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 are kept. The server sends errors for attempts to read the historical versions. |
labels |
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. |
version |
Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. |
stream_configs[] |
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 is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required |
StreamConfig
Contains configuration for streaming FHIR export.
Fields | |
---|---|
resource_types[] |
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 treats an empty list as an intent to stream all the supported resource types in this FHIR store. |
bigquery_destination |
The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are appended to the corresponding BigQuery tables. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging). |
Version
The FHIR specification version.
Enums | |
---|---|
VERSION_UNSPECIFIED |
Users must specify a version on store creation or an error is returned. |
DSTU2 |
Draft Standard for Trial Use, Release 2 |
STU3 |
Standard for Trial Use, Release 3 |
R4 |
Release 4 |
GcsDestination
The configuration for exporting to Cloud Storage.
Fields | |
---|---|
uri_prefix |
URI for a Cloud Storage directory where result files should be written, in the format of |
GcsSource
Specifies the configuration for importing data from Cloud Storage.
Fields | |
---|---|
uri |
Points to a Cloud Storage URI containing file(s) to import. The URI must be in the following format:
Files matching the wildcard are expected to contain content only, no metadata. |
GetFhirStoreRequest
Gets a FHIR store.
Fields | |
---|---|
name |
The resource name of the FHIR store to get. Authorization requires the following IAM permission on the specified resource
|
ImportResourcesRequest
Request to import resources.
Fields | |
---|---|
name |
The name of the FHIR store to import FHIR resources to, in the format of Authorization requires the following IAM permission on the specified resource
|
content_structure |
The content structure in the source location. If not specified, the server treats the input source files as |
gcs_source |
Cloud Storage source data location and import configuration. The Healthcare Service Agent account requires the Each Cloud Storage object should be a text file that contains the format specified in |
ContentStructure
The content structure of the input source files.
Enums | |
---|---|
CONTENT_STRUCTURE_UNSPECIFIED |
If the content structure is not specified, the default value BUNDLE is used. |
BUNDLE |
The source file contains one or more lines of newline-delimited JSON (ndjson). Each line is a bundle that contains one or more resources. |
RESOURCE |
The source file contains one or more lines of newline-delimited JSON (ndjson). Each line is a single resource. |
BUNDLE_PRETTY |
The entire file is one JSON bundle. The JSON can span multiple lines. |
RESOURCE_PRETTY |
The entire file is one JSON resource. The JSON can span multiple lines. |
ImportResourcesResponse
Final response of importing resources. This structure is included in the response
to describe the detailed outcome after the operation finishes successfully.
ListFhirStoresRequest
Lists the FHIR stores in the given dataset.
Fields | |
---|---|
parent |
Name of the dataset. Authorization requires the following IAM permission on the specified resource
|
page_size |
Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
page_token |
The next_page_token value returned from the previous List request, if any. |
filter |
Restricts stores returned to those matching a filter. The following syntax is available:
Only filtering on labels is supported, for example |
ListFhirStoresResponse
Lists the FHIR stores in the given dataset.
Fields | |
---|---|
fhir_stores[] |
The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. |
next_page_token |
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 schema. Determines how the server generates the schema.
Fields | |
---|---|
schema_type |
Specifies the output schema type. Schema type is required. |
recursive_structure_depth |
The depth for all recursive structures in the output analytics schema. For example, |
SchemaType
An enum consisting of the supported output schema types.
Enums | |
---|---|
SCHEMA_TYPE_UNSPECIFIED |
No schema type specified. This type is unsupported. |
ANALYTICS |
Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md. BigQuery only allows a maximum of 10,000 columns per table. Due to this limitation, the server will not generate schemas for fields of type |
UpdateFhirStoreRequest
Updates a FHIR store.
Fields | |
---|---|
fhir_store |
The FHIR store that updates the resource in the server. Only fields listed in the Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |