google-apis-healthcare_v1beta1 0.54.0 → 0.55.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 99cf872a52524ebf4a9e6bffbf2495cb6383610ab85bf1494e75f2bdd02a6124
4
- data.tar.gz: 0114dbd1d2eb8afd3eb0b4167e06ff710f1e0f0994ca56b9b5296b159f0fd871
3
+ metadata.gz: d9317c5ef07706d461d6b2100223e00376363339432ef014067d702d1a47b0ed
4
+ data.tar.gz: 9e7e6143d010d392ad8de3c5729c65dd619883f7b78dbd412ff0bcc97d282c16
5
5
  SHA512:
6
- metadata.gz: d0f64926ef1c21e6a077126ccef235aa205c98e70d6935bb7db774a35147f1acd6e3bfc3c216d7ec262e0b4a4c55c9ac7921083df729eb1ae6da09926fa8451f
7
- data.tar.gz: c8a360cb830a01dac3bf9d0a7e5ef5b4f81f0ec84374bf2002ef08b714486db25e765c89c1a35f9b6bddb917a9ce2904cbf0465cc47a7937d91ef0b2dee6a9d6
6
+ metadata.gz: e3b40e7ca3d7645a1411c3d04bc04e75de9fce7663f04c458f3d105192db98d56d5ecaa08f1299607833883b8a7d6da29eef2bf4dcc01a0837c1236d6c76b623
7
+ data.tar.gz: fd526f1fa522ef7fd21bebd0df13dd4a030cc893be8ddbbd7e608d557aa3a9ef3294ce76fbe0ab210f0eac4aaf154ba6a8a20935258cd92fdddcb9d45d6f1640
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-healthcare_v1beta1
2
2
 
3
+ ### v0.55.0 (2023-09-24)
4
+
5
+ * Regenerated from discovery document revision 20230912
6
+
3
7
  ### v0.54.0 (2023-09-03)
4
8
 
5
9
  * Regenerated from discovery document revision 20230817
@@ -22,6 +22,29 @@ module Google
22
22
  module Apis
23
23
  module HealthcareV1beta1
24
24
 
25
+ # Configures consent audit log config for FHIR create, read, update, and delete (
26
+ # CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://
27
+ # cloud.google.com/logging/docs/audit/configure-data-access#config-console-
28
+ # enable). The consent-related logs are included as part of `protoPayload.
29
+ # metadata`.
30
+ class AccessDeterminationLogConfig
31
+ include Google::Apis::Core::Hashable
32
+
33
+ # Optional. Controls the amount of detail to include as part of the audit logs.
34
+ # Corresponds to the JSON property `logLevel`
35
+ # @return [String]
36
+ attr_accessor :log_level
37
+
38
+ def initialize(**args)
39
+ update!(**args)
40
+ end
41
+
42
+ # Update properties of this object
43
+ def update!(**args)
44
+ @log_level = args[:log_level] if args.key?(:log_level)
45
+ end
46
+ end
47
+
25
48
  # Specifies a selection of tags and an `Action` to apply to each one.
26
49
  class Action
27
50
  include Google::Apis::Core::Hashable
@@ -136,6 +159,30 @@ module Google
136
159
  end
137
160
  end
138
161
 
162
+ # List of admin Consent resources to be applied.
163
+ class AdminConsents
164
+ include Google::Apis::Core::Hashable
165
+
166
+ # The versioned names of the admin Consent resource(s), in the format `projects/`
167
+ # project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
168
+ # fhir_store_id`/fhir/Consent/`resource_id`/_history/`version_id``. For FHIR
169
+ # stores with `disable_resource_versioning=true`, the format is `projects/`
170
+ # project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
171
+ # fhir_store_id`/fhir/Consent/`resource_id``.
172
+ # Corresponds to the JSON property `names`
173
+ # @return [Array<String>]
174
+ attr_accessor :names
175
+
176
+ def initialize(**args)
177
+ update!(**args)
178
+ end
179
+
180
+ # Update properties of this object
181
+ def update!(**args)
182
+ @names = args[:names] if args.key?(:names)
183
+ end
184
+ end
185
+
139
186
  # The request to analyze healthcare entities in a document.
140
187
  class AnalyzeEntitiesRequest
141
188
  include Google::Apis::Core::Hashable
@@ -348,6 +395,165 @@ module Google
348
395
  end
349
396
  end
350
397
 
