Index
FhirStoreService
(interface)ApplyAdminConsentsErrorDetail
(message)ApplyAdminConsentsErrorDetail.ConsentErrors
(message)ApplyAdminConsentsRequest
(message)ApplyAdminConsentsRequest.AdminConsents
(message)ApplyAdminConsentsResponse
(message)ApplyConsentsRequest
(message)ApplyConsentsRequest.PatientScope
(message)ApplyConsentsRequest.TimeRange
(message)ApplyConsentsResponse
(message)BigQueryDestination
(message)BigQueryDestination.WriteDisposition
(enum)ComplexDataTypeReferenceParsing
(enum)ConfigureSearchRequest
(message)ConsentEnforcementVersion
(enum)CreateFhirStoreRequest
(message)DeleteFhirStoreRequest
(message)ExportResourcesRequest
(message)ExportResourcesResponse
(message)FhirStore
(message)FhirStore.ConsentConfig
(message)FhirStore.ConsentConfig.AccessDeterminationLogConfig
(message)FhirStore.ConsentConfig.AccessDeterminationLogConfig.LogLevel
(enum)FhirStore.ConsentConfig.ConsentHeaderHandling
(message)FhirStore.ConsentConfig.ConsentHeaderHandling.ScopeProfile
(enum)FhirStore.DeidentifiedStoreDestination
(message)FhirStore.FhirNotificationConfig
(message)FhirStore.SearchConfig
(message)FhirStore.SearchConfig.SearchParameter
(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)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.
ApplyAdminConsents |
---|
Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the This method returns an If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an To enforce a consent check for data access,
|
ApplyConsents |
---|
Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call This method returns an Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). To enforce consent check for data access,
|
ConfigureSearch |
---|
Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an
|
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 |
---|
Import 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 are 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.
|
ApplyAdminConsentsErrorDetail
Contains the error details of the unsupported admin Consent resources for when the [ApplyAdminConsents][] method fails to apply one or more Consent resources.
Fields | |
---|---|
consent_errors[] |
The list of Consent resources that are unsupported or cannot be applied and the error associated with each of them. |
ConsentErrors
The Consent resource name and error.
Fields | |
---|---|
name |
The versioned name of the admin Consent resource, in the format |
error |
The error code and message. |
ApplyAdminConsentsRequest
Request to apply the admin Consent resources for the specified FHIR store.
Fields | |
---|---|
name |
The name of the FHIR store to enforce, in the format Authorization requires the following IAM permission on the specified resource
|
validate_only |
If true, the method only validates Consent resources to make sure they are supported. Otherwise, the method applies the aggregate consent information to update the enforcement model and reindex the FHIR resources. If all Consent resources can be applied successfully, the |
Union field
|
|
new_consents_list |
A new list of admin Consent resources to be applied. Any existing enforced Consents, which are specified in |
AdminConsents
List of admin Consent resources to be applied.
Fields | |
---|---|
names[] |
The versioned names of the admin Consent resource(s), in the format |
ApplyAdminConsentsResponse
Response when all admin Consent resources in scope were processed and all affected resources were reindexed successfully. This structure will be included in the response
when the operation finishes successfully.
Fields | |
---|---|
consent_apply_success |
If |
affected_resources |
The number of resources (including the Consent resources) that may have consent access change. |
failed_resources |
The number of resources (including the Consent resources) that [ApplyAdminConsents][] failed to re-index. |
ApplyConsentsRequest
Request to apply the Consent resources for the specified FHIR store.
Fields | |
---|---|
name |
Required. The name of the FHIR store to enforce, in the format Authorization requires the following IAM permission on the specified resource
|
validate_only |
Optional. If true, the method only validates Consent resources to make sure they are supported. When the operation completes, |
Union field
|
|
patient_scope |
Optional. Scope down to a list of patients. |
time_range |
Optional. Scope down to patients whose most recent consent changes are in the time range. Can only be used with a versioning store (i.e. when |
PatientScope
Apply consents given by a list of patients.
Fields | |
---|---|
patient_ids[] |
Optional. The list of patient IDs whose Consent resources will be enforced. At most 10,000 patients can be specified. An empty list is equivalent to all patients (meaning the entire FHIR store). |
TimeRange
Apply consents given by patients whose most recent consent changes are in the time range. Note that after identifying these patients, the server applies all Consent resources given by those patients, not just the Consent resources within the timestamp in the range.
Fields | |
---|---|
start |
Optional. The earliest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+zz:zz If not specified, the system uses the FHIR store creation time. |
end |
Optional. The latest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+zz:zz If not specified, the system uses the time when [ApplyConsents][] was called. |
ApplyConsentsResponse
Response when all Consent resources in scope were processed and all affected resources were reindexed successfully. This structure is included in the response
when the operation finishes successfully.
Fields | |
---|---|
consent_apply_success |
If |
consent_apply_failure |
If |
affected_resources |
The number of resources (including the Consent resources) that may have consensual access change. |
failed_resources |
The number of resources (including the Consent resources) that [ApplyConsents][] failed to re-index. |
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 |
Use |
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. |
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. |
ConfigureSearchRequest
Request to configure the search parameters for the specified FHIR store.
Fields | |
---|---|
name |
The name of the FHIR store to configure, in the format Authorization requires the following IAM permission on the specified resource
|
canonical_urls[] |
The canonical URLs of the search parameters that are intended to be used for the FHIR store. See https://www.hl7.org/fhir/references.html#canonical for explanation on FHIR canonical urls |
validate_only |
If |
ConsentEnforcementVersion
List of consent enforcement versions supported.
Enums | |
---|---|
CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED |
Users must specify an enforcement version or an error is returned. |
V1 |
Enforcement version 1. See the FHIR Consent resources in the Cloud Healthcare API guide for more details. |
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
|
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 grant the Healthcare Service Agent account the required permissions. For steps to assign the permissions, see Importing data from Cloud Storage. |
|
gcs_destination |
The Cloud Storage output destination. The Cloud Healthcare Service Agent 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. 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 |
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 |
search_config |
Configuration for how FHIR resources can be searched. |
notification_configs[] |
Specifies where and whether to send notifications upon changes to a Fhir store. |