Class: Google::Apis::HealthcareV1::FhirStore
- Inherits:
-
Object
- Object
- Google::Apis::HealthcareV1::FhirStore
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/healthcare_v1/classes.rb,
lib/google/apis/healthcare_v1/representations.rb,
lib/google/apis/healthcare_v1/representations.rb
Overview
Represents a FHIR store.
Instance Attribute Summary collapse
-
#complex_data_type_reference_parsing ⇒ String
Enable parsing of references within complex FHIR data types such as Extensions.
-
#default_search_handling_strict ⇒ Boolean
(also: #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. -
#disable_referential_integrity ⇒ Boolean
(also: #disable_referential_integrity?)
Immutable.
-
#disable_resource_versioning ⇒ Boolean
(also: #disable_resource_versioning?)
Immutable.
-
#enable_update_create ⇒ Boolean
(also: #enable_update_create?)
Whether this FHIR store has the updateCreate capability.
-
#labels ⇒ Hash<String,String>
User-supplied key-value pairs used to organize FHIR stores.
-
#name ⇒ String
Output only.
-
#notification_config ⇒ Google::Apis::HealthcareV1::NotificationConfig
Specifies where to send notifications upon changes to a data store.
-
#notification_configs ⇒ Array<Google::Apis::HealthcareV1::FhirNotificationConfig>
Specifies where and whether to send notifications upon changes to a FHIR store.
-
#stream_configs ⇒ Array<Google::Apis::HealthcareV1::StreamConfig>
A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store.
-
#validation_config ⇒ Google::Apis::HealthcareV1::ValidationConfig
Contains the configuration for FHIR profiles and validation.
-
#version ⇒ String
Immutable.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FhirStore
constructor
A new instance of FhirStore.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ FhirStore
Returns a new instance of FhirStore.
2027 2028 2029 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2027 def initialize(**args) update!(**args) end |
Instance Attribute Details
#complex_data_type_reference_parsing ⇒ String
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.
Corresponds to the JSON property complexDataTypeReferenceParsing
1920 1921 1922 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1920 def complex_data_type_reference_parsing @complex_data_type_reference_parsing end |
#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
1930 1931 1932 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1930 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
1942 1943 1944 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1942 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
1954 1955 1956 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1954 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
1969 1970 1971 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1969 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
\pLo
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: [\pLl
\pLo
\pN
_-]0,63
No more than 64 labels can be
associated with a given store.
Corresponds to the JSON property labels
1981 1982 1983 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1981 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 property
name`
1987 1988 1989 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1987 def name @name end |
#notification_config ⇒ Google::Apis::HealthcareV1::NotificationConfig
Specifies where to send notifications upon changes to a data store.
Corresponds to the JSON property notificationConfig
1992 1993 1994 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1992 def notification_config @notification_config end |
#notification_configs ⇒ Array<Google::Apis::HealthcareV1::FhirNotificationConfig>
Specifies where and whether to send notifications upon changes to a FHIR store.
Corresponds to the JSON property notificationConfigs
1997 1998 1999 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1997 def notification_configs @notification_configs end |
#stream_configs ⇒ Array<Google::Apis::HealthcareV1::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
2012 2013 2014 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2012 def stream_configs @stream_configs end |
#validation_config ⇒ Google::Apis::HealthcareV1::ValidationConfig
Contains the configuration for FHIR profiles and validation.
Corresponds to the JSON property validationConfig
2017 2018 2019 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2017 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
2025 2026 2027 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2025 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2032 def update!(**args) @complex_data_type_reference_parsing = args[:complex_data_type_reference_parsing] if args.key?(:complex_data_type_reference_parsing) @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) @notification_configs = args[:notification_configs] if args.key?(:notification_configs) @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 |