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

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

Overview

Represents a FHIR store.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FhirStore

Returns a new instance of FhirStore.



2098
2099
2100
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2098

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

Instance Attribute Details

#default_search_handling_strict ⇒ Boolean Also known as: default_search_handling_strict?

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

Returns:

  • (Boolean) 


2001
2002
2003
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2001

def default_search_handling_strict
  @default_search_handling_strict
end

#disable_referential_integrity ⇒ Boolean Also known as: disable_referential_integrity?

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

Returns:

  • (Boolean) 


2013
2014
2015
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2013

def disable_referential_integrity
  @disable_referential_integrity
end

#disable_resource_versioning ⇒ Boolean Also known as: disable_resource_versioning?

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, which is the default behavior, 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. Corresponds to the JSON property disableResourceVersioning

Returns:

  • (Boolean) 


2025
2026
2027
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2025

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

Returns:

  • (Boolean) 


2040
2041
2042
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2040

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


2052
2053
2054
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2052

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) 


2058
2059
2060
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2058

def name
  @name
end

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

Specifies where to send notifications upon changes to a data store. Corresponds to the JSON property notificationConfig

Returns:



2063
2064
2065
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2063

def notification_config
  @notification_config
end

#search_config ⇒ Google::Apis::HealthcareV1beta1::SearchConfig

Contains the configuration for FHIR search. Corresponds to the JSON property searchConfig

Returns:



2068
2069
2070
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2068

def search_config
  @search_config
end

#stream_configs ⇒ Array<Google::Apis::HealthcareV1beta1::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 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 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:



2083
2084
2085
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2083

def stream_configs
  @stream_configs
end

#validation_config ⇒ Google::Apis::HealthcareV1beta1::ValidationConfig

Contains the configuration for FHIR profiles and validation. Corresponds to the JSON property validationConfig

Returns:



2088
2089
2090
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2088

def validation_config
  @validation_config
end

#version ⇒ String

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

Returns:

  • (String) 


2096
2097
2098
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2096

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2103

def update!(**args)
  @default_search_handling_strict = args[:default_search_handling_strict] if args.key?(:default_search_handling_strict)
  @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_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)
  @search_config = args[:search_config] if args.key?(:search_config)
  @stream_configs = args[:stream_configs] if args.key?(:stream_configs)
  @validation_config = args[:validation_config] if args.key?(:validation_config)
  @version = args[:version] if args.key?(:version)
end