398
+ # Request to apply the admin Consent resources for the specified FHIR store.
399
+ class ApplyAdminConsentsRequest
400
+ include Google::Apis::Core::Hashable
401
+
402
+ # List of admin Consent resources to be applied.
403
+ # Corresponds to the JSON property `newConsentsList`
404
+ # @return [Google::Apis::HealthcareV1beta1::AdminConsents]
405
+ attr_accessor :new_consents_list
406
+
407
+ # If true, the method only validates Consent resources to make sure they are
408
+ # supported. Otherwise, the method applies the aggregate consent information to
409
+ # update the enforcement model and reindex the FHIR resources. If all Consent
410
+ # resources can be applied successfully, the ApplyAdminConsentsResponse is
411
+ # returned containing the following fields: * `consent_apply_success` to
412
+ # indicate the number of Consent resources applied. * `affected_resources` to
413
+ # indicate the number of resources that might have had their consent access
414
+ # changed. If, however, one or more Consent resources are unsupported or cannot
415
+ # be applied, the method fails and ApplyAdminConsentsErrorDetail is is returned
416
+ # with details about the unsupported Consent resources.
417
+ # Corresponds to the JSON property `validateOnly`
418
+ # @return [Boolean]
419
+ attr_accessor :validate_only
420
+ alias_method :validate_only?, :validate_only
421
+
422
+ def initialize(**args)
423
+ update!(**args)
424
+ end
425
+
426
+ # Update properties of this object
427
+ def update!(**args)
428
+ @new_consents_list = args[:new_consents_list] if args.key?(:new_consents_list)
429
+ @validate_only = args[:validate_only] if args.key?(:validate_only)
430
+ end
431
+ end
432
+
433
+ # Response when all admin Consent resources in scope were processed and all
434
+ # affected resources were reindexed successfully. This structure will be
435
+ # included in the response when the operation finishes successfully.
436
+ class ApplyAdminConsentsResponse
437
+ include Google::Apis::Core::Hashable
438
+
439
+ # The number of resources (including the Consent resources) that may have
440
+ # consent access change.
441
+ # Corresponds to the JSON property `affectedResources`
442
+ # @return [Fixnum]
443
+ attr_accessor :affected_resources
444
+
445
+ # If `validate_only=false` in ApplyAdminConsentsRequest, this counter contains
446
+ # the number of Consent resources that were successfully applied. Otherwise, it
447
+ # is the number of Consent resources that are supported.
448
+ # Corresponds to the JSON property `consentApplySuccess`
449
+ # @return [Fixnum]
450
+ attr_accessor :consent_apply_success
451
+
452
+ # The number of resources (including the Consent resources) that
453
+ # ApplyAdminConsents failed to re-index.
454
+ # Corresponds to the JSON property `failedResources`
455
+ # @return [Fixnum]
456
+ attr_accessor :failed_resources
457
+
458
+ def initialize(**args)
459
+ update!(**args)
460
+ end
461
+
462
+ # Update properties of this object
463
+ def update!(**args)
464
+ @affected_resources = args[:affected_resources] if args.key?(:affected_resources)
465
+ @consent_apply_success = args[:consent_apply_success] if args.key?(:consent_apply_success)
466
+ @failed_resources = args[:failed_resources] if args.key?(:failed_resources)
467
+ end
468
+ end
469
+
470
+ # Request to apply the Consent resources for the specified FHIR store.
471
+ class ApplyConsentsRequest
472
+ include Google::Apis::Core::Hashable
473
+
474
+ # Apply consents given by a list of patients.
475
+ # Corresponds to the JSON property `patientScope`
476
+ # @return [Google::Apis::HealthcareV1beta1::PatientScope]
477
+ attr_accessor :patient_scope
478
+
479
+ # Apply consents given by patients whose most recent consent changes are in the
480
+ # time range. Note that after identifying these patients, the server applies all
481
+ # Consent resources given by those patients, not just the Consent resources
482
+ # within the timestamp in the range.
483
+ # Corresponds to the JSON property `timeRange`
484
+ # @return [Google::Apis::HealthcareV1beta1::TimeRange]
485
+ attr_accessor :time_range
486
+
487
+ # Optional. If true, the method only validates Consent resources to make sure
488
+ # they are supported. When the operation completes, ApplyConsentsResponse is
489
+ # returned where `consent_apply_success` and `consent_apply_failure` indicate
490
+ # supported and unsupported (or invalid) Consent resources, respectively.
491
+ # Otherwise, the method propagates the aggregate consensual information to the
492
+ # patient's resources. Upon success, `affected_resources` in the
493
+ # ApplyConsentsResponse indicates the number of resources that may have
494
+ # consensual access changed.
495
+ # Corresponds to the JSON property `validateOnly`
496
+ # @return [Boolean]
497
+ attr_accessor :validate_only
498
+ alias_method :validate_only?, :validate_only
499
+
500
+ def initialize(**args)
501
+ update!(**args)
502
+ end
503
+
504
+ # Update properties of this object
505
+ def update!(**args)
506
+ @patient_scope = args[:patient_scope] if args.key?(:patient_scope)
507
+ @time_range = args[:time_range] if args.key?(:time_range)
508
+ @validate_only = args[:validate_only] if args.key?(:validate_only)
509
+ end
510
+ end
511
+
512
+ # Response when all Consent resources in scope were processed and all affected
513
+ # resources were reindexed successfully. This structure is included in the
514
+ # response when the operation finishes successfully.
515
+ class ApplyConsentsResponse
516
+ include Google::Apis::Core::Hashable
517
+
518
+ # The number of resources (including the Consent resources) that may have
519
+ # consensual access change.
520
+ # Corresponds to the JSON property `affectedResources`
521
+ # @return [Fixnum]
522
+ attr_accessor :affected_resources
523
+
524
+ # If `validate_only = false` in ApplyConsentsRequest, this counter is the number
525
+ # of Consent resources that were failed to apply. Otherwise, it is the number of
526
+ # Consent resources that are not supported or invalid.
527
+ # Corresponds to the JSON property `consentApplyFailure`
528
+ # @return [Fixnum]
529
+ attr_accessor :consent_apply_failure
530
+
531
+ # If `validate_only = false` in ApplyConsentsRequest, this counter is the number
532
+ # of Consent resources that were successfully applied. Otherwise, it is the
533
+ # number of Consent resources that are supported.
534
+ # Corresponds to the JSON property `consentApplySuccess`
535
+ # @return [Fixnum]
536
+ attr_accessor :consent_apply_success
537
+
538
+ # The number of resources (including the Consent resources) that ApplyConsents
539
+ # failed to re-index.
540
+ # Corresponds to the JSON property `failedResources`
541
+ # @return [Fixnum]
542
+ attr_accessor :failed_resources
543
+
544
+ def initialize(**args)
545
+ update!(**args)
546
+ end
547
+
548
+ # Update properties of this object
549
+ def update!(**args)
550
+ @affected_resources = args[:affected_resources] if args.key?(:affected_resources)
551
+ @consent_apply_failure = args[:consent_apply_failure] if args.key?(:consent_apply_failure)
552
+ @consent_apply_success = args[:consent_apply_success] if args.key?(:consent_apply_success)
553
+ @failed_resources = args[:failed_resources] if args.key?(:failed_resources)
554
+ end
555
+ end
556
+
351
557
  # Archives the specified User data mapping.
