---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_healthcare_fhir_store{% #gcp_healthcare_fhir_store %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `bulk_export_gcs_destination`{% #bulk_export_gcs_destination %}

**Type**: `STRUCT`**Provider name**: `bulkExportGcsDestination`**Description**: Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination.

- `uri_prefix`**Type**: `STRING`**Provider name**: `uriPrefix`**Description**: Optional. URI for a Cloud Storage directory where the server writes result files, 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 user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`.

## `complex_data_type_reference_parsing`{% #complex_data_type_reference_parsing %}

**Type**: `STRING`**Provider name**: `complexDataTypeReferenceParsing`**Description**: Optional. 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. Cannot be disabled in R5.**Possible values**:

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

## `consent_config`{% #consent_config %}

**Type**: `STRUCT`**Provider name**: `consentConfig`**Description**: Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. Not supported for R5 FHIR version.

- `access_determination_log_config`**Type**: `STRUCT`**Provider name**: `accessDeterminationLogConfig`**Description**: Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used.
  - `log_level`**Type**: `STRING`**Provider name**: `logLevel`**Description**: Optional. Controls the amount of detail to include as part of the audit logs.**Possible values**:
    - `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`](https://cloud.google.com/healthcare-api/docs/fhir-consent#audit_logs) fields: (`off`|`emptyScope`|`enforced`|`btg`|`bypass`). * The accessor's request headers * The `log_level` of the 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`) Due to the limited space for logging, this mode is the same as `MINIMUM` for methods that return multiple resources (such as FHIR Search).
- `access_enforced`**Type**: `BOOLEAN`**Provider name**: `accessEnforced`**Description**: Optional. The default value is false. 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`**Type**: `STRUCT`**Provider name**: `consentHeaderHandling`**Description**: Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header.
  - `profile`**Type**: `STRING`**Provider name**: `profile`**Description**: Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used.**Possible values**:
    - `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.
- `enforced_admin_consents`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `enforcedAdminConsents`**Description**: Output only. 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.
- `version`**Type**: `STRING`**Provider name**: `version`**Description**: 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.**Possible values**:
  - `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](https://cloud.google.com/healthcare-api/docs/fhir-consent) guide for more details.

## `default_search_handling_strict`{% #default_search_handling_strict %}

**Type**: `BOOLEAN`**Provider name**: `defaultSearchHandlingStrict`**Description**: Optional. 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`. Defaults to false.

## `disable_referential_integrity`{% #disable_referential_integrity %}

**Type**: `BOOLEAN`**Provider name**: `disableReferentialIntegrity`**Description**: 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`{% #disable_resource_versioning %}

**Type**: `BOOLEAN`**Provider name**: `disableResourceVersioning`**Description**: 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, 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. Defaults to false.

## `enable_update_create`{% #enable_update_create %}

**Type**: `BOOLEAN`**Provider name**: `enableUpdateCreate`**Description**: Optional. Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). 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. Defaults to false.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.

## `notification_config`{% #notification_config %}

**Type**: `STRUCT`**Provider name**: `notificationConfig`**Description**: 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". Not supported in R5. Use `notification_configs` instead.

- `pubsub_topic`**Type**: `STRING`**Provider name**: `pubsubTopic`**Description**: The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details.
- `send_for_bulk_import`**Type**: `BOOLEAN`**Provider name**: `sendForBulkImport`**Description**: Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.

## `notification_configs`{% #notification_configs %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `notificationConfigs`**Description**: Optional. Specifies where and whether to send notifications upon changes to a FHIR store.

- `pubsub_topic`**Type**: `STRING`**Provider name**: `pubsubTopic`**Description**: Optional. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) 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](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, [service-@gcp-sa-healthcare.iam.gserviceaccount.com](mailto: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)](https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions%29). 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](https://cloud.google.com/healthcare-api/docs/how-tos/logging).
- `send_full_resource`**Type**: `BOOLEAN`**Provider name**: `sendFullResource`**Description**: Optional. Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.
- `send_previous_resource_on_delete`**Type**: `BOOLEAN`**Provider name**: `sendPreviousResourceOnDelete`**Description**: Optional. Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. 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.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `stream_configs`{% #stream_configs %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `streamConfigs`**Description**: Optional. 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`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.

