Class: Google::Apis::HealthcareV1beta1::FhirStore

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/healthcare_v1beta1/classes.rb,
generated/google/apis/healthcare_v1beta1/representations.rb,
generated/google/apis/healthcare_v1beta1/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



785
786
787
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 785

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) 


721
722
723
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 721

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) 


733
734
735
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 733

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) 


743
744
745
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 743

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) 


758
759
760
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 758

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>) 


772
773
774
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 772

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) 


778
779
780
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 778

def name
  @name
end

#notification_config ⇒ Google::Apis::HealthcareV1beta1::NotificationConfig

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

Returns:



783
784
785
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 783

def notification_config
  @notification_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



790
791
792
793
794
795
796
797
798
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 790

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)
end