Package com.hashicorp.cdktf.providers.google.healthcare_fhir_store

Interface HealthcareFhirStoreConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    HealthcareFhirStoreConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.519Z")
@Stability(Stable)
public interface HealthcareFhirStoreConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getDataset

        @Stability(Stable)
@NotNull
String getDataset()
        Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#dataset HealthcareFhirStore#dataset}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        The resource name for the FhirStore.

        ** Changing this property may recreate the FHIR store (removing all data) ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#name HealthcareFhirStore#name}

      • getVersion

        @Stability(Stable)
@NotNull
String getVersion()
        The FHIR specification version. Possible values: ["DSTU2", "STU3", "R4"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#version HealthcareFhirStore#version}

      • getComplexDataTypeReferenceParsing

        @Stability(Stable)
@Nullable
default String getComplexDataTypeReferenceParsing()
        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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. Possible values: ["COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED", "DISABLED", "ENABLED"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#complex_data_type_reference_parsing HealthcareFhirStore#complex_data_type_reference_parsing}

      • getDefaultSearchHandlingStrict

        @Stability(Stable)
@Nullable
default Object getDefaultSearchHandlingStrict()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#default_search_handling_strict HealthcareFhirStore#default_search_handling_strict}

      • getDisableReferentialIntegrity

        @Stability(Stable)
@Nullable
default Object getDisableReferentialIntegrity()
        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) ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#disable_referential_integrity HealthcareFhirStore#disable_referential_integrity}

      • getDisableResourceVersioning

        @Stability(Stable)
@Nullable
default Object getDisableResourceVersioning()
        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) ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#disable_resource_versioning HealthcareFhirStore#disable_resource_versioning}

      • getEnableHistoryImport

        @Stability(Stable)
@Nullable
default Object getEnableHistoryImport()
        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 ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#enable_history_import HealthcareFhirStore#enable_history_import}

      • getEnableUpdateCreate

        @Stability(Stable)
@Nullable
default Object getEnableUpdateCreate()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#enable_update_create HealthcareFhirStore#enable_update_create}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#id HealthcareFhirStore#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        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" }. **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#labels HealthcareFhirStore#labels}

      • getNotificationConfig

        @Stability(Stable)
@Nullable
default HealthcareFhirStoreNotificationConfig getNotificationConfig()
        notification_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#notification_config HealthcareFhirStore#notification_config}

      • getNotificationConfigs

        @Stability(Stable)
@Nullable
default Object getNotificationConfigs()
        notification_configs block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#notification_configs HealthcareFhirStore#notification_configs}

      • getStreamConfigs

        @Stability(Stable)
@Nullable
default Object getStreamConfigs()
        stream_configs block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#stream_configs HealthcareFhirStore#stream_configs}

      • getTimeouts

        @Stability(Stable)
@Nullable
default HealthcareFhirStoreTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#timeouts HealthcareFhirStore#timeouts}