Console
    Contact Us Start free

    Package google.cloud.healthcare.v1beta1.fhir

    Index

    FhirStoreService

    A service for handling FHIR stores inside a healthcare dataset.

    ApplyAdminConsents

    rpc ApplyAdminConsents( ApplyAdminConsentsRequest ) returns ( Operation )

    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 consent_config.enforced_admin_consents field of the FhirStore unless validate_only=true in ApplyAdminConsentsRequest . Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect.

    This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation . Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed.

    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 Operation . No resources will be reindexed and the consent_config.enforced_admin_consents field will be unchanged.

    To enforce a consent check for data access, consent_config.access_enforced must be set to true for the FhirStore .

    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 .

    ApplyConsents

    rpc ApplyConsents( ApplyConsentsRequest ) returns ( Operation )

    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 ApplyConsents again to have effect.

    This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation . Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed.

    Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging ).

    To enforce consent check for data access, consent_config.access_enforced must be set to true for the FhirStore .

    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 .

    ConfigureSearch

    rpc ConfigureSearch( ConfigureSearchRequest ) returns ( Operation )

    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 Operation that can be used to track the progress of the reindexing by calling GetOperation .

    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 .

    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 .

    ExplainDataAccess

    rpc ExplainDataAccess( ExplainDataAccessRequest ) returns ( ExplainDataAccessResponse )

    Explains all the permitted/denied actor, purpose and environment for a given 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 .

    ExportResources

    rpc ExportResources( ExportResourcesRequest ) returns ( Operation )

    Export resources from the FHIR store to the specified destination.

    This method returns an Operation that can be used to track the status of the export by calling GetOperation .

    Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging ). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata .

    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 .

    GetFhirStoreMetrics

    rpc GetFhirStoreMetrics( GetFhirStoreMetricsRequest ) returns ( FhirStoreMetrics )

    Gets metrics associated with the 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 .

    ImportResources

    rpc ImportResources( ImportResourcesRequest ) returns ( Operation )

    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 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 enable_update_create setting on the FHIR store. 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.

    The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity.

    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 disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once.

    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 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 are specified by the parameters in ImportResourcesRequest . Note that if no format is specified, this method assumes the BUNDLE format. When using the BUNDLE format this method ignores the Bundle.type field, except that history bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle , transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in Bundle.entry.resource , ignoring Bundle.entry.request . As an example, this allows the import of searchset bundles produced by a FHIR search or Patient-everything operation.

    This method returns an Operation that can be used to track the status of the import by calling GetOperation .

    Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging ). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata .

    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 .

    RollbackFhirResources

    rpc RollbackFhirResources( RollbackFhirResourcesRequest ) returns ( Operation )

    Rolls back resources from the FHIR store to the specified time.

    This method returns an Operation that can be used to track the status of the rollback by calling GetOperation .

    Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging ). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata .

    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 .

    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[]

    ConsentErrors

    The list of Consent resources that are unsupported or cannot be applied and the error associated with each of them.
    existing_operation_id

    uint64

    The currently in progress non-validate-only ApplyAdminConsents operation ID if exist.

    ConsentErrors

    The Consent resource name and error.

    Fields
    name

    string

    The versioned name of the admin Consent resource, in the format projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id} . For FHIR stores with disable_resource_versioning=true , the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id} .
    error

    Status

    The error code and message.

    ApplyAdminConsentsRequest

    Request to apply the admin Consent resources for the specified FHIR store.

    Fields
    name

    string

    Required. The name of the FHIR store to enforce, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id} .

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

    • healthcare.fhirStores.applyConsents
    validate_only

    bool

    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 ApplyAdminConsentsResponse is returned containing the following fields: * consent_apply_success to indicate the number of Consent resources applied. * affected_resources to indicate the number of resources that might have had their consent access changed. If, however, one or more Consent resources are unsupported or cannot be applied, the method fails and ApplyAdminConsentsErrorDetail is is returned with details about the unsupported Consent resources.

    Union field payload .

    payload can be only one of the following:

    new_consents_list

    AdminConsents

    A new list of admin Consent resources to be applied. Any existing enforced Consents, which are specified in consent_config.enforced_admin_consents of the FhirStore , that are not part of this list will be disabled. An empty list is equivalent to clearing or disabling all Consents enforced on the FHIR store. When a FHIR store has disable_resource_versioning=true and this list contains a Consent resource that exists in consent_config.enforced_admin_consents , the method enforces any updates to the existing resource since the last enforcement. If the existing resource hasn't been updated since the last enforcement, the resource is unaffected. After the method finishes, the resulting consent enforcement model is determined by the contents of the Consent resource(s) when the method was called: * When disable_resource_versioning=true , the result is identical to the current resource(s) in the FHIR store. * When disable_resource_versioning=false , the result is based on the historical version(s) of the Consent resource(s) at the point in time when the method was called. At most 200 Consents can be specified.

    AdminConsents

    List of admin Consent resources to be applied.

    Fields
    names[]

    string

    The versioned names of the admin Consent resource(s), in the format projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id} . For FHIR stores with disable_resource_versioning=true , the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id} .

    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

    int64

    If validate_only=false in ApplyAdminConsentsRequest , this counter contains the number of Consent resources that were successfully applied. Otherwise, it is the number of Consent resources that are supported.
    affected_resources

    int64

    The number of resources (including the Consent resources) that may have consent access change.
    failed_resources

    int64

    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

    string

    Required. The name of the FHIR store to enforce, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id} .

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

    • healthcare.fhirStores.applyConsents
    validate_only

    bool

    Optional. If true, the method only validates Consent resources to make sure they are supported. When the operation completes, ApplyConsentsResponse is returned where consent_apply_success and consent_apply_failure indicate supported and unsupported (or invalid) Consent resources, respectively. Otherwise, the method propagates the aggregate consensual information to the patient's resources. Upon success, affected_resources in the ApplyConsentsResponse indicates the number of resources that may have consensual access changed.

    Union field scope .

    scope can be only one of the following:

    patient_scope

    PatientScope

    Optional. Scope down to a list of patients.

    time_range

    TimeRange

    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 disable_resource_versioning is set to false).

    PatientScope

    Apply consents given by a list of patients.

    Fields
    patient_ids[]

    string

    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

    string

    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

    string

    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

    int64

    If validate_only = false in ApplyConsentsRequest , this counter is the number of Consent resources that were successfully applied. Otherwise, it is the number of Consent resources that are supported.
    consent_apply_failure

    int64

    If validate_only = false in ApplyConsentsRequest , this counter is the number of Consent resources that were failed to apply. Otherwise, it is the number of Consent resources that are not supported or invalid.
    affected_resources

    int64

    The number of resources (including the Consent resources) that may have consensual access change.
    failed_resources

    int64

    The number of resources (including the Consent resources) that [ApplyConsents][] failed to re-index.

    BigQueryDestination

    The configuration for exporting to BigQuery.

    Fields
    dataset_uri

    string

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

    SchemaConfig

    The configuration for the exported BigQuery schema.
    force

    bool

    Use write_disposition instead. If write_disposition is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.
    write_disposition

    WriteDisposition

    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 force parameter is ignored.

    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.

    ConfigureSearchRequest

    Request to configure the search parameters for the specified FHIR store.

    Fields
    name

    string

    Required. The name of the FHIR store to configure, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id} .

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

    • healthcare.fhirStores.configureSearch
    canonical_urls[]

    string

    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

    bool

    If validate_only is set to true, the method will compile all the search parameters without actually setting the search config for the store and triggering the reindex.

    ConfigureSearchResponse

    This type has no fields.

    Response when all resources are reindexed successfully. This structure will be included in the response when the operation finishes successfully.

    ConsentAccessorScope

    The accessor scope that describes who can access, for what purpose, in which environment.

    Fields
    actor

    string

    An individual, group, or access role that identifies the accessor or a characteristic of the accessor. This can be a resource ID (such as {resourceType}/{id} ) or an external URI. This value must be present.
    purpose

    string

    The intent of data use. Can be "*" if it applies to all purposes.
    environment

    string

    An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be "*" if it applies to all environments.

    ConsentDecisionType

    List of consent decision outcomes.

    Enums
    CONSENT_DECISION_TYPE_UNSPECIFIED Unspecified consent decision type.
    CONSENT_DECISION_TYPE_PERMIT Consent permitted access.
    CONSENT_DECISION_TYPE_DENY Consent denied access.

    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.

    ConsentPolicyType

    List of consent policy types.

    Enums
    CONSENT_POLICY_TYPE_UNSPECIFIED Unspecified policy type.
    CONSENT_POLICY_TYPE_PATIENT Consent represent a patient consent.
    CONSENT_POLICY_TYPE_ADMIN Consent represent an admin consent.

    ConsentVariant

    List of consent policy variants.

    Enums
    CONSENT_VARIANT_UNSPECIFIED Consent variant unspecified.
    CONSENT_VARIANT_STANDARD Consent is a standard patient or admin consent.
    CONSENT_VARIANT_CASCADE Consent is a cascading consent.

    CreateFhirStoreRequest

    Creates a new FHIR store.

    Fields
    parent

    string

    Required. The name of the dataset this FHIR store belongs to.

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

    • healthcare.fhirStores.create
    fhir_store_id

    string

    Required. 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

    Required. Configuration info for this FHIR store.

    DeleteFhirStoreRequest

    Deletes the specified FHIR store.

    Fields
    name

    string

    Required. The resource name of the FHIR store to delete.

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

    • healthcare.fhirStores.delete

    ExplainDataAccessConsentInfo

    The enforcing consent's metadata.

    Fields
    consent_resource

    string

    The resource name of this consent resource, in the format: projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id} .
    type

    ConsentPolicyType

    The policy type of consent resource (e.g. PATIENT, ADMIN).
    variants[]

    ConsentVariant

    The consent's variant combinations. A single consent may have multiple variants.
    enforcement_time

    Timestamp

    Last enforcement timestamp of this consent resource.
    cascade_origins[]

    string

    The compartment base resources that matched a cascading policy. Each resource has the following format: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/{resource_type}/{resource_id}

    matching_accessor_scopes[]

    ConsentAccessorScope

    A list of all the matching accessor scopes of this consent policy that enforced ExplainDataAccessConsentScope.accessor_scope.

    ExplainDataAccessConsentScope

    A single consent scope that provides info on who has access to the requested resource scope for a particular purpose and environment, enforced by which consent.

    Fields
    decision

    ConsentDecisionType

    Whether the current consent scope is permitted or denied access on the requested resource.
    enforcing_consents[]

    ExplainDataAccessConsentInfo

    Metadata of the consent resources that enforce the consent scope's access.
    exceptions[]

    ExplainDataAccessConsentScope

    Other consent scopes that created exceptions within this scope.
    accessor_scope

    ConsentAccessorScope

    The accessor scope that describes who can access, for what purpose, and in which environment.

    ExplainDataAccessRequest

    Request to explain which combination of actor, purpose, environment have access to a given resource.

    Fields
    name

    string

    Required. The name of the FHIR store to enforce, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id} .

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

    • healthcare.fhirStores.explainDataAccess
    resource_id

    string

    Required. The ID ( {resourceType}/{id} ) of the resource to explain data access on.

    ExplainDataAccessResponse

    List of consent scopes that are applicable to the explained access on a given resource.

    Fields
    consent_scopes[]

    ExplainDataAccessConsentScope

    List of applicable consent scopes. Sorted in order of actor such that scopes belonging to the same actor will be adjacent to each other in the list.
    warning

    string

    Warnings associated with this response. It inform user with exceeded scope limit errors.

    ExportResourcesRequest

    Request to export resources.

    Fields
    name

    string

    Required. The name of the FHIR store to export resource from, 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 name :

    • healthcare.fhirStores.export
    since

    string

    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, 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z . The time must be specified to the second and include a time zone.

    type

    string

    String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.

    Union field destination . The output destination of the export.

    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 . destination can be only one of the following:

    gcs_destination

    GcsDestination

    The Cloud Storage output destination.

    The Cloud Healthcare Service Agent requires the roles/storage.objectAdmin Cloud IAM roles on the Cloud Storage location.

    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

    BigQueryDestination

    The BigQuery output destination.

    The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: roles/bigquery.dataEditor and roles/bigquery.jobUser .

    The output is one BigQuery table per resource type.

    Unlike when setting BigQueryDestination for StreamConfig , ExportResources does not create BigQuery views.

    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

    string

    Output only. Identifier. Resource name of the FHIR store, of the form projects/{project_id}/locations/{location}/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 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)

    NotificationConfig

    Deprecated. Use notification_configs instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The 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

    bool

    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

    bool

    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

    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.
    version

    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[]

    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 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 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_modifications

    bool

    Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error.
    validation_config

    ValidationConfig

    Configuration for how to validate incoming FHIR resources against configured profiles.
    default_search_handling_strict

    bool

    If true, overrides the default search behavior for this FHIR store to handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient .
    search_config

    SearchConfig

    Configuration for how FHIR resources can be searched.
    notification_configs[]

    FhirNotificationConfig

    Specifies where and whether to send notifications upon changes to a Fhir store.
    consent_config

    ConsentConfig

    Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
    complex_data_type_reference_parsing

    ComplexDataTypeReferenceParsing

    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.

    ConsentConfig

    Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used.

    Fields
    version

    ConsentEnforcementVersion

    Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either [CreateFhirStore][] or [UpdateFhirStore][]. After that, you must call [ApplyConsents][] to change the version.
    access_enforced

    bool

    Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.
    consent_header_handling

    ConsentHeaderHandling

    Optional. Different options to configure the behaviour of the server when handling the X-Consent-Scope header.
    access_determination_log_config

    AccessDeterminationLogConfig

    Optional. Specifies how the server logs the consent-aware requests. If not specified, the AccessDeterminationLogConfig.LogLevel.MINIMUM option is used.
    enforced_admin_consents[]

    string

    The versioned names of the enforced admin Consent resource(s), in the format projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id} . For FHIR stores with disable_resource_versioning=true , the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id} . This field can only be updated using [ApplyAdminConsents][].

    AccessDeterminationLogConfig

    Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be enabled . The consent-related logs are included as part of protoPayload.metadata .

    Fields
    log_level

    LogLevel

    Optional. Controls the amount of detail to include as part of the audit logs.

    LogLevel

    Lists the options for audit logging.

    Enums
    LOG_LEVEL_UNSPECIFIED
    No log level specified. This value is unused.
    DISABLED
    No additional consent-related logging is added to audit logs.
    MINIMUM

    The following information is included:

    • One of the following consentMode fields: ( off | emptyScope | enforced | btg | bypass ).
    • The accessor's request headers
    • The log_level of the [AccessDeterminationLogConfig][projects.locations.datasets.fhirStores#AccessDeterminationLogConfig]
    • The final consent evaluation ( PERMIT , DENY , or NO_CONSENT )
    • A human-readable summary of the evaluation
    VERBOSE

    Includes MINIMUM and, for each resource owner, returns: * The resource owner's name * Most specific part of the X-Consent-Scope resulting in consensual determination * Timestamp of the applied enforcement leading to the decision * Enforcement version at the time the applicable consents were applied * The Consent resource name * The timestamp of the Consent resource used for enforcement * Policy type ( PATIENT or ADMIN )

    Note that this mode adds some overhead to CRUD operations.

    ConsentHeaderHandling

    How the server handles the consent header.

    Fields
    profile

    ScopeProfile

    Optional. Specifies the default server behavior when the header is empty. If not specified, the ScopeProfile.PERMIT_EMPTY_SCOPE option is used.

    ScopeProfile

    Options for general consent header scope handling.

    Enums
    SCOPE_PROFILE_UNSPECIFIED If not specified, the default value PERMIT_EMPTY_SCOPE is used.
    PERMIT_EMPTY_SCOPE When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false . You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode . If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code.
    REQUIRED_ON_READ The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected.

    DeidentifiedStoreDestination

    Contains configuration for streaming de-identified FHIR export.

    Fields
    store

    string

    The full resource name of a Cloud Healthcare FHIR store, for example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id} .
    config

    DeidentifyConfig

    The configuration to use when de-identifying resources that are added to this store.

    FhirNotificationConfig

    Contains the configuration for FHIR notifications.

    Fields
    pubsub_topic

    string

    The Pub/Sub topic that notifications of changes are published on. Supplied by the client.

    The notification is a PubsubMessage with the following fields:

    • PubsubMessage.Data contains the resource name.
    • PubsubMessage.MessageId is the ID of this notification. It is guaranteed to be unique within the topic.
    • PubsubMessage.PublishTime is the time when the message was published.

    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- @gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail ( https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions) .

    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

    bool

    Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all 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 resource as a separate operation.

    send_previous_resource_on_delete

    bool

    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.

    SearchConfig

    Contains the configuration for FHIR search.

    Fields
    search_parameters[]

    SearchParameter

    A list of search parameters in this FHIR store that are used to configure this FHIR store.

    SearchParameter

    Contains the versioned name and the URL for one SearchParameter.

    Fields
    parameter

    string

    The versioned name of the search parameter resource. The format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{version-id} For fhir stores with disable_resource_versioning=true, the format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/
    canonical_url

    string

    The canonical url of the search parameter resource.

    StreamConfig

    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 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

    BigQueryDestination

    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, e.g. "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.

    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.

    BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed.

    Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition . 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 will be logged to Cloud Logging (see Viewing error logs in Cloud Logging ).

    deidentified_store_destination

    DeidentifiedStoreDestination

    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 enable_update_create to true. The destination store must have disable_referential_integrity set to true.

    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

    bool

    Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.
    enabled_implementation_guides[]

    string

    A list of ImplementationGuide 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 enabled_implementation_guides to ["http://hl7.org/fhir/us/core/ImplementationGuide/ig"] . If enabled_implementation_guides is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the global property of one of the enabled ImplementationGuides.

    The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported:

     - min/max