352
558
  class ArchiveUserDataMappingRequest
353
559
  include Google::Apis::Core::Hashable
@@ -1022,6 +1228,66 @@ module Google
1022
1228
  end
1023
1229
  end
1024
1230
 
1231
+ # Configures whether to enforce consent for the FHIR store and which consent
1232
+ # enforcement version is being used.
1233
+ class ConsentConfig
1234
+ include Google::Apis::Core::Hashable
1235
+
1236
+ # Configures consent audit log config for FHIR create, read, update, and delete (
1237
+ # CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://
1238
+ # cloud.google.com/logging/docs/audit/configure-data-access#config-console-
1239
+ # enable). The consent-related logs are included as part of `protoPayload.
1240
+ # metadata`.
1241
+ # Corresponds to the JSON property `accessDeterminationLogConfig`
1242
+ # @return [Google::Apis::HealthcareV1beta1::AccessDeterminationLogConfig]
1243
+ attr_accessor :access_determination_log_config
1244
+
1245
+ # Optional. If set to true, when accessing FHIR resources, the consent headers
1246
+ # provided using [SMART-on-FHIR](https://cloud.google.com/healthcare/private/
1247
+ # docs/how-tos/smart-on-fhir) will be verified against consents given by
1248
+ # patients. See the ConsentEnforcementVersion for the supported consent headers.
1249
+ # Corresponds to the JSON property `accessEnforced`
1250
+ # @return [Boolean]
1251
+ attr_accessor :access_enforced
1252
+ alias_method :access_enforced?, :access_enforced
1253
+
1254
+ # How the server handles the consent header.
1255
+ # Corresponds to the JSON property `consentHeaderHandling`
1256
+ # @return [Google::Apis::HealthcareV1beta1::ConsentHeaderHandling]
1257
+ attr_accessor :consent_header_handling
1258
+
1259
+ # The versioned names of the enforced admin Consent resource(s), in the format `
1260
+ # projects/`project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
1261
+ # fhir_store_id`/fhir/Consent/`resource_id`/_history/`version_id``. For FHIR
1262
+ # stores with `disable_resource_versioning=true`, the format is `projects/`
1263
+ # project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
1264
+ # fhir_store_id`/fhir/Consent/`resource_id``. This field can only be updated
1265
+ # using ApplyAdminConsents.
1266
+ # Corresponds to the JSON property `enforcedAdminConsents`
1267
+ # @return [Array<String>]
1268
+ attr_accessor :enforced_admin_consents
1269
+
1270
+ # Required. Specifies which consent enforcement version is being used for this
1271
+ # FHIR store. This field can only be set once by either CreateFhirStore or
1272
+ # UpdateFhirStore. After that, you must call ApplyConsents to change the version.
1273
+ # Corresponds to the JSON property `version`
1274
+ # @return [String]
1275
+ attr_accessor :version
1276
+
1277
+ def initialize(**args)
1278
+ update!(**args)
1279
+ end
1280
+
1281
+ # Update properties of this object
1282
+ def update!(**args)
1283
+ @access_determination_log_config = args[:access_determination_log_config] if args.key?(:access_determination_log_config)
1284
+ @access_enforced = args[:access_enforced] if args.key?(:access_enforced)
1285
+ @consent_header_handling = args[:consent_header_handling] if args.key?(:consent_header_handling)
1286
+ @enforced_admin_consents = args[:enforced_admin_consents] if args.key?(:enforced_admin_consents)
1287
+ @version = args[:version] if args.key?(:version)
1288
+ end
1289
+ end
1290
+
1025
1291
  # The detailed evaluation of a particular Consent.
1026
1292
  class ConsentEvaluation
1027
1293
  include Google::Apis::Core::Hashable
@@ -1041,6 +1307,26 @@ module Google
1041
1307
  end
1042
1308
  end
1043
1309
 
1310
+ # How the server handles the consent header.
1311
+ class ConsentHeaderHandling
1312
+ include Google::Apis::Core::Hashable
1313
+
1314
+ # Optional. Specifies the default server behavior when the header is empty. If
1315
+ # not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used.
1316
+ # Corresponds to the JSON property `profile`
1317
+ # @return [String]
1318
+ attr_accessor :profile
1319
+
1320
+ def initialize(**args)
1321
+ update!(**args)
1322
+ end
1323
+
1324
+ # Update properties of this object
1325
+ def update!(**args)
1326
+ @profile = args[:profile] if args.key?(:profile)
1327
+ end
1328
+ end
1329
+
1044
1330
  # List of resource names of Consent resources.