- `bigquery_destination`**Type**: `STRUCT`**Provider name**: `bigqueryDestination`**Description**: Optional. 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 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 are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
  - `dataset_uri`**Type**: `STRING`**Provider name**: `datasetUri`**Description**: Optional. BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`.
  - `force`**Type**: `BOOLEAN`**Provider name**: `force`**Description**: Optional. The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. 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.
  - `schema_config`**Type**: `STRUCT`**Provider name**: `schemaConfig`**Description**: Optional. The configuration for the exported BigQuery schema.
    - `last_updated_partition_config`**Type**: `STRUCT`**Provider name**: `lastUpdatedPartitionConfig`**Description**: The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
      - `expiration_ms`**Type**: `INT64`**Provider name**: `expirationMs`**Description**: Number of milliseconds for which to keep the storage for a partition.
      - `type`**Type**: `STRING`**Provider name**: `type`**Description**: Type of partitioning.**Possible values**:
        - `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.
    - `recursive_structure_depth`**Type**: `INT64`**Provider name**: `recursiveStructureDepth`**Description**: 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.
    - `schema_type`**Type**: `STRING`**Provider name**: `schemaType`**Description**: Specifies the output schema type. Schema type is required.**Possible values**:
      - `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](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. Additionally, extensions with a URL ending in '/{existing_resource_field_name}' may cause undefined behavior.
      - `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. Extensions with a URL ending in '/{existing_resource_field_name}' will cause conflict and prevent the resource from being sent to BigQuery. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics.
  - `write_disposition`**Type**: `STRING`**Provider name**: `writeDisposition`**Description**: Optional. 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.**Possible values**:
    - `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.
- `deidentified_store_destination`**Type**: `STRUCT`**Provider name**: `deidentifiedStoreDestination`**Description**: 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. Resources deleted from the source store will be deleted from 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](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). 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](https://cloud.google.com/healthcare/docs/how-tos/logging)). Not supported for R5 stores.
  - `config`**Type**: `STRUCT`**Provider name**: `config`**Description**: Optional. The configuration to use when de-identifying resources that are added to this store.
    - `dicom`**Type**: `STRUCT`**Provider name**: `dicom`**Description**: Optional. Configures de-id of application/DICOM content.
      - `filter_profile`**Type**: `STRING`**Provider name**: `filterProfile`**Description**: Tag filtering profile that determines which tags to keep/remove.**Possible values**:

        - `TAG_FILTER_PROFILE_UNSPECIFIED` - No tag filtration profile provided. Same as KEEP_ALL_PROFILE.
        - `MINIMAL_KEEP_LIST_PROFILE` - Keep only tags required to produce valid DICOM.
        - `ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE` - Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) [http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html).
        - `KEEP_ALL_PROFILE` - Keep all tags.
        - `DEIDENTIFY_TAG_CONTENTS` - Inspects within tag contents and replaces sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS

      - `keep_list`**Type**: `STRUCT`**Provider name**: `keepList`**Description**: List of tags to keep. Remove all other tags.

      - `remove_list`**Type**: `STRUCT`**Provider name**: `removeList`**Description**: List of tags to remove. Keep all other tags.

      - `skip_id_redaction`**Type**: `BOOLEAN`**Provider name**: `skipIdRedaction`**Description**: Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." [http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html](http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html)
    - `fhir`**Type**: `STRUCT`**Provider name**: `fhir`**Description**: Optional. Configures de-id of application/FHIR content.
      - `default_keep_extensions`**Type**: `BOOLEAN`**Provider name**: `defaultKeepExtensions`**Description**: Optional. The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default.
      - `field_metadata_list`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `fieldMetadataList`**Description**: Optional. Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`.
        - `action`**Type**: `STRING`**Provider name**: `action`**Description**: Optional. Deidentify action for one field.**Possible values**:
          - `ACTION_UNSPECIFIED` - No action specified. Defaults to DO_NOT_TRANSFORM.
          - `TRANSFORM` - Transform the entire field.
          - `INSPECT_AND_TRANSFORM` - Inspect and transform any found PHI.
          - `DO_NOT_TRANSFORM` - Do not transform.
        - `paths`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `paths`**Description**: Optional. List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml.
    - `image`**Type**: `STRUCT`**Provider name**: `image`**Description**: Optional. Configures de-identification of image pixels wherever they are found in the source_dataset.
      - `text_redaction_mode`**Type**: `STRING`**Provider name**: `textRedactionMode`**Description**: Optional. Determines how to redact text from image.**Possible values**:
        - `TEXT_REDACTION_MODE_UNSPECIFIED` - No text redaction specified. Same as REDACT_NO_TEXT.
        - `REDACT_ALL_TEXT` - Redact all text.
        - `REDACT_SENSITIVE_TEXT` - Redact sensitive text. Uses the set of [Default DICOM InfoTypes](https://cloud.google.com/healthcare-api/docs/how-tos/dicom-deidentify#default_dicom_infotypes).
        - `REDACT_NO_TEXT` - Do not redact text.
    - `text`**Type**: `STRUCT`**Provider name**: `text`**Description**: Optional. Configures de-identification of text wherever it is found in the source_dataset.
      - `additional_transformations`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `additionalTransformations`**Description**: Optional. Transformations to apply to the detected data, overridden by `exclude_info_types`.
        - `character_mask_config`**Type**: `STRUCT`**Provider name**: `characterMaskConfig`**Description**: Config for character mask.

          - `masking_character`**Type**: `STRING`**Provider name**: `maskingCharacter`**Description**: Optional. Character to mask the sensitive values. If not supplied, defaults to "*".

        - `crypto_hash_config`**Type**: `STRUCT`**Provider name**: `cryptoHashConfig`**Description**: Config for crypto hash.

          - `kms_wrapped`**Type**: `STRUCT`**Provider name**: `kmsWrapped`**Description**: KMS wrapped key. Must not be set if `crypto_key` is set.
            - `crypto_key`**Type**: `STRING`**Provider name**: `cryptoKey`**Description**: Required. The resource name of the KMS CryptoKey to use for unwrapping. For example, `projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}`.

        - `date_shift_config`**Type**: `STRUCT`**Provider name**: `dateShiftConfig`**Description**: Config for date shift.

          - `kms_wrapped`**Type**: `STRUCT`**Provider name**: `kmsWrapped`**Description**: KMS wrapped key. If `kms_wrapped` is not set, then `crypto_key` is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if `crypto_key` is set.
            - `crypto_key`**Type**: `STRING`**Provider name**: `cryptoKey`**Description**: Required. The resource name of the KMS CryptoKey to use for unwrapping. For example, `projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}`.

        - `info_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `infoTypes`**Description**: Optional. InfoTypes to apply this transformation to. If this is not specified, the transformation applies to any info_type.

        - `redact_config`**Type**: `STRUCT`**Provider name**: `redactConfig`**Description**: Config for text redaction.

        - `replace_with_info_type_config`**Type**: `STRUCT`**Provider name**: `replaceWithInfoTypeConfig`**Description**: Config for replace with InfoType.
      - `exclude_info_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `excludeInfoTypes`**Description**: Optional. InfoTypes to skip transforming, overriding `additional_transformations`.
      - `transformations`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `transformations`**Description**: Optional. The transformations to apply to the detected data. Deprecated. Use `additional_transformations` instead.
        - `character_mask_config`**Type**: `STRUCT`**Provider name**: `characterMaskConfig`**Description**: Config for character mask.

          - `masking_character`**Type**: `STRING`**Provider name**: `maskingCharacter`**Description**: Optional. Character to mask the sensitive values. If not supplied, defaults to "*".

        - `crypto_hash_config`**Type**: `STRUCT`**Provider name**: `cryptoHashConfig`**Description**: Config for crypto hash.

          - `kms_wrapped`**Type**: `STRUCT`**Provider name**: `kmsWrapped`**Description**: KMS wrapped key. Must not be set if `crypto_key` is set.
            - `crypto_key`**Type**: `STRING`**Provider name**: `cryptoKey`**Description**: Required. The resource name of the KMS CryptoKey to use for unwrapping. For example, `projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}`.

        - `date_shift_config`**Type**: `STRUCT`**Provider name**: `dateShiftConfig`**Description**: Config for date shift.

          - `kms_wrapped`**Type**: `STRUCT`**Provider name**: `kmsWrapped`**Description**: KMS wrapped key. If `kms_wrapped` is not set, then `crypto_key` is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if `crypto_key` is set.
            - `crypto_key`**Type**: `STRING`**Provider name**: `cryptoKey`**Description**: Required. The resource name of the KMS CryptoKey to use for unwrapping. For example, `projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}`.

        - `info_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `infoTypes`**Description**: Optional. InfoTypes to apply this transformation to. If this is not specified, the transformation applies to any info_type.

        - `redact_config`**Type**: `STRUCT`**Provider name**: `redactConfig`**Description**: Config for text redaction.

        - `replace_with_info_type_config`**Type**: `STRUCT`**Provider name**: `replaceWithInfoTypeConfig`**Description**: Config for replace with InfoType.
    - `use_regional_data_processing`**Type**: `BOOLEAN`**Provider name**: `useRegionalDataProcessing`**Description**: Optional. Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
  - `store`**Type**: `STRING`**Provider name**: `store`**Description**: Optional. 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}`.
- `resource_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `resourceTypes`**Description**: Optional. Supply a FHIR resource type (such as "Patient" or "Observation"). See [https://www.hl7.org/fhir/valueset-resource-types.html](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.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `validation_config`{% #validation_config %}

**Type**: `STRUCT`**Provider name**: `validationConfig`**Description**: Optional. Configuration for how to validate incoming FHIR resources against configured profiles.

- `disable_fhirpath_validation`**Type**: `BOOLEAN`**Provider name**: `disableFhirpathValidation`**Description**: Optional. Whether to disable FHIRPath validation for incoming resources. The default value is false. 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.
- `disable_profile_validation`**Type**: `BOOLEAN`**Provider name**: `disableProfileValidation`**Description**: Optional. Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.
- `disable_reference_type_validation`**Type**: `BOOLEAN`**Provider name**: `disableReferenceTypeValidation`**Description**: Optional. Whether to disable reference type validation for incoming resources. The default value is false. 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_required_field_validation`**Type**: `BOOLEAN`**Provider name**: `disableRequiredFieldValidation`**Description**: Optional. Whether to disable required fields validation for incoming resources. The default value is false. 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.
- `enabled_implementation_guides`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `enabledImplementationGuides`**Description**: Optional. 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 `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.

## `version`{% #version %}

**Type**: `STRING`**Provider name**: `version`**Description**: 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.**Possible values**:

- `VERSION_UNSPECIFIED` - Users must specify a version on store creation or an error is returned.
- `DSTU2` - Draft Standard for Trial Use, [Release 2](https://www.hl7.org/fhir/DSTU2)
- `STU3` - Standard for Trial Use, [Release 3](https://www.hl7.org/fhir/STU3)
- `R4` - [Release 4](https://www.hl7.org/fhir/R4)
- `R5` - [Release 5](https://www.hl7.org/fhir/R5)

## `zone_id`{% #zone_id %}

**Type**: `STRING`