- minValue/maxValue
- maxLength
- type
- fixed[x]
- pattern[x] on simple types
- slicing, when using "value" as the discriminator type

    When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.
    disable_required_field_validation

    bool

    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

    bool

    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

    bool

    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 VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores.
    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

    string

    The resource name of the FHIR store to get metrics for, in the format projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id} .
    metrics[]

    FhirStoreMetric

    List of FhirStoreMetric by resource type.

    FhirStoreMetric

    Count of resources and total storage size by type for a given FHIR store.

    Fields
    resource_type

    string

    The FHIR resource type this metric applies to.
    count

    int64

    The total count of FHIR resources in the store of this resource type.
    structured_storage_size_bytes

    int64

    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

    string

    URI for a Cloud Storage directory where result files should be written (in the format gs://{bucket-id}/{path/to/destination/dir} ). If there is no trailing slash, the service appends one when composing the object path. The Cloud Storage bucket referenced in uri_prefix must exist or an error occurs.

    GcsSource

    Specifies the configuration for importing data from Cloud Storage.

    Fields
    uri

    string

    Points to a Cloud Storage URI containing file(s) to import.

    The URI must be in the following format: gs://{bucket_id}/{object_id} . The URI can include wildcards in object_id and thus identify multiple files. Supported wildcards:

    • * to match 0 or more non-separator characters
    • ** to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, gs://my-bucket/my-directory/**.ndjson imports all files with .ndjson extensions in my-directory/ and its sub-directories.
    • ? to match 1 character

    Files matching the wildcard are expected to contain content only, no metadata.

    GetFhirStoreMetricsRequest

    Request to get FHIR store metrics.

    Fields
    name

    string

    Required. The resource name of the FHIR store to get metrics for.

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

    • healthcare.fhirStores.get

    GetFhirStoreRequest

    Gets a FHIR store.

    Fields
    name

    string

    Required. The resource name of the FHIR store to get.

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

    • healthcare.fhirStores.get

    ImportResourcesRequest

    Request to import resources.

    Fields
    name

    string

    Required. The name of the FHIR store to import FHIR resources to, 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 name :

    • healthcare.fhirStores.import
    content_structure

    ContentStructure

    The content structure in the source location. If not specified, the server treats the input source files as BUNDLE .

    Union field source . Specifies the import source and configuration.

    To enable the Cloud Healthcare API to read from 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 . source can be only one of the following:

    gcs_source

    GcsSource

    Cloud Storage source data location and import configuration.

    The Cloud Healthcare Service Agent requires the roles/storage.objectViewer Cloud IAM roles on the Cloud Storage location.

    The Healthcare Service Agent

    Each Cloud Storage object should be a text file that contains the format specified in ContentStructure .

    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

    string

    Required. Name of the dataset.

    Authorization requires the following 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 not specified, 100 is used. May not be larger than 1000.

    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. The following syntax is available:

    • A string field value can be written as text inside quotation marks, for example "query text" . The only valid relational operation for text fields is equality ( = ), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with great in the comment field.
    • A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator ( = ), along with the less than/greater than operators ( < , <= , > , >= ). Note that there is no inequality ( != ) operator. You can prepend the NOT operator to an expression to negate it.
    • A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator ( = ) , along with the less than/greater than operators ( < , <= , > , >= ). Note that there is no inequality ( != ) operator. You can prepend the NOT operator to an expression to negate it.
    • Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it.

    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.

    RollbackFhirResourceFilteringFields

    Filters to select resources that need to be rolled back.

    Fields
    operation_ids[]

    uint64

    Optional. A list of operation IDs to roll back. Only changes made by these operations will be rolled back.

    metadata_filter

    string

    Optional. A filter expression that matches data in the Resource.meta element. Supports all filters in AIP-160 except the "has" ( : ) operator.

    Supports the following custom functions:

    • tag("<system>") = "<code>" for tag filtering.
    • extension_value_ts("<uri>") = <timestamp> for filtering extensions with a timestamp, where <timestamp> is a Unix timestamp. Supports the > , < , <= , >= , and != comparison operators.

    RollbackFhirResourcesRequest

    Request to roll back resources.

    Fields
    name

    string

    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 name :

    • healthcare.fhirStores.rollback
    type[]

    string

    Optional. If specified, revert only resources of these types

    rollback_time

    Timestamp

    Required. Time point to rollback to.

    filtering_fields

    RollbackFhirResourceFilteringFields

    Optional. Tag represents fields that HDE needs to identify resources that will be reverted. Parameters for filtering resources

    force

    bool

    Optional. When enabled, changes will be reverted without explicit confirmation

    change_type

    ChangeType

    Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type.

    result_gcs_bucket

    string

    Required. Bucket to deposit result

    exclude_rollbacks

    bool

    Optional. Specifies whether to exclude earlier rollbacks.

    input_gcs_object

    string

    Optional. Cloud Storage object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted

    RollbackFhirResourcesResponse

    Final response of rollback FHIR resources request.

    Fields
    fhir_store

    string

    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

    SchemaType

    Specifies the output schema type. Schema type is required.
    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. The maximum depth allowed is 5.
    last_updated_partition_config

    TimePartitioning

    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.
    LOSSLESS

    A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification.

    This type cannot be used for streaming to BigQuery.
    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 Resource , which can hold any resource type. The affected fields are Parameters.parameter.resource , Bundle.entry.resource , and Bundle.entry.response.outcome .

    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

    PartitionType

    Type of partitioning.
    expiration_ms

    int64

    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

    FhirStore

    Required. The FHIR store that updates the resource in the server. Only fields listed in the update_mask are applied.

    Authorization requires the following IAM permission on the specified resource fhirStore :

    • healthcare.fhirStores.update
    update_mask

    FieldMask

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

    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: