Google Cloud Healthcare FHIR Store

This page shows how to write Terraform for Cloud Healthcare FHIR Store and write them securely.

google_healthcare_fhir_store (Terraform)

The FHIR Store in Cloud Healthcare can be configured in Terraform with the resource name google_healthcare_fhir_store. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).


Identifies the dataset addressed by this request. Must be in the format 'projects/[project]/locations/[location]/datasets/[dataset]'

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

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

Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. Changing this property may recreate the FHIR store (removing all data) This property can be changed manually in the Google Cloud Healthcare admin console without recreating the FHIR store

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

  • id optional computed - string
  • labels optional - map from string to 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. An object containing a list of "key": value pairs. Example: [ "name": "wrench", "mass": "1.3kg", "count": "3" ].

The resource name for the FhirStore. Changing this property may recreate the FHIR store (removing all data)

The fully qualified name of this dataset

The FHIR specification version. Possible values: ["DSTU2", "STU3", "R4"]

  • notification_config list block

    The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.

  • stream_configs list block

    Supply a FHIR resource type (such as "Patient" or "Observation"). See for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.

    • bigquery_destination list block

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

      • schema_config list block

        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.

        Specifies the output schema type. Only ANALYTICS is supported at this time. * ANALYTICS: Analytics schema defined by the FHIR community. See Default value: "ANALYTICS" Possible values: ["ANALYTICS"]

  • timeouts single block

Explanation in Terraform Registry

A FhirStore is a datastore inside a Healthcare dataset that conforms to the FHIR ( standard for Healthcare information exchange To get more information about FhirStore, see:

Frequently asked questions

What is Google Cloud Healthcare FHIR Store?

Google Cloud Healthcare FHIR Store is a resource for Cloud Healthcare of Google Cloud Platform. Settings can be wrote in Terraform.


Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.