1045
1331
  class ConsentList
1046
1332
  include Google::Apis::Core::Hashable
@@ -2580,6 +2866,12 @@ module Google
2580
2866
  # @return [String]
2581
2867
  attr_accessor :complex_data_type_reference_parsing
2582
2868
 
2869
+ # Configures whether to enforce consent for the FHIR store and which consent
2870
+ # enforcement version is being used.
2871
+ # Corresponds to the JSON property `consentConfig`
2872
+ # @return [Google::Apis::HealthcareV1beta1::ConsentConfig]
2873
+ attr_accessor :consent_config
2874
+
2583
2875
  # If true, overrides the default search behavior for this FHIR store to `
2584
2876
  # handling=strict` which returns an error for unrecognized search parameters. If
2585
2877
  # false, uses the FHIR specification default `handling=lenient` which ignores
@@ -2697,6 +2989,7 @@ module Google
2697
2989
  # Update properties of this object
2698
2990
  def update!(**args)
2699
2991
  @complex_data_type_reference_parsing = args[:complex_data_type_reference_parsing] if args.key?(:complex_data_type_reference_parsing)
2992
+ @consent_config = args[:consent_config] if args.key?(:consent_config)
2700
2993
  @default_search_handling_strict = args[:default_search_handling_strict] if args.key?(:default_search_handling_strict)
2701
2994
  @disable_referential_integrity = args[:disable_referential_integrity] if args.key?(:disable_referential_integrity)
2702
2995
  @disable_resource_versioning = args[:disable_resource_versioning] if args.key?(:disable_resource_versioning)
@@ -4957,14 +5250,17 @@ module Google
4957
5250
  # @return [String]
4958
5251
  attr_accessor :create_time
4959
5252
 
4960
- # The time at which execution was completed.
5253
+ # The time at which execution workloads were completed. Some tasks will complete
5254
+ # after this time such as logging audit logs.
4961
5255
  # Corresponds to the JSON property `endTime`
4962
5256
  # @return [String]
4963
5257
  attr_accessor :end_time
4964
5258
 
4965
5259
  # A link to audit and error logs in the log viewer. Error logs are generated
4966
5260
  # only by some operations, listed at [Viewing error logs in Cloud Logging](https:
4967
- # //cloud.google.com/healthcare/docs/how-tos/logging).
5261
+ # //cloud.google.com/healthcare/docs/how-tos/logging). The `end_time` specified
5262
+ # in this URL may not match the end time on the metadata because logs are
5263
+ # written asynchronously from execution.
4968
5264
  # Corresponds to the JSON property `logsUrl`
4969
5265
  # @return [String]
4970
5266
  attr_accessor :logs_url
@@ -5111,6 +5407,27 @@ module Google
5111
5407
  end
5112
5408
  end
5113
5409
 
5410
+ # Apply consents given by a list of patients.
5411
+ class PatientScope
5412
+ include Google::Apis::Core::Hashable
5413
+
5414
+ # Optional. The list of patient IDs whose Consent resources will be enforced. At
5415
+ # most 10,000 patients can be specified. An empty list is equivalent to all
5416
+ # patients (meaning the entire FHIR store).
5417
+ # Corresponds to the JSON property `patientIds`
5418
+ # @return [Array<String>]
5419
+ attr_accessor :patient_ids
5420
+
5421
+ def initialize(**args)
5422
+ update!(**args)
5423
+ end
5424
+
5425
+ # Update properties of this object
5426
+ def update!(**args)
5427
+ @patient_ids = args[:patient_ids] if args.key?(:patient_ids)
5428
+ end
5429
+ end
5430
+
5114
5431
  # An Identity and Access Management (IAM) policy, which specifies access
5115
5432
  # controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
5116
5433
  # A `binding` binds one or more `members`, or principals, to a single `role`.
@@ -5220,6 +5537,16 @@ module Google
5220
5537
  # @return [Fixnum]
5221
5538
  attr_accessor :pending
5222
5539
 
5540
+ # The number of secondary units that failed in the operation.
5541
+ # Corresponds to the JSON property `secondaryFailure`
5542
+ # @return [Fixnum]
5543
+ attr_accessor :secondary_failure
5544
+
5545
+ # The number of secondary units that succeeded in the operation.
5546
+ # Corresponds to the JSON property `secondarySuccess`
5547
+ # @return [Fixnum]
5548
+ attr_accessor :secondary_success
5549
+
5223
5550
  # The number of units that succeeded in the operation.
5224
5551
  # Corresponds to the JSON property `success`
5225
5552
  # @return [Fixnum]
@@ -5233,6 +5560,8 @@ module Google
5233
5560
  def update!(**args)
5234
5561
  @failure = args[:failure] if args.key?(:failure)
5235
5562
  @pending = args[:pending] if args.key?(:pending)
5563
+ @secondary_failure = args[:secondary_failure] if args.key?(:secondary_failure)
5564
+ @secondary_success = args[:secondary_success] if args.key?(:secondary_success)
5236
5565
  @success = args[:success] if args.key?(:success)
5237
5566
  end
5238
5567
  end
@@ -6184,6 +6513,36 @@ module Google
6184
6513
  end
6185
6514
  end
6186
6515
 
