FhirStore (Cloud Healthcare API v1beta1-rev20251022-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.healthcare.v1beta1.model.FhirStore

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class FhirStore
extends com.google.api.client.json.GenericJson
```
Represents a FHIR store.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

FhirStore()

Constructors
Constructor and Description
`FhirStore()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FhirStore`	`clone()`
`BulkExportGcsDestination`	`getBulkExportGcsDestination()` Optional.
`String`	`getComplexDataTypeReferenceParsing()` Enable parsing of references within complex FHIR data types such as Extensions.
`ConsentConfig`	`getConsentConfig()` Optional.
`Boolean`	`getDefaultSearchHandlingStrict()` If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters.
`Boolean`	`getDisableReferentialIntegrity()` Immutable.
`Boolean`	`getDisableResourceVersioning()` Immutable.
`Boolean`	`getEnableHistoryModifications()` Optional.
`Boolean`	`getEnableUpdateCreate()` Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement- definitions.html#CapabilityStatement.rest.resource.updateCreate).
`Map<String,String>`	`getLabels()` User-supplied key-value pairs used to organize FHIR stores.
`String`	`getName()` Output only.
`NotificationConfig`	`getNotificationConfig()` Deprecated.
`List<FhirNotificationConfig>`	`getNotificationConfigs()` Specifies where and whether to send notifications upon changes to a Fhir store.
`SearchConfig`	`getSearchConfig()` Configuration for how FHIR resources can be searched.
`List<StreamConfig>`	`getStreamConfigs()` A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store.
`ValidationConfig`	`getValidationConfig()` Configuration for how to validate incoming FHIR resources against configured profiles.
`String`	`getVersion()` Required.
`FhirStore`	`set(String fieldName, Object value)`
`FhirStore`	`setBulkExportGcsDestination(BulkExportGcsDestination bulkExportGcsDestination)` Optional.
`FhirStore`	`setComplexDataTypeReferenceParsing(String complexDataTypeReferenceParsing)` Enable parsing of references within complex FHIR data types such as Extensions.
`FhirStore`	`setConsentConfig(ConsentConfig consentConfig)` Optional.
`FhirStore`	`setDefaultSearchHandlingStrict(Boolean defaultSearchHandlingStrict)` If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters.
`FhirStore`	`setDisableReferentialIntegrity(Boolean disableReferentialIntegrity)` Immutable.
`FhirStore`	`setDisableResourceVersioning(Boolean disableResourceVersioning)` Immutable.
`FhirStore`	`setEnableHistoryModifications(Boolean enableHistoryModifications)` Optional.
`FhirStore`	`setEnableUpdateCreate(Boolean enableUpdateCreate)` Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement- definitions.html#CapabilityStatement.rest.resource.updateCreate).
`FhirStore`	`setLabels(Map<String,String> labels)` User-supplied key-value pairs used to organize FHIR stores.
`FhirStore`	`setName(String name)` Output only.
`FhirStore`	`setNotificationConfig(NotificationConfig notificationConfig)` Deprecated.
`FhirStore`	`setNotificationConfigs(List<FhirNotificationConfig> notificationConfigs)` Specifies where and whether to send notifications upon changes to a Fhir store.
`FhirStore`	`setSearchConfig(SearchConfig searchConfig)` Configuration for how FHIR resources can be searched.
`FhirStore`	`setStreamConfigs(List<StreamConfig> streamConfigs)` A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store.
`FhirStore`	`setValidationConfig(ValidationConfig validationConfig)` Configuration for how to validate incoming FHIR resources against configured profiles.
`FhirStore`	`setVersion(String version)` Required.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - FhirStore
```
public FhirStore()
```
- Method Detail
  - getBulkExportGcsDestination
```
public BulkExportGcsDestination getBulkExportGcsDestination()
```
    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.
    
    Returns:
    
    value or null for none
  - setBulkExportGcsDestination
```
public FhirStore setBulkExportGcsDestination(BulkExportGcsDestination bulkExportGcsDestination)
```
    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.
    
    Parameters:
    
    bulkExportGcsDestination - bulkExportGcsDestination or null for none
  - getComplexDataTypeReferenceParsing
```
public 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 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.
    
    Returns:
    
    value or null for none
  - setComplexDataTypeReferenceParsing
```
public FhirStore setComplexDataTypeReferenceParsing(String 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. Cannot be disabled in R5.
    
    Parameters:
    
    complexDataTypeReferenceParsing - complexDataTypeReferenceParsing or null for none
  - getConsentConfig
```
public ConsentConfig getConsentConfig()
```
    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.
    
    Returns:
    
    value or null for none
  - setConsentConfig
```
public FhirStore setConsentConfig(ConsentConfig consentConfig)
```
    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.
    
    Parameters:
    
    consentConfig - consentConfig or null for none
  - getDefaultSearchHandlingStrict
```
public Boolean 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`. Defaults to false.
    
    Returns:
    
    value or null for none
  - setDefaultSearchHandlingStrict
```
public FhirStore setDefaultSearchHandlingStrict(Boolean defaultSearchHandlingStrict)
```
    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.
    
    Parameters:
    
    defaultSearchHandlingStrict - defaultSearchHandlingStrict or null for none
  - getDisableReferentialIntegrity
```
public Boolean getDisableReferentialIntegrity()
```
    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.
    
    Returns:
    
    value or null for none
  - setDisableReferentialIntegrity
```
public FhirStore setDisableReferentialIntegrity(Boolean disableReferentialIntegrity)
```
    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.
    
    Parameters:
    
    disableReferentialIntegrity - disableReferentialIntegrity or null for none
  - getDisableResourceVersioning
```
public Boolean getDisableResourceVersioning()
```
    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.
    
    Returns:
    
    value or null for none
  - setDisableResourceVersioning
```
public FhirStore setDisableResourceVersioning(Boolean disableResourceVersioning)
```
    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.
    
    Parameters:
    
    disableResourceVersioning - disableResourceVersioning or null for none
  - getEnableHistoryModifications
```
public Boolean getEnableHistoryModifications()
```
    Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors.
    
    Returns:
    
    value or null for none
  - setEnableHistoryModifications
```
public FhirStore setEnableHistoryModifications(Boolean enableHistoryModifications)
```
    Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors.
    
    Parameters:
    
    enableHistoryModifications - enableHistoryModifications or null for none
  - getEnableUpdateCreate
```
public Boolean getEnableUpdateCreate()
```
    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.
    
    Returns:
    
    value or null for none
  - setEnableUpdateCreate
```
public FhirStore setEnableUpdateCreate(Boolean enableUpdateCreate)
```
    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.
    
    Parameters:
    
    enableUpdateCreate - enableUpdateCreate or null for none
  - getLabels
```
public 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}{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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public FhirStore setLabels(Map<String,String> labels)
```
    User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{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.
    
    Parameters:
    
    labels - labels or null for none
  - getName
```
public String getName()
```
    Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.
    
    Returns:
    
    value or null for none
  - setName
```
public FhirStore setName(String name)
```
    Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.
    
    Parameters:
    
    name - name or null for none
  - getNotificationConfig
```
public NotificationConfig getNotificationConfig()
```
    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.
    
    Returns:
    
    value or null for none
  - setNotificationConfig
```
public FhirStore setNotificationConfig(NotificationConfig 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". Not supported in R5. Use `notification_configs` instead.
    
    Parameters:
    
    notificationConfig - notificationConfig or null for none
  - getNotificationConfigs
```
public List<FhirNotificationConfig> getNotificationConfigs()
```
    Specifies where and whether to send notifications upon changes to a Fhir store.
    
    Returns:
    
    value or null for none
  - setNotificationConfigs
```
public FhirStore setNotificationConfigs(List<FhirNotificationConfig> notificationConfigs)
```
    Specifies where and whether to send notifications upon changes to a Fhir store.
    
    Parameters:
    
    notificationConfigs - notificationConfigs or null for none
  - getSearchConfig
```
public SearchConfig getSearchConfig()
```
    Configuration for how FHIR resources can be searched.
    
    Returns:
    
    value or null for none
  - setSearchConfig
```
public FhirStore setSearchConfig(SearchConfig searchConfig)
```
    Configuration for how FHIR resources can be searched.
    
    Parameters:
    
    searchConfig - searchConfig or null for none
  - getStreamConfigs
```
public List<StreamConfig> getStreamConfigs()
```
    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.
    
    Returns:
    
    value or null for none
  - setStreamConfigs
```
public FhirStore setStreamConfigs(List<StreamConfig> streamConfigs)
```
    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.
    
    Parameters:
    
    streamConfigs - streamConfigs or null for none
  - getValidationConfig
```
public ValidationConfig getValidationConfig()
```
    Configuration for how to validate incoming FHIR resources against configured profiles.
    
    Returns:
    
    value or null for none
  - setValidationConfig
```
public FhirStore setValidationConfig(ValidationConfig validationConfig)
```
    Configuration for how to validate incoming FHIR resources against configured profiles.
    
    Parameters:
    
    validationConfig - validationConfig or null for none
  - getVersion
```
public String getVersion()
```
    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.
    
    Returns:
    
    value or null for none
  - setVersion
```
public FhirStore setVersion(String 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.
    
    Parameters:
    
    version - version or null for none
  - set
```
public FhirStore set(String fieldName,
                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public FhirStore clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class FhirStore

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

FhirStore

Method Detail

getBulkExportGcsDestination

setBulkExportGcsDestination

getComplexDataTypeReferenceParsing

setComplexDataTypeReferenceParsing

getConsentConfig

setConsentConfig

getDefaultSearchHandlingStrict

setDefaultSearchHandlingStrict

getDisableReferentialIntegrity

setDisableReferentialIntegrity

getDisableResourceVersioning

setDisableResourceVersioning

getEnableHistoryModifications

setEnableHistoryModifications

getEnableUpdateCreate

setEnableUpdateCreate

getLabels

setLabels

getName

setName

getNotificationConfig

setNotificationConfig

getNotificationConfigs

setNotificationConfigs

getSearchConfig

setSearchConfig

getStreamConfigs

setStreamConfigs

getValidationConfig

setValidationConfig

getVersion

setVersion

set

clone