Index
FhirStoreService
(interface)BigQueryDestination
(message)BigQueryDestination.WriteDisposition
(enum)ChangeType
(enum)ComplexDataTypeReferenceParsing
(enum)CreateFhirStoreRequest
(message)DeleteFhirStoreRequest
(message)ExportResourcesRequest
(message)ExportResourcesResponse
(message)FhirStore
(message)FhirStore.DeidentifiedStoreDestination
(message)FhirStore.FhirNotificationConfig
(message)FhirStore.StreamConfig
(message)FhirStore.ValidationConfig
(message)FhirStore.Version
(enum)FhirStoreMetrics
(message)FhirStoreMetrics.FhirStoreMetric
(message)GcsDestination
(message)GcsSource
(message)GetFhirStoreMetricsRequest
(message)GetFhirStoreRequest
(message)ImportResourcesRequest
(message)ImportResourcesRequest.ContentStructure
(enum)ImportResourcesResponse
(message)ListFhirStoresRequest
(message)ListFhirStoresResponse
(message)RollbackFhirResourceFilteringFields
(message)RollbackFhirResourcesRequest
(message)RollbackFhirResourcesResponse
(message)SchemaConfig
(message)SchemaConfig.SchemaType
(enum)SchemaConfig.TimePartitioning
(message)SchemaConfig.TimePartitioning.PartitionType
(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.
|
GetFhirStoreMetrics |
---|
Gets metrics associated with the 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 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 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.
|
RollbackFhirResources |
---|
Rolls back resources from the FHIR store to the specified time. This method returns an Immediate fatal errors appear in the
|
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 if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the |
WriteDisposition
The BigQuery WriteDisposition 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 the destination tables before writing the FHIR resources. |
WRITE_APPEND |
Append data to the destination tables. |
ChangeType
Type of transaction to execute during FHIR resource rollback
Enums | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
When unspecified, revert all transactions |
ALL |
All transactions |
CREATE |
Revert only CREATE transactions |
UPDATE |
Revert only Update transactions |
DELETE |
Revert only Delete transactions |
ComplexDataTypeReferenceParsing
ComplexDataTypeReferenceParsing defines the parsing behavior of complex FHIR data types.
Enums | |
---|---|
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED |
No parsing behavior specified. This is the same as DISABLED for backwards compatibility. |
DISABLED |
References in complex data types are ignored. |
ENABLED |
References in complex data types are parsed. |
CreateFhirStoreRequest
Creates a new FHIR store.
Fields | |
---|---|
parent |
Required. The name of the dataset this FHIR store belongs to. Authorization requires the following IAM permission on the specified resource
|
fhir_store_id |
Required. The ID of the FHIR store that is being created. The string must match the following regex: |
fhir_store |
Required. Configuration info for this FHIR store. |
DeleteFhirStoreRequest
Deletes the specified FHIR store.
Fields | |
---|---|
name |
Required. 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 |
Required. The name of the FHIR store to export resource from, in the format of Authorization requires the following IAM permission on the specified resource
|
since |
If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, |
type |
String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. |
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. Unlike when setting |
ExportResourcesResponse
This type has no fields.
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. Identifier. 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 Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. |
notification_config |
Deprecated. Use |
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 |
Required. 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 |
validation_config |
Configuration for how to validate incoming FHIR resources against configured profiles. |
default_search_handling_strict |
If true, overrides the default search behavior for this FHIR store to |
complex_data_type_reference_parsing |
Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. |
notification_configs[] |
Specifies where and whether to send notifications upon changes to a FHIR store. |
DeidentifiedStoreDestination
Contains configuration for streaming de-identified FHIR export.
Fields | |
---|---|
store |
The full resource name of a Cloud Healthcare FHIR store, for example, |
config |
The configuration to use when de-identifying resources that are added to this store. |
FhirNotificationConfig
Contains the configuration for FHIR notifications.
Fields | |
---|---|
pubsub_topic |
The Pub/Sub topic that notifications of changes are published on. Supplied by the client. The notification is a
Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. The Cloud Healthcare API service account, service- If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. |
send_full_resource |
Whether to send full FHIR resource to this Pub/Sub topic. |
send_previous_resource_on_delete |
Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. |
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. |
Union field destination . Specifies the streaming destination. destination can be only one of the following: |
|
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 written to BigQuery tables according to the parameters in 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). |
deidentified_store_destination |
The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set If a resource cannot be de-identified, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging). |
ValidationConfig
Contains the configuration for FHIR profiles and validation.
Fields | |
---|---|
disable_profile_validation |
Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. |
enabled_implementation_guides[] |
A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported:
When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. |
disable_required_field_validation |
Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. |
disable_reference_type_validation |
Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. |
disable_fhirpath_validation |
Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. |
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 |
FhirStoreMetrics
List of metrics for a given FHIR store.
Fields | |
---|---|
name |
The resource name of the FHIR store to get metrics for, in the format |
metrics[] |
List of FhirStoreMetric by resource type. |
FhirStoreMetric
Count of resources and total storage size by type for a given FHIR store.
Fields | |
---|---|
resource_type |
The FHIR resource type this metric applies to. |
count |
The total count of FHIR resources in the store of this resource type. |
structured_storage_size_bytes |
The total amount of structured storage used by FHIR resources of this resource type in the store. |
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. |
GetFhirStoreMetricsRequest
Request to get FHIR store metrics.
Fields | |
---|---|
name |
Required. The resource name of the FHIR store to get metrics for. Authorization requires the following IAM permission on the specified resource
|
GetFhirStoreRequest
Gets a FHIR store.
Fields | |
---|---|
name |
Required. 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 |
Required. 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 |
Union field To enable the Cloud Healthcare API to read from 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_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
This type has no fields.
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 |
Required. 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. |
RollbackFhirResourceFilteringFields
Fields | |
---|---|
operation_ids[] |
Optional. A list of operation IDs to roll back. |
metadata_filter |
Optional. A filter expression that matches data in the Supports the following custom functions:
|
RollbackFhirResourcesRequest
Fields | |
---|---|
name |
Required. The name of the FHIR store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}". Authorization requires the following IAM permission on the specified resource
|
type[] |
Optional. If specified, revert only resources of these types |
rollback_time |
Required. Time point to rollback to. |
filtering_fields |
Optional. Parameters for filtering resources |
force |
Optional. When enabled, changes will be reverted without explicit confirmation |
change_type |
Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type. |
result_gcs_bucket |
Required. Bucket to deposit result |
exclude_rollbacks |
Optional. Specifies whether to exclude earlier rollbacks. |
input_gcs_object |
Optional. Cloud Storage object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted |
RollbackFhirResourcesResponse
Final response of rollback FIHR resources request.
Fields | |
---|---|
fhir_store |
The name of the FHIR store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}". |
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, |
last_updated_partition_config |
The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. |
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 Analytics schema does not gracefully handle extensions with one or more occurrences, anaytics schema also does not handle contained resource. |
ANALYTICS_V2 |
Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics. |
TimePartitioning
Configuration for FHIR BigQuery time-partitioned tables.
Fields | |
---|---|
type |
Type of partitioning. |
expiration_ms |
Number of milliseconds for which to keep the storage for a partition. |
PartitionType
List of time partition types.
Enums | |
---|---|
PARTITION_TYPE_UNSPECIFIED |
Default unknown time. |
HOUR |
Data partitioned by hour. |
DAY |
Data partitioned by day. |
MONTH |
Data partitioned by month. |
YEAR |
Data partitioned by year. |
UpdateFhirStoreRequest
Updates a FHIR store.
Fields | |
---|---|
fhir_store |
Required. 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 |
Required. The update mask applies to the resource. For the |