6516
+ # Apply consents given by patients whose most recent consent changes are in the
6517
+ # time range. Note that after identifying these patients, the server applies all
6518
+ # Consent resources given by those patients, not just the Consent resources
6519
+ # within the timestamp in the range.
6520
+ class TimeRange
6521
+ include Google::Apis::Core::Hashable
6522
+
6523
+ # Optional. The latest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+zz:
6524
+ # zz If not specified, the system uses the time when ApplyConsents was called.
6525
+ # Corresponds to the JSON property `end`
6526
+ # @return [String]
6527
+ attr_accessor :end
6528
+
6529
+ # Optional. The earliest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+
6530
+ # zz:zz If not specified, the system uses the FHIR store creation time.
6531
+ # Corresponds to the JSON property `start`
6532
+ # @return [String]
6533
+ attr_accessor :start
6534
+
6535
+ def initialize(**args)
6536
+ update!(**args)
6537
+ end
6538
+
6539
+ # Update properties of this object
6540
+ def update!(**args)
6541
+ @end = args[:end] if args.key?(:end)
6542
+ @start = args[:start] if args.key?(:start)
6543
+ end
6544
+ end
6545
+
6187
6546
  # A type definition for some HL7v2 type (incl. Segments and Datatypes).
6188
6547
  class Type
6189
6548
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module HealthcareV1beta1
18
18
  # Version of the google-apis-healthcare_v1beta1 gem
19
- GEM_VERSION = "0.54.0"
19
+ GEM_VERSION = "0.55.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230817"
25
+ REVISION = "20230912"
26
26
  end
27
27
  end
28
28
  end
@@ -22,6 +22,12 @@ module Google
22
22
  module Apis
23
23
  module HealthcareV1beta1
24
24
 
25
+ class AccessDeterminationLogConfig
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
25
31
  class Action
26
32
  class Representation < Google::Apis::Core::JsonRepresentation; end
27
33
 
@@ -34,6 +40,12 @@ module Google
34
40
  include Google::Apis::Core::JsonObjectSupport
35
41
  end
36
42
 
43
+ class AdminConsents
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
37
49
  class AnalyzeEntitiesRequest
38
50
  class Representation < Google::Apis::Core::JsonRepresentation; end
39
51
 
@@ -70,6 +82,30 @@ module Google
70
82
  include Google::Apis::Core::JsonObjectSupport
71
83
  end
72
84
 
85
+ class ApplyAdminConsentsRequest
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
91
+ class ApplyAdminConsentsResponse
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class ApplyConsentsRequest
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
103
+ class ApplyConsentsResponse
104
+ class Representation < Google::Apis::Core::JsonRepresentation; end
105
+
106
+ include Google::Apis::Core::JsonObjectSupport
107
+ end
108
+
73
109
  class ArchiveUserDataMappingRequest
74
110
  class Representation < Google::Apis::Core::JsonRepresentation; end
75
111
 
@@ -196,12 +232,24 @@ module Google
196
232
  include Google::Apis::Core::JsonObjectSupport
197
233
  end
198
234
 
235
+ class ConsentConfig
236
+ class Representation < Google::Apis::Core::JsonRepresentation; end
237
+
238
+ include Google::Apis::Core::JsonObjectSupport
239
+ end
240
+
199
241
  class ConsentEvaluation
200
242
  class Representation < Google::Apis::Core::JsonRepresentation; end
201
243
 
202
244
  include Google::Apis::Core::JsonObjectSupport
203
245
  end
204
246
 
247
+ class ConsentHeaderHandling
248
+ class Representation < Google::Apis::Core::JsonRepresentation; end
249
+
250
+ include Google::Apis::Core::JsonObjectSupport
251
+ end
252
+
205
253
  class ConsentList
206
254
  class Representation < Google::Apis::Core::JsonRepresentation; end
207
255
 
@@ -922,6 +970,12 @@ module Google
922
970
  include Google::Apis::Core::JsonObjectSupport
923
971
  end
924
972
 
973
+ class PatientScope
974
+ class Representation < Google::Apis::Core::JsonRepresentation; end
975
+
976
+ include Google::Apis::Core::JsonObjectSupport
977
+ end
978
+
925
979
  class Policy
926
980
  class Representation < Google::Apis::Core::JsonRepresentation; end
927
981
 
@@ -1144,6 +1198,12 @@ module Google
1144
1198
  include Google::Apis::Core::JsonObjectSupport
1145
1199
  end
1146
1200
 
1201
+ class TimeRange
1202
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1203
+
1204
+ include Google::Apis::Core::JsonObjectSupport
1205
+ end
1206
+
1147
1207
  class Type
1148
1208
  class Representation < Google::Apis::Core::JsonRepresentation; end
1149
1209
 
@@ -1174,6 +1234,13 @@ module Google
1174
1234
  include Google::Apis::Core::JsonObjectSupport
1175
1235
  end
1176
1236
 
1237
+ class AccessDeterminationLogConfig
1238
+ # @private
1239
+ class Representation < Google::Apis::Core::JsonRepresentation
1240
+ property :log_level, as: 'logLevel'
1241
+ end
1242
+ end
1243
+
1177
1244
  class Action
1178
1245
  # @private
1179
1246
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1206,6 +1273,13 @@ module Google
1206
1273
  end
1207
1274
  end
1208
1275
 
1276
+ class AdminConsents
1277
+ # @private
1278
+ class Representation < Google::Apis::Core::JsonRepresentation
1279
+ collection :names, as: 'names'
1280
+ end
1281
+ end
1282
+
1209
1283
  class AnalyzeEntitiesRequest
1210
1284
  # @private
1211
1285
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1268,6 +1342,45 @@ module Google
1268
1342
  end
