Class: Google::Apis::HealthcareV1alpha2::FhirStore

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/healthcare_v1alpha2/classes.rb,
generated/google/apis/healthcare_v1alpha2/representations.rb,
generated/google/apis/healthcare_v1alpha2/representations.rb

Overview

Represents a FHIR store.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FhirStore

Returns a new instance of FhirStore



964
965
966
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 964

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disable_referential_integrity ⇒ Boolean Also known as: disable_referential_integrity?

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 GetPatientEverything, will not return all the results if broken references exist. Corresponds to the JSON property disableReferentialIntegrity

Returns:

  • (Boolean) 


871
872
873
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 871

def disable_referential_integrity
  @disable_referential_integrity
end

#disable_resource_versioning ⇒ Boolean Also known as: disable_resource_versioning?

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. Corresponds to the JSON property disableResourceVersioning

Returns:

  • (Boolean) 


883
884
885
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 883

def disable_resource_versioning
  @disable_resource_versioning
end

#enable_history_import ⇒ Boolean Also known as: enable_history_import?

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. Corresponds to the JSON property enableHistoryImport

Returns:

  • (Boolean) 


893
894
895
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 893

def enable_history_import
  @enable_history_import
end

#enable_update_create ⇒ Boolean Also known as: enable_update_create?

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. Corresponds to the JSON property enableUpdateCreate

Returns:

  • (Boolean) 


908
909
910
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 908

def enable_update_create
  @enable_update_create
end

#labels ⇒ Hash<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: \pLl\pLo0,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: [\pLl\pLo\pN_-]0,63 No more than 64 labels can be associated with a given store. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


922
923
924
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 922

def labels
  @labels
end

#name ⇒ String

Output only. Resource name of the FHIR store, of the form projects/project_id/datasets/dataset_id/fhirStores/fhir_store_id`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


928
929
930
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 928

def name
  @name
end

#notification_config ⇒ Google::Apis::HealthcareV1alpha2::NotificationConfig

Specifies where notifications should be sent upon changes to a data store. Corresponds to the JSON property notificationConfig

Returns:



933
934
935
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 933

def notification_config
  @notification_config
end

#stream_configs ⇒ Array<Google::Apis::HealthcareV1alpha2::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 will be streamed to the new location in addition to the existing ones. When a location is removed from the list, the server will simply stop 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. Corresponds to the JSON property streamConfigs

Returns:



951
952
953
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 951

def stream_configs
  @stream_configs
end

#subscription_config ⇒ Google::Apis::HealthcareV1alpha2::SubscriptionConfig

Configuration of FHIR Subscription: https://www.hl7.org/fhir/subscription.html. Corresponds to the JSON property subscriptionConfig

Returns:



957
958
959
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 957

def subscription_config
  @subscription_config
end

#validation_config ⇒ Google::Apis::HealthcareV1alpha2::ValidationConfig

This structure contains the configuration for FHIR profiles and validation. Corresponds to the JSON property validationConfig

Returns:



962
963
964
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 962

def validation_config
  @validation_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'generated/google/apis/healthcare_v1alpha2/classes.rb', line 969

def update!(**args)
  @disable_referential_integrity = args[:disable_referential_integrity] if args.key?(:disable_referential_integrity)
  @disable_resource_versioning = args[:disable_resource_versioning] if args.key?(:disable_resource_versioning)
  @enable_history_import = args[:enable_history_import] if args.key?(:enable_history_import)
  @enable_update_create = args[:enable_update_create] if args.key?(:enable_update_create)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @notification_config = args[:notification_config] if args.key?(:notification_config)
  @stream_configs = args[:stream_configs] if args.key?(:stream_configs)
  @subscription_config = args[:subscription_config] if args.key?(:subscription_config)
  @validation_config = args[:validation_config] if args.key?(:validation_config)
end