1269
1343
  end
1270
1344
 
1345
+ class ApplyAdminConsentsRequest
1346
+ # @private
1347
+ class Representation < Google::Apis::Core::JsonRepresentation
1348
+ property :new_consents_list, as: 'newConsentsList', class: Google::Apis::HealthcareV1beta1::AdminConsents, decorator: Google::Apis::HealthcareV1beta1::AdminConsents::Representation
1349
+
1350
+ property :validate_only, as: 'validateOnly'
1351
+ end
1352
+ end
1353
+
1354
+ class ApplyAdminConsentsResponse
1355
+ # @private
1356
+ class Representation < Google::Apis::Core::JsonRepresentation
1357
+ property :affected_resources, :numeric_string => true, as: 'affectedResources'
1358
+ property :consent_apply_success, :numeric_string => true, as: 'consentApplySuccess'
1359
+ property :failed_resources, :numeric_string => true, as: 'failedResources'
1360
+ end
1361
+ end
1362
+
1363
+ class ApplyConsentsRequest
1364
+ # @private
1365
+ class Representation < Google::Apis::Core::JsonRepresentation
1366
+ property :patient_scope, as: 'patientScope', class: Google::Apis::HealthcareV1beta1::PatientScope, decorator: Google::Apis::HealthcareV1beta1::PatientScope::Representation
1367
+
1368
+ property :time_range, as: 'timeRange', class: Google::Apis::HealthcareV1beta1::TimeRange, decorator: Google::Apis::HealthcareV1beta1::TimeRange::Representation
1369
+
1370
+ property :validate_only, as: 'validateOnly'
1371
+ end
1372
+ end
1373
+
1374
+ class ApplyConsentsResponse
1375
+ # @private
1376
+ class Representation < Google::Apis::Core::JsonRepresentation
1377
+ property :affected_resources, :numeric_string => true, as: 'affectedResources'
1378
+ property :consent_apply_failure, :numeric_string => true, as: 'consentApplyFailure'
1379
+ property :consent_apply_success, :numeric_string => true, as: 'consentApplySuccess'
1380
+ property :failed_resources, :numeric_string => true, as: 'failedResources'
1381
+ end
1382
+ end
1383
+
1271
1384
  class ArchiveUserDataMappingRequest
1272
1385
  # @private
1273
1386
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1451,6 +1564,19 @@ module Google
1451
1564
  end
1452
1565
  end
1453
1566
 
1567
+ class ConsentConfig
1568
+ # @private
1569
+ class Representation < Google::Apis::Core::JsonRepresentation
1570
+ property :access_determination_log_config, as: 'accessDeterminationLogConfig', class: Google::Apis::HealthcareV1beta1::AccessDeterminationLogConfig, decorator: Google::Apis::HealthcareV1beta1::AccessDeterminationLogConfig::Representation
1571
+
1572
+ property :access_enforced, as: 'accessEnforced'
1573
+ property :consent_header_handling, as: 'consentHeaderHandling', class: Google::Apis::HealthcareV1beta1::ConsentHeaderHandling, decorator: Google::Apis::HealthcareV1beta1::ConsentHeaderHandling::Representation
1574
+
1575
+ collection :enforced_admin_consents, as: 'enforcedAdminConsents'
1576
+ property :version, as: 'version'
1577
+ end
1578
+ end
1579
+
1454
1580
  class ConsentEvaluation
1455
1581
  # @private
1456
1582
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1458,6 +1584,13 @@ module Google
1458
1584
  end
1459
1585
  end
1460
1586
 
1587
+ class ConsentHeaderHandling
1588
+ # @private
1589
+ class Representation < Google::Apis::Core::JsonRepresentation
1590
+ property :profile, as: 'profile'
1591
+ end
1592
+ end
1593
+
1461
1594
  class ConsentList
1462
1595
  # @private
1463
1596
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1882,6 +2015,8 @@ module Google
1882
2015
  # @private
1883
2016
  class Representation < Google::Apis::Core::JsonRepresentation
1884
2017
  property :complex_data_type_reference_parsing, as: 'complexDataTypeReferenceParsing'
2018
+ property :consent_config, as: 'consentConfig', class: Google::Apis::HealthcareV1beta1::ConsentConfig, decorator: Google::Apis::HealthcareV1beta1::ConsentConfig::Representation
2019
+
1885
2020
  property :default_search_handling_strict, as: 'defaultSearchHandlingStrict'
1886
2021
  property :disable_referential_integrity, as: 'disableReferentialIntegrity'
1887
2022
  property :disable_resource_versioning, as: 'disableResourceVersioning'
@@ -2582,6 +2717,13 @@ module Google
2582
2717
  end
2583
2718
  end
2584
2719
 
2720
+ class PatientScope
2721
+ # @private
2722
+ class Representation < Google::Apis::Core::JsonRepresentation
2723
+ collection :patient_ids, as: 'patientIds'
2724
+ end
2725
+ end
2726
+
2585
2727
  class Policy
2586
2728
  # @private
2587
2729
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2599,6 +2741,8 @@ module Google
2599
2741
  class Representation < Google::Apis::Core::JsonRepresentation
2600
2742
  property :failure, :numeric_string => true, as: 'failure'
2601
2743
  property :pending, :numeric_string => true, as: 'pending'
2744
+ property :secondary_failure, :numeric_string => true, as: 'secondaryFailure'
2745
+ property :secondary_success, :numeric_string => true, as: 'secondarySuccess'
2602
2746
  property :success, :numeric_string => true, as: 'success'
2603
2747
  end
2604
2748
  end
@@ -2888,6 +3032,14 @@ module Google
2888
3032
  end
2889
3033
  end
2890
3034
 
3035
+ class TimeRange
3036
+ # @private
3037
+ class Representation < Google::Apis::Core::JsonRepresentation
3038
+ property :end, as: 'end'
3039
+ property :start, as: 'start'
3040
+ end
3041
+ end
3042
+
2891
3043
  class Type
2892
3044
  # @private
2893
3045
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3877,6 +3877,100 @@ module Google
3877
3877
  execute_or_queue_command(command, &block)
3878
3878
  end
3879
3879
 
3880
+ # Applies the admin Consent resources for the FHIR store and reindexes the
3881
+ # underlying resources in the FHIR store according to the aggregate consents.
3882
+ # This method also updates the `consent_config.enforced_admin_consents` field of
3883
+ # the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any
3884
+ # admin Consent resource change after this operation execution (including
3885
+ # deletion) requires you to call ApplyAdminConsents again for the change to take
3886
+ # effect. This method returns an Operation that can be used to track the
3887
+ # progress of the resources that were reindexed, by calling GetOperation. Upon
3888
+ # completion, the ApplyAdminConsentsResponse additionally contains the number of
3889
+ # resources that were reindexed. If at least one Consent resource contains an
3890
+ # error or fails be be enforced for any reason, the method returns an error
3891
+ # instead of an Operation. No resources will be reindexed and the `
3892
+ # consent_config.enforced_admin_consents` field will be unchanged. To enforce a
3893
+ # consent check for data access, `consent_config.access_enforced` must be set to
3894
+ # true for the FhirStore.
3895
+ # @param [String] name
3896
+ # The name of the FHIR store to enforce, in the format `projects/`project_id`/
3897
+ # locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
3898
+ # @param [Google::Apis::HealthcareV1beta1::ApplyAdminConsentsRequest] apply_admin_consents_request_object
3899
+ # @param [String] fields
3900
+ # Selector specifying which fields to include in a partial response.
3901
+ # @param [String] quota_user
3902
+ # Available to use for quota purposes for server-side applications. Can be any
3903
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3904
+ # @param [Google::Apis::RequestOptions] options
3905
+ # Request-specific options
3906
+ #
3907
+ # @yield [result, err] Result & error if block supplied
3908
+ # @yieldparam result [Google::Apis::HealthcareV1beta1::Operation] parsed result object
3909
+ # @yieldparam err [StandardError] error object if request failed
3910
+ #
3911
+ # @return [Google::Apis::HealthcareV1beta1::Operation]
3912
+ #
3913
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3914
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3915
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3916
+ def apply_fhir_store_admin_consents(name, apply_admin_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3917
+ command = make_simple_command(:post, 'v1beta1/{+name}:applyAdminConsents', options)
3918
+ command.request_representation = Google::Apis::HealthcareV1beta1::ApplyAdminConsentsRequest::Representation
3919
+ command.request_object = apply_admin_consents_request_object
3920
+ command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
3921
+ command.response_class = Google::Apis::HealthcareV1beta1::Operation
3922
+ command.params['name'] = name unless name.nil?
3923
+ command.query['fields'] = fields unless fields.nil?
3924
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3925
+ execute_or_queue_command(command, &block)
3926
+ end
3927
+
3928
+ # Apply the Consent resources for the FHIR store and reindex the underlying
3929
+ # resources in the FHIR store according to the aggregate consent. The aggregate
3930
+ # consent of the patient in scope in this request replaces any previous call of
3931
+ # this method. Any Consent resource change after this operation execution (
3932
+ # including deletion) requires you to call ApplyConsents again to have effect.
3933
+ # This method returns an Operation that can be used to track the progress of the
3934
+ # consent resources that were processed by calling GetOperation. Upon completion,
3935
+ # the ApplyConsentsResponse additionally contains the number of resources that
3936
+ # was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in
3937
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To
3938
+ # enforce consent check for data access, `consent_config.access_enforced` must
3939
+ # be set to true for the FhirStore.
3940
+ # @param [String] name
3941
+ # Required. The name of the FHIR store to enforce, in the format `projects/`
3942
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
3943
+ # fhir_store_id``.
3944
+ # @param [Google::Apis::HealthcareV1beta1::ApplyConsentsRequest] apply_consents_request_object
3945
+ # @param [String] fields
3946
+ # Selector specifying which fields to include in a partial response.
3947
+ # @param [String] quota_user
3948
+ # Available to use for quota purposes for server-side applications. Can be any
3949
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3950
+ # @param [Google::Apis::RequestOptions] options
3951
+ # Request-specific options
3952
+ #
3953
+ # @yield [result, err] Result & error if block supplied
3954
+ # @yieldparam result [Google::Apis::HealthcareV1beta1::Operation] parsed result object
3955
+ # @yieldparam err [StandardError] error object if request failed
3956
+ #
3957
+ # @return [Google::Apis::HealthcareV1beta1::Operation]
3958
+ #
3959
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3960
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3961
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3962
+ def apply_fhir_store_consents(name, apply_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3963
+ command = make_simple_command(:post, 'v1beta1/{+name}:applyConsents', options)
3964
+ command.request_representation = Google::Apis::HealthcareV1beta1::ApplyConsentsRequest::Representation
3965
+ command.request_object = apply_consents_request_object
3966
+ command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
3967
+ command.response_class = Google::Apis::HealthcareV1beta1::Operation
3968
+ command.params['name'] = name unless name.nil?
3969
+ command.query['fields'] = fields unless fields.nil?
3970
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3971
+ execute_or_queue_command(command, &block)
3972
+ end
3973
+
3880
3974
  # Configure the search parameters for the FHIR store and reindex resources in
3881
3975
  # the FHIR store according to the defined search parameters. The search
3882
3976
  # parameters provided in this request will replace any previous search
@@ -4545,6 +4639,41 @@ module Google
4545
4639
  execute_or_queue_command(command, &block)
4546
4640
  end
4547
4641
 
4642
+ # Returns the consent enforcement status of a single consent resource. On
4643
+ # success, the response body contains a JSON-encoded representation of a `
4644
+ # Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, containing
4645
+ # the current enforcement status. Does not support DSTU2.
4646
+ # @param [String] name
4647
+ # Required. The name of the consent resource to find enforcement status, in the
4648
+ # format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
4649
+ # fhirStores/`fhir_store_id`/fhir/Consent/`consent_id``
4650
+ # @param [String] fields
4651
+ # Selector specifying which fields to include in a partial response.
4652
+ # @param [String] quota_user
4653
+ # Available to use for quota purposes for server-side applications. Can be any
4654
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4655
+ # @param [Google::Apis::RequestOptions] options
4656
+ # Request-specific options
4657
+ #
4658
+ # @yield [result, err] Result & error if block supplied
4659
+ # @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object
4660
+ # @yieldparam err [StandardError] error object if request failed
4661
+ #
4662
+ # @return [Google::Apis::HealthcareV1beta1::HttpBody]
4663
+ #
4664
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4665
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4666
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4667
+ def consent_project_location_dataset_fhir_store_fhir_enforcement_status(name, fields: nil, quota_user: nil, options: nil, &block)
4668
+ command = make_simple_command(:get, 'v1beta1/{+name}/$consent-enforcement-status', options)
4669
+ command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
4670
+ command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
4671
+ command.params['name'] = name unless name.nil?
4672
+ command.query['fields'] = fields unless fields.nil?
4673
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4674
+ execute_or_queue_command(command, &block)
4675
+ end
4676
+
4548
4677
  # Retrieves the N most recent `Observation` resources for a subject matching
4549
4678
  # search criteria specified as query parameters, grouped by `Observation.code`,
4550
4679
  # sorted from most recent to oldest. Implements the FHIR extended operation
@@ -4597,6 +4726,54 @@ module Google
4597
4726
  execute_or_queue_command(command, &block)
4598
4727
  end
4599
4728
 
4729
+ # Returns the consent enforcement status of all consent resources for a patient.
4730
+ # On success, the response body contains a JSON-encoded representation of a
4731
+ # bundle of `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resources,
4732
+ # containing the current enforcement status for each consent resource of the
4733
+ # patient. Does not support DSTU2.
4734
+ # @param [String] name
4735
+ # Required. The name of the patient to find enforcement statuses, in the format `
4736
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
4737
+ # `fhir_store_id`/fhir/Patient/`patient_id``
4738
+ # @param [Fixnum] _count
4739
+ # Optional. The maximum number of results on a page. If not specified, 100 is
4740
+ # used. May not be larger than 1000.
4741
+ # @param [String] _page_token
4742
+ # Optional. Used to retrieve the first, previous, next, or last page of consent
4743
+ # enforcement statuses when using pagination. Value should be set to the value
4744
+ # of `_page_token` set in next or previous page links' URLs. Next and previous
4745
+ # page are returned in the response bundle's links field, where `link.relation`
4746
+ # is "previous" or "next". Omit `_page_token` if no previous request has been
4747
+ # made.
4748
+ # @param [String] fields
4749
+ # Selector specifying which fields to include in a partial response.
4750
+ # @param [String] quota_user
4751
+ # Available to use for quota purposes for server-side applications. Can be any
4752
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4753
+ # @param [Google::Apis::RequestOptions] options
4754
+ # Request-specific options
4755
+ #
4756
+ # @yield [result, err] Result & error if block supplied
4757
+ # @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object
4758
+ # @yieldparam err [StandardError] error object if request failed
4759
+ #
4760
+ # @return [Google::Apis::HealthcareV1beta1::HttpBody]
4761
+ #
4762
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4763
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4764
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4765
+ def patient_project_location_dataset_fhir_store_fhir_consent_enforcement_status(name, _count: nil, _page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4766
+ command = make_simple_command(:get, 'v1beta1/{+name}/$consent-enforcement-status', options)
4767
+ command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
4768
+ command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
4769
+ command.params['name'] = name unless name.nil?
4770
+ command.query['_count'] = _count unless _count.nil?
4771
+ command.query['_page_token'] = _page_token unless _page_token.nil?
4772
+ command.query['fields'] = fields unless fields.nil?
4773
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4774
+ execute_or_queue_command(command, &block)
4775
+ end
4776
+
4600
4777
  # Retrieves a Patient resource and resources related to that patient. Implements
4601
4778
  # the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/
4602
4779
  # implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-healthcare_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.54.0
4
+ version: 0.55.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-03 00:00:00.000000000 Z
11
+ date: 2023-09-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1beta1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.54.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.55.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1beta1
63
63
  post_install_message:
64
64
  rdoc_options: []