google-apis-healthcare_v1beta1 0.1.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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.1.0"
19
+ GEM_VERSION = "0.6.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.1"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20201202"
25
+ REVISION = "20210317"
26
26
  end
27
27
  end
28
28
  end
@@ -100,6 +100,12 @@ module Google
100
100
  include Google::Apis::Core::JsonObjectSupport
101
101
  end
102
102
 
103
+ class BatchGetMessagesResponse
104
+ class Representation < Google::Apis::Core::JsonRepresentation; end
105
+
106
+ include Google::Apis::Core::JsonObjectSupport
107
+ end
108
+
103
109
  class Binding
104
110
  class Representation < Google::Apis::Core::JsonRepresentation; end
105
111
 
@@ -496,30 +502,6 @@ module Google
496
502
  include Google::Apis::Core::JsonObjectSupport
497
503
  end
498
504
 
499
- class GoogleCloudHealthcareV1beta1FhirRestExportResourcesErrorDetails
500
- class Representation < Google::Apis::Core::JsonRepresentation; end
501
-
502
- include Google::Apis::Core::JsonObjectSupport
503
- end
504
-
505
- class GoogleCloudHealthcareV1beta1FhirRestExportResourcesResponse
506
- class Representation < Google::Apis::Core::JsonRepresentation; end
507
-
508
- include Google::Apis::Core::JsonObjectSupport
509
- end
510
-
511
- class GoogleCloudHealthcareV1beta1FhirRestImportResourcesErrorDetails
512
- class Representation < Google::Apis::Core::JsonRepresentation; end
513
-
514
- include Google::Apis::Core::JsonObjectSupport
515
- end
516
-
517
- class GoogleCloudHealthcareV1beta1FhirRestImportResourcesResponse
518
- class Representation < Google::Apis::Core::JsonRepresentation; end
519
-
520
- include Google::Apis::Core::JsonObjectSupport
521
- end
522
-
523
505
  class GroupOrSegment
524
506
  class Representation < Google::Apis::Core::JsonRepresentation; end
525
507
 
@@ -958,6 +940,12 @@ module Google
958
940
  include Google::Apis::Core::JsonObjectSupport
959
941
  end
960
942
 
943
+ class ValidationConfig
944
+ class Representation < Google::Apis::Core::JsonRepresentation; end
945
+
946
+ include Google::Apis::Core::JsonObjectSupport
947
+ end
948
+
961
949
  class VersionSource
962
950
  class Representation < Google::Apis::Core::JsonRepresentation; end
963
951
 
@@ -1087,6 +1075,14 @@ module Google
1087
1075
  end
1088
1076
  end
1089
1077
 
1078
+ class BatchGetMessagesResponse
1079
+ # @private
1080
+ class Representation < Google::Apis::Core::JsonRepresentation
1081
+ collection :messages, as: 'messages', class: Google::Apis::HealthcareV1beta1::Message, decorator: Google::Apis::HealthcareV1beta1::Message::Representation
1082
+
1083
+ end
1084
+ end
1085
+
1090
1086
  class Binding
1091
1087
  # @private
1092
1088
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1515,6 +1511,8 @@ module Google
1515
1511
 
1516
1512
  collection :stream_configs, as: 'streamConfigs', class: Google::Apis::HealthcareV1beta1::StreamConfig, decorator: Google::Apis::HealthcareV1beta1::StreamConfig::Representation
1517
1513
 
1514
+ property :validation_config, as: 'validationConfig', class: Google::Apis::HealthcareV1beta1::ValidationConfig, decorator: Google::Apis::HealthcareV1beta1::ValidationConfig::Representation
1515
+
1518
1516
  property :version, as: 'version'
1519
1517
  end
1520
1518
  end
@@ -1693,42 +1691,6 @@ module Google
1693
1691
  end
1694
1692
  end
1695
1693
 
1696
- class GoogleCloudHealthcareV1beta1FhirRestExportResourcesErrorDetails
1697
- # @private
1698
- class Representation < Google::Apis::Core::JsonRepresentation
1699
- property :error_count, :numeric_string => true, as: 'errorCount'
1700
- property :fhir_store, as: 'fhirStore'
1701
- property :resource_count, :numeric_string => true, as: 'resourceCount'
1702
- property :success_count, :numeric_string => true, as: 'successCount'
1703
- end
1704
- end
1705
-
1706
- class GoogleCloudHealthcareV1beta1FhirRestExportResourcesResponse
1707
- # @private
1708
- class Representation < Google::Apis::Core::JsonRepresentation
1709
- property :fhir_store, as: 'fhirStore'
1710
- property :resource_count, :numeric_string => true, as: 'resourceCount'
1711
- end
1712
- end
1713
-
1714
- class GoogleCloudHealthcareV1beta1FhirRestImportResourcesErrorDetails
1715
- # @private
1716
- class Representation < Google::Apis::Core::JsonRepresentation
1717
- property :error_count, :numeric_string => true, as: 'errorCount'
1718
- property :fhir_store, as: 'fhirStore'
1719
- property :input_size, :numeric_string => true, as: 'inputSize'
1720
- property :success_count, :numeric_string => true, as: 'successCount'
1721
- end
1722
- end
1723
-
1724
- class GoogleCloudHealthcareV1beta1FhirRestImportResourcesResponse
1725
- # @private
1726
- class Representation < Google::Apis::Core::JsonRepresentation
1727
- property :fhir_store, as: 'fhirStore'
1728
- property :input_size, :numeric_string => true, as: 'inputSize'
1729
- end
1730
- end
1731
-
1732
1694
  class GroupOrSegment
1733
1695
  # @private
1734
1696
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2395,6 +2357,14 @@ module Google
2395
2357
  end
2396
2358
  end
2397
2359
 
2360
+ class ValidationConfig
2361
+ # @private
2362
+ class Representation < Google::Apis::Core::JsonRepresentation
2363
+ property :disable_profile_validation, as: 'disableProfileValidation'
2364
+ collection :enabled_implementation_guides, as: 'enabledImplementationGuides'
2365
+ end
2366
+ end
2367
+
2398
2368
  class VersionSource
2399
2369
  # @private
2400
2370
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -83,11 +83,15 @@ module Google
83
83
  # @param [String] name
84
84
  # The resource that owns the locations collection, if applicable.
85
85
  # @param [String] filter
86
- # The standard list filter.
86
+ # A filter to narrow down results to a preferred subset. The filtering language
87
+ # accepts strings like "displayName=tokyo", and is documented in more detail in [
88
+ # AIP-160](https://google.aip.dev/160).
87
89
  # @param [Fixnum] page_size
88
- # The standard list page size.
90
+ # The maximum number of results to return. If not set, the service will select a
91
+ # default.
89
92
  # @param [String] page_token
90
- # The standard list page token.
93
+ # A page token received from the `next_page_token` field in the response. Send
94
+ # that page token to receive the subsequent page.
91
95
  # @param [String] fields
92
96
  # Selector specifying which fields to include in a partial response.
93
97
  # @param [String] quota_user
@@ -164,8 +168,8 @@ module Google
164
168
  # successful if de-identification fails for some resources. The new de-
165
169
  # identified dataset will not contain these failed resources. The number of
166
170
  # resources processed are tracked in Operation.metadata. Error details are
167
- # logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/
168
- # docs/how-tos/logging).
171
+ # logged to Cloud Logging. For more information, see [Viewing error logs in
172
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
169
173
  # @param [String] source_dataset
170
174
  # Source dataset resource name. For example, `projects/`project_id`/locations/`
171
175
  # location_id`/datasets/`dataset_id``.
@@ -527,7 +531,8 @@ module Google
527
531
  # operation finishes successfully, a detailed response is returned of type
528
532
  # EvaluateAnnotationStoreResponse, contained in the response. The metadata field
529
533
  # type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing
530
- # logs](/healthcare/docs/how-tos/logging)).
534
+ # error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
535
+ # logging)).
531
536
  # @param [String] name
532
537
  # The Annotation store to compare against `golden_store`, in the format of `
533
538
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -565,8 +570,8 @@ module Google
565
570
  # Export Annotations from the Annotation store. If the request is successful, a
566
571
  # detailed response is returned of type ExportAnnotationsResponse, contained in
567
572
  # the response field when the operation finishes. The metadata field type is
568
- # OperationMetadata. Errors are logged to Cloud Logging (see [Viewing logs](/
569
- # healthcare/docs/how-tos/logging)).
573
+ # OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs
574
+ # in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
570
575
  # @param [String] name
571
576
  # The name of the Annotation store to export annotations to, in the format of `
572
577
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -676,7 +681,8 @@ module Google
676
681
  # sources. If the request is successful, a detailed response is returned as of
677
682
  # type ImportAnnotationsResponse, contained in the response field when the
678
683
  # operation finishes. The metadata field type is OperationMetadata. Errors are
679
- # logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)).
684
+ # logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://
685
+ # cloud.google.com/healthcare/docs/how-tos/logging)).
680
686
  # @param [String] name
681
687
  # The name of the Annotation store to which the server imports annotations, in
682
688
  # the format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`
@@ -715,9 +721,28 @@ module Google
715
721
  # @param [String] parent
716
722
  # Name of the dataset.
717
723
  # @param [String] filter
718
- # Restricts stores returned to those matching a filter. Syntax: https://cloud.
719
- # google.com/appengine/docs/standard/python/search/query_strings Only filtering
720
- # on labels is supported, for example `labels.key=value`.
724
+ # Restricts stores returned to those matching a filter. The following syntax is
725
+ # available: * A string field value can be written as text inside quotation
726
+ # marks, for example `"query text"`. The only valid relational operation for
727
+ # text fields is equality (`=`), where text is searched within the field, rather
728
+ # than having the field be equal to the text. For example, `"Comment = great"`
729
+ # returns messages with `great` in the comment field. * A number field value can
730
+ # be written as an integer, a decimal, or an exponential. The valid relational
731
+ # operators for number fields are the equality operator (`=`), along with the
732
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
733
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
734
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
735
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
736
+ # required for one-digit months and days. The valid relational operators for
737
+ # date fields are the equality operator (`=`) , along with the less than/greater
738
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
739
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
740
+ # Multiple field query expressions can be combined in one query by adding `AND`
741
+ # or `OR` operators between the expressions. If a boolean operator appears
742
+ # within a quoted string, it is not treated as special, it's just another part
743
+ # of the character string to be matched. You can prepend the `NOT` operator to
744
+ # an expression to negate it. Only filtering on labels is supported, for example
745
+ # `labels.key=value`.
721
746
  # @param [Fixnum] page_size
722
747
  # Limit on the number of Annotation stores to return in a single response. If
723
748
  # not specified, 100 is used. May not be larger than 1000.
@@ -1053,11 +1078,11 @@ module Google
1053
1078
  execute_or_queue_command(command, &block)
1054
1079
  end
1055
1080
 
1056
- # Checks if a particular data_id of a User data mapping in the given Consent
1057
- # store is consented for a given use.
1081
+ # Checks if a particular data_id of a User data mapping in the specified consent
1082
+ # store is consented for the specified use.
1058
1083
  # @param [String] consent_store
1059
- # Name of the Consent store where the requested data_id is stored, of the form `
1060
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1084
+ # Required. Name of the consent store where the requested data_id is stored, of
1085
+ # the form `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1061
1086
  # consentStores/`consent_store_id``.
1062
1087
  # @param [Google::Apis::HealthcareV1beta1::CheckDataAccessRequest] check_data_access_request_object
1063
1088
  # @param [String] fields
@@ -1089,15 +1114,15 @@ module Google
1089
1114
  execute_or_queue_command(command, &block)
1090
1115
  end
1091
1116
 
1092
- # Creates a new Consent store in the parent dataset. Attempting to create a
1117
+ # Creates a new consent store in the parent dataset. Attempting to create a
1093
1118
  # consent store with the same ID as an existing store fails with an
1094
1119
  # ALREADY_EXISTS error.
1095
1120
  # @param [String] parent
1096
- # Required. The name of the dataset this Consent store belongs to.
1121
+ # Required. The name of the dataset this consent store belongs to.
1097
1122
  # @param [Google::Apis::HealthcareV1beta1::ConsentStore] consent_store_object
1098
1123
  # @param [String] consent_store_id
1099
- # The ID of the consent store to create. The string must match the following
1100
- # regex: `[\p`L`\p`N`_\-\.]`1,256``.
1124
+ # Required. The ID of the consent store to create. The string must match the
1125
+ # following regex: `[\p`L`\p`N`_\-\.]`1,256``. Cannot be changed after creation.
1101
1126
  # @param [String] fields
1102
1127
  # Selector specifying which fields to include in a partial response.
1103
1128
  # @param [String] quota_user
@@ -1128,10 +1153,9 @@ module Google
1128
1153
  execute_or_queue_command(command, &block)
1129
1154
  end
1130
1155
 
1131
- # Deletes the specified Consent store and removes all consent data in the
1132
- # specified consent store.
1156
+ # Deletes the specified consent store and removes all the consent store's data.
1133
1157
  # @param [String] name
1134
- # Required. The resource name of the Consent store to delete.
1158
+ # Required. The resource name of the consent store to delete.
1135
1159
  # @param [String] fields
1136
1160
  # Selector specifying which fields to include in a partial response.
1137
1161
  # @param [String] quota_user
@@ -1159,12 +1183,12 @@ module Google
1159
1183
  execute_or_queue_command(command, &block)
1160
1184
  end
1161
1185
 
1162
- # Evaluates the end user's Consents for all matching User data mappings. Note:
1163
- # User data mappings are indexed asynchronously, so there might be a slight
1164
- # delay between the time a mapping is created or updated and when it is included
1165
- # in the results of EvaluateUserConsents.
1186
+ # Evaluates the user's Consents for all matching User data mappings. Note: User
1187
+ # data mappings are indexed asynchronously, which can cause a slight delay
1188
+ # between the time mappings are created or updated and when they are included in
1189
+ # EvaluateUserConsents results.
1166
1190
  # @param [String] consent_store
1167
- # Name of the Consent store to retrieve user data mappings from.
1191
+ # Required. Name of the consent store to retrieve User data mappings from.
1168
1192
  # @param [Google::Apis::HealthcareV1beta1::EvaluateUserConsentsRequest] evaluate_user_consents_request_object
1169
1193
  # @param [String] fields
1170
1194
  # Selector specifying which fields to include in a partial response.
@@ -1195,9 +1219,9 @@ module Google
1195
1219
  execute_or_queue_command(command, &block)
1196
1220
  end
1197
1221
 
1198
- # Gets the specified Consent store.
1222
+ # Gets the specified consent store.
1199
1223
  # @param [String] name
1200
- # Required. The resource name of the Consent store to get.
1224
+ # Required. The resource name of the consent store to get.
1201
1225
  # @param [String] fields
1202
1226
  # Selector specifying which fields to include in a partial response.
1203
1227
  # @param [String] quota_user
@@ -1266,18 +1290,38 @@ module Google
1266
1290
  execute_or_queue_command(command, &block)
1267
1291
  end
1268
1292
 
1269
- # Lists the Consent stores in the given dataset.
1293
+ # Lists the consent stores in the specified dataset.
1270
1294
  # @param [String] parent
1271
1295
  # Required. Name of the dataset.
1272
1296
  # @param [String] filter
1273
- # Restricts the stores returned to those matching a filter. Syntax: https://
1274
- # cloud.google.com/appengine/docs/standard/python/search/query_strings. Only
1275
- # filtering on labels is supported. For example, `labels.key=value`.
1297
+ # Optional. Restricts the stores returned to those matching a filter. The
1298
+ # following syntax is available: * A string field value can be written as text
1299
+ # inside quotation marks, for example `"query text"`. The only valid relational
1300
+ # operation for text fields is equality (`=`), where text is searched within the
1301
+ # field, rather than having the field be equal to the text. For example, `"
1302
+ # Comment = great"` returns messages with `great` in the comment field. * A
1303
+ # number field value can be written as an integer, a decimal, or an exponential.
1304
+ # The valid relational operators for number fields are the equality operator (`=`
1305
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
1306
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
1307
+ # operator to an expression to negate it. * A date field value must be written
1308
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
1309
+ # Leading zeros are required for one-digit months and days. The valid relational
1310
+ # operators for date fields are the equality operator (`=`) , along with the
1311
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
1312
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
1313
+ # expression to negate it. * Multiple field query expressions can be combined in
1314
+ # one query by adding `AND` or `OR` operators between the expressions. If a
1315
+ # boolean operator appears within a quoted string, it is not treated as special,
1316
+ # it's just another part of the character string to be matched. You can prepend
1317
+ # the `NOT` operator to an expression to negate it. Only filtering on labels is
1318
+ # supported. For example, `filter=labels.key=value`.
1276
1319
  # @param [Fixnum] page_size
1277
- # Limit on the number of Consent stores to return in a single response. If not
1278
- # specified, 100 is used. May not be larger than 1000.
1320
+ # Optional. Limit on the number of consent stores to return in a single response.
1321
+ # If not specified, 100 is used. May not be larger than 1000.
1279
1322
  # @param [String] page_token
1280
- # Token to retrieve the next page of results or empty to get the first page.
1323
+ # Optional. Token to retrieve the next page of results, or empty to get the
1324
+ # first page.
1281
1325
  # @param [String] fields
1282
1326
  # Selector specifying which fields to include in a partial response.
1283
1327
  # @param [String] quota_user
@@ -1308,16 +1352,17 @@ module Google
1308
1352
  execute_or_queue_command(command, &block)
1309
1353
  end
1310
1354
 
1311
- # Updates the specified Consent store.
1355
+ # Updates the specified consent store.
1312
1356
  # @param [String] name
1313
- # Resource name of the Consent store, of the form `projects/`project_id`/
1357
+ # Resource name of the consent store, of the form `projects/`project_id`/
1314
1358
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id``
1315
- # .
1359
+ # . Cannot be changed after creation.
1316
1360
  # @param [Google::Apis::HealthcareV1beta1::ConsentStore] consent_store_object
1317
1361
  # @param [String] update_mask
1318
- # The update mask that applies to the resource. For the `FieldMask` definition,
1319
- # see https://developers.google.com/protocol-buffers/docs/reference/google.
1320
- # protobuf#fieldmask. The `labels` field is allowed to be updated.
1362
+ # Required. The update mask that applies to the resource. For the `FieldMask`
1363
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
1364
+ # google.protobuf#fieldmask. Only the `labels`, `default_consent_ttl`, and `
1365
+ # enable_consent_create_on_update` fields are allowed to be updated.
1321
1366
  # @param [String] fields
1322
1367
  # Selector specifying which fields to include in a partial response.
1323
1368
  # @param [String] quota_user
@@ -1348,27 +1393,28 @@ module Google
1348
1393
  execute_or_queue_command(command, &block)
1349
1394
  end
1350
1395
 
1351
- # Queries all data_ids that are consented for a given use in the given Consent
1352
- # store and writes them to a specified destination. The returned Operation
1353
- # includes a progress counter for the number of User data mappings processed.
1354
- # Errors are logged to Cloud Logging (see [Viewing logs] (/healthcare/docs/how-
1355
- # tos/logging)). For example, the following sample log entry shows a `failed to
1356
- # evaluate consent policy` error that occurred during a QueryAccessibleData call
1357
- # to consent store `projects/`project_id`/locations/`location_id`/datasets/`
1358
- # dataset_id`/consentStores/`consent_store_id``. ```json jsonPayload: ` @type: "
1359
- # type.googleapis.com/google.cloud.healthcare.logging.
1360
- # QueryAccessibleDataLogEntry" error: ` code: 9 message: "failed to evaluate
1361
- # consent policy" ` resourceName: "projects/`project_id`/locations/`location_id`/
1362
- # datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`consent_id`" `
1363
- # logName: "projects/`project_id`/logs/healthcare.googleapis.com%
1364
- # 2Fquery_accessible_data" operation: ` id: "projects/`project_id`/locations/`
1365
- # location_id`/datasets/`dataset_id`/operations/`operation_id`" producer: "
1366
- # healthcare.googleapis.com/QueryAccessibleData" ` receiveTimestamp: "TIMESTAMP"
1367
- # resource: ` labels: ` consent_store_id: "`consent_store_id`" dataset_id: "`
1368
- # dataset_id`" location: "`location_id`" project_id: "`project_id`" ` type: "
1369
- # healthcare_consent_store" ` severity: "ERROR" timestamp: "TIMESTAMP" ```
1396
+ # Queries all data_ids that are consented for a specified use in the given
1397
+ # consent store and writes them to a specified destination. The returned
1398
+ # Operation includes a progress counter for the number of User data mappings
1399
+ # processed. Errors are logged to Cloud Logging (see [Viewing error logs in
1400
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). For
1401
+ # example, the following sample log entry shows a `failed to evaluate consent
1402
+ # policy` error that occurred during a QueryAccessibleData call to consent store
1403
+ # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1404
+ # consentStores/`consent_store_id``. ```json jsonPayload: ` @type: "type.
1405
+ # googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry"
1406
+ # error: ` code: 9 message: "failed to evaluate consent policy" ` resourceName: "
1407
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1408
+ # consentStores/`consent_store_id`/consents/`consent_id`" ` logName: "projects/`
1409
+ # project_id`/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation:
1410
+ # ` id: "projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1411
+ # operations/`operation_id`" producer: "healthcare.googleapis.com/
1412
+ # QueryAccessibleData" ` receiveTimestamp: "TIMESTAMP" resource: ` labels: `
1413
+ # consent_store_id: "`consent_store_id`" dataset_id: "`dataset_id`" location: "`
1414
+ # location_id`" project_id: "`project_id`" ` type: "healthcare_consent_store" `
1415
+ # severity: "ERROR" timestamp: "TIMESTAMP" ```
1370
1416
  # @param [String] consent_store
1371
- # Name of the Consent store to retrieve user data mappings from.
1417
+ # Required. Name of the consent store to retrieve User data mappings from.
1372
1418
  # @param [Google::Apis::HealthcareV1beta1::QueryAccessibleDataRequest] query_accessible_data_request_object
1373
1419
  # @param [String] fields
1374
1420
  # Selector specifying which fields to include in a partial response.
@@ -1473,7 +1519,7 @@ module Google
1473
1519
  execute_or_queue_command(command, &block)
1474
1520
  end
1475
1521
 
1476
- # Creates a new Attribute definition in the parent Consent store.
1522
+ # Creates a new Attribute definition in the parent consent store.
1477
1523
  # @param [String] parent
1478
1524
  # Required. The name of the consent store that this Attribute definition belongs
1479
1525
  # to.
@@ -1513,10 +1559,12 @@ module Google
1513
1559
  execute_or_queue_command(command, &block)
1514
1560
  end
1515
1561
 
1516
- # Deletes the specified Attribute definition. Fails if it is referenced by any
1517
- # User data mapping, or the latest revision of any Consent.
1562
+ # Deletes the specified Attribute definition. Fails if the Attribute definition
1563
+ # is referenced by any User data mapping, or the latest revision of any Consent.
1518
1564
  # @param [String] name
1519
- # Required. The resource name of the Attribute definition to delete.
1565
+ # Required. The resource name of the Attribute definition to delete. To preserve
1566
+ # referential integrity, Attribute definitions referenced by a User data mapping
1567
+ # or the latest revision of a Consent cannot be deleted.
1520
1568
  # @param [String] fields
1521
1569
  # Selector specifying which fields to include in a partial response.
1522
1570
  # @param [String] quota_user
@@ -1574,18 +1622,38 @@ module Google
1574
1622
  execute_or_queue_command(command, &block)
1575
1623
  end
1576
1624
 
1577
- # Lists the Attribute definitions in the given Consent store.
1625
+ # Lists the Attribute definitions in the specified consent store.
1578
1626
  # @param [String] parent
1579
- # Required. Name of the Consent store to retrieve attribute definitions from.
1627
+ # Required. Name of the consent store to retrieve Attribute definitions from.
1580
1628
  # @param [String] filter
1581
- # Restricts the attributes returned to those matching a filter. Syntax: https://
1582
- # cloud.google.com/appengine/docs/standard/python/search/query_strings. The only
1583
- # field available for filtering is `category`.
1629
+ # Optional. Restricts the attributes returned to those matching a filter. The
1630
+ # following syntax is available: * A string field value can be written as text
1631
+ # inside quotation marks, for example `"query text"`. The only valid relational
1632
+ # operation for text fields is equality (`=`), where text is searched within the
1633
+ # field, rather than having the field be equal to the text. For example, `"
1634
+ # Comment = great"` returns messages with `great` in the comment field. * A
1635
+ # number field value can be written as an integer, a decimal, or an exponential.
1636
+ # The valid relational operators for number fields are the equality operator (`=`
1637
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
1638
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
1639
+ # operator to an expression to negate it. * A date field value must be written
1640
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
1641
+ # Leading zeros are required for one-digit months and days. The valid relational
1642
+ # operators for date fields are the equality operator (`=`) , along with the
1643
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
1644
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
1645
+ # expression to negate it. * Multiple field query expressions can be combined in
1646
+ # one query by adding `AND` or `OR` operators between the expressions. If a
1647
+ # boolean operator appears within a quoted string, it is not treated as special,
1648
+ # it's just another part of the character string to be matched. You can prepend
1649
+ # the `NOT` operator to an expression to negate it. The only field available for
1650
+ # filtering is `category`. For example, `filter=category=\"REQUEST\"`.
1584
1651
  # @param [Fixnum] page_size
1585
- # Limit on the number of attribute definitions to return in a single response.
1586
- # If not specified, 100 is used. May not be larger than 1000.
1652
+ # Optional. Limit on the number of Attribute definitions to return in a single
1653
+ # response. If not specified, 100 is used. May not be larger than 1000.
1587
1654
  # @param [String] page_token
1588
- # Token to retrieve the next page of results or empty to get the first page.
1655
+ # Optional. Token to retrieve the next page of results or empty to get the first
1656
+ # page.
1589
1657
  # @param [String] fields
1590
1658
  # Selector specifying which fields to include in a partial response.
1591
1659
  # @param [String] quota_user
@@ -1618,17 +1686,18 @@ module Google
1618
1686
 
1619
1687
  # Updates the specified Attribute definition.
1620
1688
  # @param [String] name
1621
- # Resource name of the attribute definition, of the form `projects/`project_id`/
1689
+ # Resource name of the Attribute definition, of the form `projects/`project_id`/
1622
1690
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
1623
- # attributeDefinitions/`attribute_definition_id``.
1691
+ # attributeDefinitions/`attribute_definition_id``. Cannot be changed after
1692
+ # creation.
1624
1693
  # @param [Google::Apis::HealthcareV1beta1::AttributeDefinition] attribute_definition_object
1625
1694
  # @param [String] update_mask
1626
- # The update mask that applies to the resource. For the `FieldMask` definition,
1627
- # see https://developers.google.com/protocol-buffers/docs/reference/google.
1628
- # protobuf#fieldmask. The `description`, `allowed_values`, `
1629
- # consent_default_values`, and `data_mapping_default_value` fields are allowed
1630
- # to be updated. The updated `allowed_values` must contain all values from the
1631
- # previous `allowed_values`.
1695
+ # Required. The update mask that applies to the resource. For the `FieldMask`
1696
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
1697
+ # google.protobuf#fieldmask. Only the `description`, `allowed_values`, `
1698
+ # consent_default_values` and `data_mapping_default_value` fields can be updated.
1699
+ # The updated `allowed_values` must contain all values from the previous `
1700
+ # allowed_values`.
1632
1701
  # @param [String] fields
1633
1702
  # Selector specifying which fields to include in a partial response.
1634
1703
  # @param [String] quota_user
@@ -1659,9 +1728,9 @@ module Google
1659
1728
  execute_or_queue_command(command, &block)
1660
1729
  end
1661
1730
 
1662
- # Creates a new Consent artifact in the parent Consent store.
1731
+ # Creates a new Consent artifact in the parent consent store.
1663
1732
  # @param [String] parent
1664
- # Required. The name of the Consent store this consent artifact belongs to.
1733
+ # Required. The name of the consent store this Consent artifact belongs to.
1665
1734
  # @param [Google::Apis::HealthcareV1beta1::ConsentArtifact] consent_artifact_object
1666
1735
  # @param [String] fields
1667
1736
  # Selector specifying which fields to include in a partial response.
@@ -1692,10 +1761,12 @@ module Google
1692
1761
  execute_or_queue_command(command, &block)
1693
1762
  end
1694
1763
 
1695
- # Deletes the specified Consent artifact. Fails if it is referenced by the
1696
- # latest revision of any Consent.
1764
+ # Deletes the specified Consent artifact. Fails if the artifact is referenced by
1765
+ # the latest revision of any Consent.
1697
1766
  # @param [String] name
1698
- # Required. The resource name of the consent artifact to delete.
1767
+ # Required. The resource name of the Consent artifact to delete. To preserve
1768
+ # referential integrity, Consent artifacts referenced by the latest revision of
1769
+ # a Consent cannot be deleted.
1699
1770
  # @param [String] fields
1700
1771
  # Selector specifying which fields to include in a partial response.
1701
1772
  # @param [String] quota_user
@@ -1725,7 +1796,7 @@ module Google
1725
1796
 
1726
1797
  # Gets the specified Consent artifact.
1727
1798
  # @param [String] name
1728
- # Required. The resource name of the consent artifact to retrieve.
1799
+ # Required. The resource name of the Consent artifact to retrieve.
1729
1800
  # @param [String] fields
1730
1801
  # Selector specifying which fields to include in a partial response.
1731
1802
  # @param [String] quota_user
@@ -1753,18 +1824,40 @@ module Google
1753
1824
  execute_or_queue_command(command, &block)
1754
1825
  end
1755
1826
 
1756
- # Lists the Consent artifacts in the given Consent store.
1827
+ # Lists the Consent artifacts in the specified consent store.
1757
1828
  # @param [String] parent
1758
- # Required. Name of the Consent store to retrieve consent artifacts from.
1829
+ # Required. Name of the consent store to retrieve consent artifacts from.
1759
1830
  # @param [String] filter
1760
- # Restricts the artifacts returned to those matching a filter. Syntax: https://
1761
- # cloud.google.com/appengine/docs/standard/python/search/query_strings The
1762
- # fields available for filtering are: - user_id - consent_content_version
1831
+ # Optional. Restricts the artifacts returned to those matching a filter. The
1832
+ # following syntax is available: * A string field value can be written as text
1833
+ # inside quotation marks, for example `"query text"`. The only valid relational
1834
+ # operation for text fields is equality (`=`), where text is searched within the
1835
+ # field, rather than having the field be equal to the text. For example, `"
1836
+ # Comment = great"` returns messages with `great` in the comment field. * A
1837
+ # number field value can be written as an integer, a decimal, or an exponential.
1838
+ # The valid relational operators for number fields are the equality operator (`=`
1839
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
1840
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
1841
+ # operator to an expression to negate it. * A date field value must be written
1842
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
1843
+ # Leading zeros are required for one-digit months and days. The valid relational
1844
+ # operators for date fields are the equality operator (`=`) , along with the
1845
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
1846
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
1847
+ # expression to negate it. * Multiple field query expressions can be combined in
1848
+ # one query by adding `AND` or `OR` operators between the expressions. If a
1849
+ # boolean operator appears within a quoted string, it is not treated as special,
1850
+ # it's just another part of the character string to be matched. You can prepend
1851
+ # the `NOT` operator to an expression to negate it. The fields available for
1852
+ # filtering are: - user_id. For example, `filter=user_id=\"user123\"`. -
1853
+ # consent_content_version - metadata. For example, `filter=Metadata(\"testkey\")=
1854
+ # \"value\"` or `filter=HasMetadata(\"testkey\")`.
1763
1855
  # @param [Fixnum] page_size
1764
- # Limit on the number of consent artifacts to return in a single response. If
1765
- # not specified, 100 is used. May not be larger than 1000.
1856
+ # Optional. Limit on the number of consent artifacts to return in a single
1857
+ # response. If not specified, 100 is used. May not be larger than 1000.
1766
1858
  # @param [String] page_token
1767
- # The next_page_token value returned from the previous List request, if any.
1859
+ # Optional. The next_page_token value returned from the previous List request,
1860
+ # if any.
1768
1861
  # @param [String] fields
1769
1862
  # Selector specifying which fields to include in a partial response.
1770
1863
  # @param [String] quota_user
@@ -1796,12 +1889,12 @@ module Google
1796
1889
  end
1797
1890
 
1798
1891
  # Activates the latest revision of the specified Consent by committing a new
1799
- # revision with `state` updated to `ACTIVE`. If the latest revision of the given
1800
- # consent is in the `ACTIVE` state, no new revision is committed. A
1801
- # FAILED_PRECONDITION error occurs if the latest revision of the given consent
1802
- # is in the `REJECTED` or `REVOKED` state.
1892
+ # revision with `state` updated to `ACTIVE`. If the latest revision of the
1893
+ # specified Consent is in the `ACTIVE` state, no new revision is committed. A
1894
+ # FAILED_PRECONDITION error occurs if the latest revision of the specified
1895
+ # consent is in the `REJECTED` or `REVOKED` state.
1803
1896
  # @param [String] name
1804
- # Required. The resource name of the consent to activate, of the form `projects/`
1897
+ # Required. The resource name of the Consent to activate, of the form `projects/`
1805
1898
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1806
1899
  # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
1807
1900
  # revision_id` is specified in the name.
@@ -1835,7 +1928,7 @@ module Google
1835
1928
  execute_or_queue_command(command, &block)
1836
1929
  end
1837
1930
 
1838
- # Creates a new Consent in the parent Consent store.
1931
+ # Creates a new Consent in the parent consent store.
1839
1932
  # @param [String] parent
1840
1933
  # Required. Name of the consent store.
1841
1934
  # @param [Google::Apis::HealthcareV1beta1::Consent] consent_object
@@ -1870,10 +1963,10 @@ module Google
1870
1963
 
1871
1964
  # Deletes the Consent and its revisions. To keep a record of the Consent but
1872
1965
  # mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [
1873
- # DeleteConsentRevision]. This operation does not delete the related consent
1966
+ # DeleteConsentRevision]. This operation does not delete the related Consent
1874
1967
  # artifact.
1875
1968
  # @param [String] name
1876
- # Required. The resource name of the consent to delete, of the form `projects/`
1969
+ # Required. The resource name of the Consent to delete, of the form `projects/`
1877
1970
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1878
1971
  # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
1879
1972
  # revision_id` is specified in the name.
@@ -1907,7 +2000,7 @@ module Google
1907
2000
  # Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs
1908
2001
  # if the specified revision is the latest revision.
1909
2002
  # @param [String] name
1910
- # Required. The resource name of the consent revision to delete, of the form `
2003
+ # Required. The resource name of the Consent revision to delete, of the form `
1911
2004
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1912
2005
  # consentStores/`consent_store_id`/consents/`consent_id`@`revision_id``. An
1913
2006
  # INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name.
@@ -1941,10 +2034,10 @@ module Google
1941
2034
  # Gets the specified revision of a Consent, or the latest revision if `
1942
2035
  # revision_id` is not specified in the resource name.
1943
2036
  # @param [String] name
1944
- # Required. The resource name of the consent to retrieve, of the form `projects/`
2037
+ # Required. The resource name of the Consent to retrieve, of the form `projects/`
1945
2038
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1946
2039
  # consent_store_id`/consents/`consent_id``. In order to retrieve a previous
1947
- # revision of the consent, also provide the revision ID: `projects/`project_id`/
2040
+ # revision of the Consent, also provide the revision ID: `projects/`project_id`/
1948
2041
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
1949
2042
  # consents/`consent_id`@`revision_id``
1950
2043
  # @param [String] fields
@@ -1974,21 +2067,41 @@ module Google
1974
2067
  execute_or_queue_command(command, &block)
1975
2068
  end
1976
2069
 
1977
- # Lists the Consent in the given Consent store, returning each consent's latest
2070
+ # Lists the Consent in the given consent store, returning each Consent's latest
1978
2071
  # revision.
1979
2072
  # @param [String] parent
1980
- # Required. Name of the Consent store to retrieve consents from.
2073
+ # Required. Name of the consent store to retrieve Consents from.
1981
2074
  # @param [String] filter
1982
- # Restricts the consents returned to those matching a filter. Syntax: https://
1983
- # cloud.google.com/appengine/docs/standard/python/search/query_strings The
1984
- # fields available for filtering are: - user_id - consent_artifact - state -
1985
- # revision_create_time - metadata. For example, `Metadata("key")="value"` or `
1986
- # HasMetadata("key")`.
2075
+ # Optional. Restricts the consents returned to those matching a filter. The
2076
+ # following syntax is available: * A string field value can be written as text
2077
+ # inside quotation marks, for example `"query text"`. The only valid relational
2078
+ # operation for text fields is equality (`=`), where text is searched within the
2079
+ # field, rather than having the field be equal to the text. For example, `"
2080
+ # Comment = great"` returns messages with `great` in the comment field. * A
2081
+ # number field value can be written as an integer, a decimal, or an exponential.
2082
+ # The valid relational operators for number fields are the equality operator (`=`
2083
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
2084
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
2085
+ # operator to an expression to negate it. * A date field value must be written
2086
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
2087
+ # Leading zeros are required for one-digit months and days. The valid relational
2088
+ # operators for date fields are the equality operator (`=`) , along with the
2089
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
2090
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
2091
+ # expression to negate it. * Multiple field query expressions can be combined in
2092
+ # one query by adding `AND` or `OR` operators between the expressions. If a
2093
+ # boolean operator appears within a quoted string, it is not treated as special,
2094
+ # it's just another part of the character string to be matched. You can prepend
2095
+ # the `NOT` operator to an expression to negate it. The fields available for
2096
+ # filtering are: - user_id. For example, `filter='user_id="user123"'`. -
2097
+ # consent_artifact - state - revision_create_time - metadata. For example, `
2098
+ # filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
1987
2099
  # @param [Fixnum] page_size
1988
- # Limit on the number of consents to return in a single response. If not
1989
- # specified, 100 is used. May not be larger than 1000.
2100
+ # Optional. Limit on the number of Consents to return in a single response. If
2101
+ # not specified, 100 is used. May not be larger than 1000.
1990
2102
  # @param [String] page_token
1991
- # The next_page_token value returned from the previous List request, if any.
2103
+ # Optional. The next_page_token value returned from the previous List request,
2104
+ # if any.
1992
2105
  # @param [String] fields
1993
2106
  # Selector specifying which fields to include in a partial response.
1994
2107
  # @param [String] quota_user
@@ -2019,20 +2132,40 @@ module Google
2019
2132
  execute_or_queue_command(command, &block)
2020
2133
  end
2021
2134
 
2022
- # Lists the revisions of the given Consent in reverse chronological order.
2135
+ # Lists the revisions of the specified Consent in reverse chronological order.
2023
2136
  # @param [String] name
2024
- # Required. The resource name of the consent to retrieve revisions for.
2137
+ # Required. The resource name of the Consent to retrieve revisions for.
2025
2138
  # @param [String] filter
2026
- # Restricts the revisions returned to those matching a filter. Syntax: https://
2027
- # cloud.google.com/appengine/docs/standard/python/search/query_strings. Fields/
2028
- # functions available for filtering are: - user_id - consent_artifact - state -
2029
- # revision_create_time
2139
+ # Optional. Restricts the revisions returned to those matching a filter. The
2140
+ # following syntax is available: * A string field value can be written as text
2141
+ # inside quotation marks, for example `"query text"`. The only valid relational
2142
+ # operation for text fields is equality (`=`), where text is searched within the
2143
+ # field, rather than having the field be equal to the text. For example, `"
2144
+ # Comment = great"` returns messages with `great` in the comment field. * A
2145
+ # number field value can be written as an integer, a decimal, or an exponential.
2146
+ # The valid relational operators for number fields are the equality operator (`=`
2147
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
2148
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
2149
+ # operator to an expression to negate it. * A date field value must be written
2150
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
2151
+ # Leading zeros are required for one-digit months and days. The valid relational
2152
+ # operators for date fields are the equality operator (`=`) , along with the
2153
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
2154
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
2155
+ # expression to negate it. * Multiple field query expressions can be combined in
2156
+ # one query by adding `AND` or `OR` operators between the expressions. If a
2157
+ # boolean operator appears within a quoted string, it is not treated as special,
2158
+ # it's just another part of the character string to be matched. You can prepend
2159
+ # the `NOT` operator to an expression to negate it. Fields/functions available
2160
+ # for filtering are: - user_id. For example, `filter='user_id="user123"'`. -
2161
+ # consent_artifact - state - revision_create_time - metadata. For example, `
2162
+ # filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
2030
2163
  # @param [Fixnum] page_size
2031
- # Limit on the number of revisions to return in a single response. If not
2032
- # specified, 100 is used. May not be larger than 1000.
2164
+ # Optional. Limit on the number of revisions to return in a single response. If
2165
+ # not specified, 100 is used. May not be larger than 1000.
2033
2166
  # @param [String] page_token
2034
- # Token to retrieve the next page of results or empty if there are no more
2035
- # results in the list.
2167
+ # Optional. Token to retrieve the next page of results or empty if there are no
2168
+ # more results in the list.
2036
2169
  # @param [String] fields
2037
2170
  # Selector specifying which fields to include in a partial response.
2038
2171
  # @param [String] quota_user
@@ -2065,17 +2198,17 @@ module Google
2065
2198
 
2066
2199
  # Updates the latest revision of the specified Consent by committing a new
2067
2200
  # revision with the changes. A FAILED_PRECONDITION error occurs if the latest
2068
- # revision of the given consent is in the `REJECTED` or `REVOKED` state.
2201
+ # revision of the specified Consent is in the `REJECTED` or `REVOKED` state.
2069
2202
  # @param [String] name
2070
2203
  # Resource name of the Consent, of the form `projects/`project_id`/locations/`
2071
2204
  # location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`
2072
- # consent_id``.
2205
+ # consent_id``. Cannot be changed after creation.
2073
2206
  # @param [Google::Apis::HealthcareV1beta1::Consent] consent_object
2074
2207
  # @param [String] update_mask
2075
- # The update mask to apply to the resource. For the `FieldMask` definition, see
2076
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
2077
- # fieldmask. The `user_id`, `policies`, and `consent_artifact` fields can be
2078
- # updated.
2208
+ # Required. The update mask to apply to the resource. For the `FieldMask`
2209
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
2210
+ # google.protobuf#fieldmask. Only the `user_id`, `policies`, `consent_artifact`,
2211
+ # and `metadata` fields can be updated.
2079
2212
  # @param [String] fields
2080
2213
  # Selector specifying which fields to include in a partial response.
2081
2214
  # @param [String] quota_user
@@ -2108,11 +2241,11 @@ module Google
2108
2241
 
2109
2242
  # Rejects the latest revision of the specified Consent by committing a new
2110
2243
  # revision with `state` updated to `REJECTED`. If the latest revision of the
2111
- # given consent is in the `REJECTED` state, no new revision is committed. A
2112
- # FAILED_PRECONDITION error occurs if the latest revision of the given consent
2113
- # is in the `ACTIVE` or `REVOKED` state.
2244
+ # specified Consent is in the `REJECTED` state, no new revision is committed. A
2245
+ # FAILED_PRECONDITION error occurs if the latest revision of the specified
2246
+ # Consent is in the `ACTIVE` or `REVOKED` state.
2114
2247
  # @param [String] name
2115
- # Required. The resource name of the consent to reject, of the form `projects/`
2248
+ # Required. The resource name of the Consent to reject, of the form `projects/`
2116
2249
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
2117
2250
  # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
2118
2251
  # revision_id` is specified in the name.
@@ -2148,11 +2281,11 @@ module Google
2148
2281
 
2149
2282
  # Revokes the latest revision of the specified Consent by committing a new
2150
2283
  # revision with `state` updated to `REVOKED`. If the latest revision of the
2151
- # given consent is in the `REVOKED` state, no new revision is committed. A
2284
+ # specified Consent is in the `REVOKED` state, no new revision is committed. A
2152
2285
  # FAILED_PRECONDITION error occurs if the latest revision of the given consent
2153
2286
  # is in `DRAFT` or `REJECTED` state.
2154
2287
  # @param [String] name
2155
- # Required. The resource name of the consent to revoke, of the form `projects/`
2288
+ # Required. The resource name of the Consent to revoke, of the form `projects/`
2156
2289
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
2157
2290
  # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
2158
2291
  # revision_id` is specified in the name.
@@ -2188,7 +2321,7 @@ module Google
2188
2321
 
2189
2322
  # Archives the specified User data mapping.
2190
2323
  # @param [String] name
2191
- # The resource name of the user data mapping to archive.
2324
+ # Required. The resource name of the User data mapping to archive.
2192
2325
  # @param [Google::Apis::HealthcareV1beta1::ArchiveUserDataMappingRequest] archive_user_data_mapping_request_object
2193
2326
  # @param [String] fields
2194
2327
  # Selector specifying which fields to include in a partial response.
@@ -2219,7 +2352,7 @@ module Google
2219
2352
  execute_or_queue_command(command, &block)
2220
2353
  end
2221
2354
 
2222
- # Creates a new User data mapping in the parent Consent store.
2355
+ # Creates a new User data mapping in the parent consent store.
2223
2356
  # @param [String] parent
2224
2357
  # Required. Name of the consent store.
2225
2358
  # @param [Google::Apis::HealthcareV1beta1::UserDataMapping] user_data_mapping_object
@@ -2254,7 +2387,7 @@ module Google
2254
2387
 
2255
2388
  # Deletes the specified User data mapping.
2256
2389
  # @param [String] name
2257
- # Required. The resource name of the user data mapping to delete.
2390
+ # Required. The resource name of the User data mapping to delete.
2258
2391
  # @param [String] fields
2259
2392
  # Selector specifying which fields to include in a partial response.
2260
2393
  # @param [String] quota_user
@@ -2284,7 +2417,7 @@ module Google
2284
2417
 
2285
2418
  # Gets the specified User data mapping.
2286
2419
  # @param [String] name
2287
- # Required. The resource name of the user data mapping to retrieve.
2420
+ # Required. The resource name of the User data mapping to retrieve.
2288
2421
  # @param [String] fields
2289
2422
  # Selector specifying which fields to include in a partial response.
2290
2423
  # @param [String] quota_user
@@ -2312,19 +2445,39 @@ module Google
2312
2445
  execute_or_queue_command(command, &block)
2313
2446
  end
2314
2447
 
2315
- # Lists the User data mappings in the given Consent store.
2448
+ # Lists the User data mappings in the specified consent store.
2316
2449
  # @param [String] parent
2317
- # Required. Name of the Consent store to retrieve user data mappings from.
2450
+ # Required. Name of the consent store to retrieve User data mappings from.
2318
2451
  # @param [String] filter
2319
- # Restricts the user data mappings returned to those matching a filter. Syntax:
2320
- # https://cloud.google.com/appengine/docs/standard/python/search/query_strings
2321
- # The fields available for filtering are: - data_id - user_id - archived -
2322
- # archive_time
2452
+ # Optional. Restricts the user data mappings returned to those matching a filter.
2453
+ # The following syntax is available: * A string field value can be written as
2454
+ # text inside quotation marks, for example `"query text"`. The only valid
2455
+ # relational operation for text fields is equality (`=`), where text is searched
2456
+ # within the field, rather than having the field be equal to the text. For
2457
+ # example, `"Comment = great"` returns messages with `great` in the comment
2458
+ # field. * A number field value can be written as an integer, a decimal, or an
2459
+ # exponential. The valid relational operators for number fields are the equality
2460
+ # operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`
2461
+ # , `>=`). Note that there is no inequality (`!=`) operator. You can prepend the
2462
+ # `NOT` operator to an expression to negate it. * A date field value must be
2463
+ # written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time
2464
+ # format. Leading zeros are required for one-digit months and days. The valid
2465
+ # relational operators for date fields are the equality operator (`=`) , along
2466
+ # with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that
2467
+ # there is no inequality (`!=`) operator. You can prepend the `NOT` operator to
2468
+ # an expression to negate it. * Multiple field query expressions can be combined
2469
+ # in one query by adding `AND` or `OR` operators between the expressions. If a
2470
+ # boolean operator appears within a quoted string, it is not treated as special,
2471
+ # it's just another part of the character string to be matched. You can prepend
2472
+ # the `NOT` operator to an expression to negate it. The fields available for
2473
+ # filtering are: - data_id - user_id. For example, `filter=user_id=\"user123\"`.
2474
+ # - archived - archive_time
2323
2475
  # @param [Fixnum] page_size
2324
- # Limit on the number of user data mappings to return in a single response. If
2325
- # not specified, 100 is used. May not be larger than 1000.
2476
+ # Optional. Limit on the number of User data mappings to return in a single
2477
+ # response. If not specified, 100 is used. May not be larger than 1000.
2326
2478
  # @param [String] page_token
2327
- # Token to retrieve the next page of results or empty to get the first page.
2479
+ # Optional. Token to retrieve the next page of results, or empty to get the
2480
+ # first page.
2328
2481
  # @param [String] fields
2329
2482
  # Selector specifying which fields to include in a partial response.
2330
2483
  # @param [String] quota_user
@@ -2362,9 +2515,10 @@ module Google
2362
2515
  # userDataMappings/`user_data_mapping_id``.
2363
2516
  # @param [Google::Apis::HealthcareV1beta1::UserDataMapping] user_data_mapping_object
2364
2517
  # @param [String] update_mask
2365
- # The update mask that applies to the resource. For the `FieldMask` definition,
2366
- # see https://developers.google.com/protocol-buffers/docs/reference/google.
2367
- # protobuf#fieldmask.
2518
+ # Required. The update mask that applies to the resource. For the `FieldMask`
2519
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
2520
+ # google.protobuf#fieldmask. Only the `data_id`, `user_id` and `
2521
+ # resource_attributes` fields can be updated.
2368
2522
  # @param [String] fields
2369
2523
  # Selector specifying which fields to include in a partial response.
2370
2524
  # @param [String] quota_user
@@ -2438,8 +2592,8 @@ module Google
2438
2592
  # result may still be successful if de-identification fails for some DICOM
2439
2593
  # instances. The output DICOM store will not contain these failed resources. The
2440
2594
  # number of resources processed are tracked in Operation.metadata. Error details
2441
- # are logged to Cloud Logging. For more information, see [Viewing logs](/
2442
- # healthcare/docs/how-tos/logging).
2595
+ # are logged to Cloud Logging. For more information, see [Viewing error logs in
2596
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
2443
2597
  # @param [String] source_store
2444
2598
  # Source DICOM store resource name. For example, `projects/`project_id`/
2445
2599
  # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
@@ -2506,8 +2660,8 @@ module Google
2506
2660
 
2507
2661
  # Exports data to the specified destination by copying it from the DICOM store.
2508
2662
  # Errors are also logged to Cloud Logging. For more information, see [Viewing
2509
- # logs](/healthcare/docs/how-tos/logging). The metadata field type is
2510
- # OperationMetadata.
2663
+ # errors in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2664
+ # logging). The metadata field type is OperationMetadata.
2511
2665
  # @param [String] name
2512
2666
  # The DICOM store resource name from which to export the data. For example, `
2513
2667
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -2614,8 +2768,9 @@ module Google
2614
2768
  end
2615
2769
 
2616
2770
  # Imports data into the DICOM store by copying it from the specified source.
2617
- # Errors are logged to Cloud Logging. For more information, see [Viewing logs](/
2618
- # healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata.
2771
+ # Errors are logged to Cloud Logging. For more information, see [Viewing error
2772
+ # logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2773
+ # logging). The metadata field type is OperationMetadata.
2619
2774
  # @param [String] name
2620
2775
  # The name of the DICOM store resource into which the data is imported. For
2621
2776
  # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -2654,9 +2809,28 @@ module Google
2654
2809
  # @param [String] parent
2655
2810
  # Name of the dataset.
2656
2811
  # @param [String] filter
2657
- # Restricts stores returned to those matching a filter. Syntax: https://cloud.
2658
- # google.com/appengine/docs/standard/python/search/query_strings Only filtering
2659
- # on labels is supported. For example, `labels.key=value`.
2812
+ # Restricts stores returned to those matching a filter. The following syntax is
2813
+ # available: * A string field value can be written as text inside quotation
2814
+ # marks, for example `"query text"`. The only valid relational operation for
2815
+ # text fields is equality (`=`), where text is searched within the field, rather
2816
+ # than having the field be equal to the text. For example, `"Comment = great"`
2817
+ # returns messages with `great` in the comment field. * A number field value can
2818
+ # be written as an integer, a decimal, or an exponential. The valid relational
2819
+ # operators for number fields are the equality operator (`=`), along with the
2820
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
2821
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
2822
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
2823
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
2824
+ # required for one-digit months and days. The valid relational operators for
2825
+ # date fields are the equality operator (`=`) , along with the less than/greater
2826
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
2827
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
2828
+ # Multiple field query expressions can be combined in one query by adding `AND`
2829
+ # or `OR` operators between the expressions. If a boolean operator appears
2830
+ # within a quoted string, it is not treated as special, it's just another part
2831
+ # of the character string to be matched. You can prepend the `NOT` operator to
2832
+ # an expression to negate it. Only filtering on labels is supported. For example,
2833
+ # `labels.key=value`.
2660
2834
  # @param [Fixnum] page_size
2661
2835
  # Limit on the number of DICOM stores to return in a single response. If not
2662
2836
  # specified, 100 is used. May not be larger than 1000.
@@ -2981,12 +3155,14 @@ module Google
2981
3155
  execute_or_queue_command(command, &block)
2982
3156
  end
2983
3157
 
2984
- # DeleteStudyAsync deletes all instances within the given study using a long
2985
- # running operation. The method returns an Operation which will be marked
2986
- # successful when the deletion is complete. Warning: If you insert instances
2987
- # into a study while a delete operation is running for that study, the instances
2988
- # you insert might not appear in search results until after the deletion
2989
- # operation finishes.
3158
+ # DeleteStudy deletes all instances within the given study using a long running
3159
+ # operation. The method returns an Operation which will be marked successful
3160
+ # when the deletion is complete. Warning: If you insert instances into a study
3161
+ # while a delete operation is running for that study, the instances you insert
3162
+ # might not appear in search results until after the deletion operation finishes.
3163
+ # For samples that show how to call DeleteStudy, see [Deleting a study, series,
3164
+ # or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
3165
+ # deleting_a_study_series_or_instance).
2990
3166
  # @param [String] parent
2991
3167
  # @param [String] dicom_web_path
2992
3168
  # The path of the DeleteStudy request. For example, `studies/`study_uid``.
@@ -3238,12 +3414,14 @@ module Google
3238
3414
  execute_or_queue_command(command, &block)
3239
3415
  end
3240
3416
 
3241
- # DeleteSeriesAsync deletes all instances within the given study and series
3242
- # using a long running operation. The method returns an Operation which will be
3243
- # marked successful when the deletion is complete. Warning: If you insert
3244
- # instances into a series while a delete operation is running for that series,
3245
- # the instances you insert might not appear in search results until after the
3246
- # deletion operation finishes.
3417
+ # DeleteSeries deletes all instances within the given study and series using a
3418
+ # long running operation. The method returns an Operation which will be marked
3419
+ # successful when the deletion is complete. Warning: If you insert instances
3420
+ # into a series while a delete operation is running for that series, the
3421
+ # instances you insert might not appear in search results until after the
3422
+ # deletion operation finishes. For samples that show how to call DeleteSeries,
3423
+ # see [Deleting a study, series, or instance](https://cloud.google.com/
3424
+ # healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
3247
3425
  # @param [String] parent
3248
3426
  # The name of the DICOM store that is being accessed. For example, `projects/`
3249
3427
  # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
@@ -3715,8 +3893,8 @@ module Google
3715
3893
  # store. The metadata field type is OperationMetadata. If the request is
3716
3894
  # successful, the response field type is DeidentifyFhirStoreSummary. The number
3717
3895
  # of resources processed are tracked in Operation.metadata. Error details are
3718
- # logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/
3719
- # docs/how-tos/logging).
3896
+ # logged to Cloud Logging. For more information, see [Viewing error logs in
3897
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
3720
3898
  # @param [String] source_store
3721
3899
  # Source FHIR store resource name. For example, `projects/`project_id`/locations/
3722
3900
  # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
@@ -3783,10 +3961,11 @@ module Google
3783
3961
  # Export resources from the FHIR store to the specified destination. This method
3784
3962
  # returns an Operation that can be used to track the status of the export by
3785
3963
  # calling GetOperation. Immediate fatal errors appear in the error field, errors
3786
- # are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](/
3787
- # healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a
3788
- # detailed response of type ExportResourcesResponse is returned in the response
3789
- # field. The metadata field type for this operation is OperationMetadata.
3964
+ # are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](
3965
+ # https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when
3966
+ # the operation finishes, a detailed response of type ExportResourcesResponse is
3967
+ # returned in the response field. The metadata field type for this operation is
3968
+ # OperationMetadata.
3790
3969
  # @param [String] name
3791
3970
  # The name of the FHIR store to export resource from, in the format of `projects/
3792
3971
  # `project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
@@ -3900,7 +4079,11 @@ module Google
3900
4079
  # method is not appropriate, consider using ExecuteBundle to load data. Every
3901
4080
  # resource in the input must contain a client-supplied ID. Each resource is
3902
4081
  # stored using the supplied ID regardless of the enable_update_create setting on
3903
- # the FHIR store. The import process does not enforce referential integrity,
4082
+ # the FHIR store. It is strongly advised not to include or encode any sensitive
4083
+ # data such as patient identifiers in client-specified resource IDs. Those IDs
4084
+ # are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/
4085
+ # Sub notifications. Those IDs can also be contained in reference fields within
4086
+ # other resources. The import process does not enforce referential integrity,
3904
4087
  # regardless of the disable_referential_integrity setting on the FHIR store.
3905
4088
  # This allows the import of resources with arbitrary interdependencies without
3906
4089
  # considering grouping or ordering, but if the input data contains invalid
@@ -3936,10 +4119,11 @@ module Google
3936
4119
  # searchset` bundles produced by a FHIR search or Patient-everything operation.
3937
4120
  # This method returns an Operation that can be used to track the status of the
3938
4121
  # import by calling GetOperation. Immediate fatal errors appear in the error
3939
- # field, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/
3940
- # docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed
3941
- # response of type ImportResourcesResponse is returned in the response field.
3942
- # The metadata field type for this operation is OperationMetadata.
4122
+ # field, errors are also logged to Cloud Logging (see [Viewing error logs in
4123
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
4124
+ # Otherwise, when the operation finishes, a detailed response of type
4125
+ # ImportResourcesResponse is returned in the response field. The metadata field
4126
+ # type for this operation is OperationMetadata.
3943
4127
  # @param [String] name
3944
4128
  # The name of the FHIR store to import FHIR resources to, in the format of `
3945
4129
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
@@ -3978,9 +4162,28 @@ module Google
3978
4162
  # @param [String] parent
3979
4163
  # Name of the dataset.
3980
4164
  # @param [String] filter
3981
- # Restricts stores returned to those matching a filter. Syntax: https://cloud.
3982
- # google.com/appengine/docs/standard/python/search/query_strings Only filtering
3983
- # on labels is supported, for example `labels.key=value`.
4165
+ # Restricts stores returned to those matching a filter. The following syntax is
4166
+ # available: * A string field value can be written as text inside quotation
4167
+ # marks, for example `"query text"`. The only valid relational operation for
4168
+ # text fields is equality (`=`), where text is searched within the field, rather
4169
+ # than having the field be equal to the text. For example, `"Comment = great"`
4170
+ # returns messages with `great` in the comment field. * A number field value can
4171
+ # be written as an integer, a decimal, or an exponential. The valid relational
4172
+ # operators for number fields are the equality operator (`=`), along with the
4173
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
4174
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
4175
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
4176
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
4177
+ # required for one-digit months and days. The valid relational operators for
4178
+ # date fields are the equality operator (`=`) , along with the less than/greater
4179
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
4180
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
4181
+ # Multiple field query expressions can be combined in one query by adding `AND`
4182
+ # or `OR` operators between the expressions. If a boolean operator appears
4183
+ # within a quoted string, it is not treated as special, it's just another part
4184
+ # of the character string to be matched. You can prepend the `NOT` operator to
4185
+ # an expression to negate it. Only filtering on labels is supported, for example
4186
+ # `labels.key=value`.
3984
4187
  # @param [Fixnum] page_size
3985
4188
  # Limit on the number of FHIR stores to return in a single response. If not
3986
4189
  # specified, 100 is used. May not be larger than 1000.
@@ -4408,6 +4611,62 @@ module Google
4408
4611
  execute_or_queue_command(command, &block)
4409
4612
  end
4410
4613
 
4614
+ # Validates an input FHIR resource's conformance to its profiles and the
4615
+ # profiles configured on the FHIR store. Implements the FHIR extended operation $
4616
+ # validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-
4617
+ # operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/
4618
+ # resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/
4619
+ # fhir/R4/resource-operation-validate.html)). The request body must contain a
4620
+ # JSON-encoded FHIR resource, and the request headers must contain `Content-Type:
4621
+ # application/fhir+json`. The `Parameters` input syntax is not supported. The `
4622
+ # profile` query parameter can be used to request that the resource only be
4623
+ # validated against a specific profile. If a profile with the given URL cannot
4624
+ # be found in the FHIR store then an error is returned. Errors generated by
4625
+ # validation contain a JSON-encoded `OperationOutcome` resource describing the
4626
+ # reason for the error. If the request cannot be mapped to a valid API method on
4627
+ # a FHIR store, a generic GCP error might be returned instead.
4628
+ # @param [String] parent
4629
+ # The name of the FHIR store that holds the profiles being used for validation.
4630
+ # @param [String] type
4631
+ # The FHIR resource type of the resource being validated. For a complete list,
4632
+ # see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/
4633
+ # DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/
4634
+ # resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/
4635
+ # resourcelist.html)). Must match the resource type in the provided content.
4636
+ # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
4637
+ # @param [String] profile
4638
+ # A profile that this resource should be validated against.
4639
+ # @param [String] fields
4640
+ # Selector specifying which fields to include in a partial response.
4641
+ # @param [String] quota_user
4642
+ # Available to use for quota purposes for server-side applications. Can be any
4643
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4644
+ # @param [Google::Apis::RequestOptions] options
4645
+ # Request-specific options
4646
+ #
4647
+ # @yield [result, err] Result & error if block supplied
4648
+ # @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object
4649
+ # @yieldparam err [StandardError] error object if request failed
4650
+ #
4651
+ # @return [Google::Apis::HealthcareV1beta1::HttpBody]
4652
+ #
4653
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4654
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4655
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4656
+ def resource_project_location_dataset_fhir_store_fhir_validate(parent, type, http_body_object = nil, profile: nil, fields: nil, quota_user: nil, options: nil, &block)
4657
+ command = make_simple_command(:post, 'v1beta1/{+parent}/fhir/{+type}/$validate', options)
4658
+ command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
4659
+ command.request_object = http_body_object
4660
+ command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
4661
+ command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
4662
+ command.params['parent'] = parent unless parent.nil?
4663
+ command.params['type'] = type unless type.nil?
4664
+ command.query['profile'] = profile unless profile.nil?
4665
+ command.query['fields'] = fields unless fields.nil?
4666
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4667
+ execute_or_queue_command(command, &block)
4668
+ end
4669
+
4411
4670
  # Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/
4412
4671
  # fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/
4413
4672
  # fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.
@@ -4570,7 +4829,11 @@ module Google
4570
4829
  # criteria identify more than one match, the request returns a `412 Precondition
4571
4830
  # Failed` error. If the search criteria identify zero matches, and the supplied
4572
4831
  # resource body contains an `id`, and the FHIR store has enable_update_create
4573
- # set, creates the resource with the client-specified ID. If the search criteria
4832
+ # set, creates the resource with the client-specified ID. It is strongly advised
4833
+ # not to include or encode any sensitive data such as patient identifiers in
4834
+ # client-specified resource IDs. Those IDs are part of the FHIR resource path
4835
+ # recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
4836
+ # contained in reference fields within other resources. If the search criteria
4574
4837
  # identify zero matches, and the supplied resource body does not contain an `id`,
4575
4838
  # the resource is created with a server-assigned ID as per the create method.
4576
4839
  # The request body must contain a JSON-encoded FHIR resource, and the request
@@ -4951,38 +5214,40 @@ module Google
4951
5214
  # described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/
4952
5215
  # standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/
4953
5216
  # fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/
4954
- # search.html)). Supports three methods of search defined by the specification: *
4955
- # `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]
4956
- # ?[parameters]` to search resources of a specified type. * `POST [base]/[type]/
4957
- # _search?[parameters]` as an alternate form having the same semantics as the `
4958
- # GET` method. The `GET` methods do not support compartment searches. The `POST`
4959
- # method does not support `application/x-www-form-urlencoded` search parameters.
4960
- # On success, the response body contains a JSON-encoded representation of a `
4961
- # Bundle` resource of type `searchset`, containing the results of the search.
4962
- # Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome`
4963
- # resource describing the reason for the error. If the request cannot be mapped
4964
- # to a valid API method on a FHIR store, a generic GCP error might be returned
4965
- # instead. The server's capability statement, retrieved through capabilities,
4966
- # indicates what search parameters are supported on each FHIR resource. A list
4967
- # of all search parameters defined by the specification can be found in the FHIR
4968
- # Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/
4969
- # STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/
4970
- # fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can
4971
- # be found on each resource's definition page. Supported search modifiers: `:
4972
- # missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`,
4973
- # `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`
4974
- # , `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `
4975
- # _elements`. The maximum number of search results returned defaults to 100,
4976
- # which can be overridden by the `_count` parameter up to a maximum limit of
4977
- # 1000. If there are additional results, the returned `Bundle` contains
4978
- # pagination links. Resources with a total size larger than 5MB or a field count
4979
- # larger than 50,000 might not be fully searchable as the server might trim its
4980
- # generated search index in those cases. Note: FHIR resources are indexed
4981
- # asynchronously, so there might be a slight delay between the time a resource
4982
- # is created or changes and when the change is reflected in search results. For
4983
- # samples and detailed information, see [Searching for FHIR resources](/
4984
- # healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](/
4985
- # healthcare/docs/how-tos/fhir-advanced-search).
5217
+ # search.html)). Supports four methods of search defined by the specification: *
5218
+ # `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?
5219
+ # [parameters]` to search resources of a specified type. * `POST [base]/_search?[
5220
+ # parameters]` as an alternate form having the same semantics as the `GET`
5221
+ # method across all resources. * `POST [base]/[type]/_search?[parameters]` as an
5222
+ # alternate form having the same semantics as the `GET` method for the specified
5223
+ # type. The `GET` and `POST` methods do not support compartment searches. The `
5224
+ # POST` method does not support `application/x-www-form-urlencoded` search
5225
+ # parameters. On success, the response body contains a JSON-encoded
5226
+ # representation of a `Bundle` resource of type `searchset`, containing the
5227
+ # results of the search. Errors generated by the FHIR store contain a JSON-
5228
+ # encoded `OperationOutcome` resource describing the reason for the error. If
5229
+ # the request cannot be mapped to a valid API method on a FHIR store, a generic
5230
+ # GCP error might be returned instead. The server's capability statement,
5231
+ # retrieved through capabilities, indicates what search parameters are supported
5232
+ # on each FHIR resource. A list of all search parameters defined by the
5233
+ # specification can be found in the FHIR Search Parameter Registry ([STU3](https:
5234
+ # //hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](
5235
+ # https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)).
5236
+ # FHIR search parameters for DSTU2 can be found on each resource's definition
5237
+ # page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `
5238
+ # :in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`.
5239
+ # Supported search result parameters: `_sort`, `_count`, `_include`, `
5240
+ # _revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum
5241
+ # number of search results returned defaults to 100, which can be overridden by
5242
+ # the `_count` parameter up to a maximum limit of 1000. If there are additional
5243
+ # results, the returned `Bundle` contains pagination links. Resources with a
5244
+ # total size larger than 5MB or a field count larger than 50,000 might not be
5245
+ # fully searchable as the server might trim its generated search index in those
5246
+ # cases. Note: FHIR resources are indexed asynchronously, so there might be a
5247
+ # slight delay between the time a resource is created or changes and when the
5248
+ # change is reflected in search results. For samples and detailed information,
5249
+ # see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [
5250
+ # Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search).
4986
5251
  # @param [String] parent
4987
5252
  # Name of the FHIR store to retrieve resources from.
4988
5253
  # @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object
@@ -5015,12 +5280,97 @@ module Google
5015
5280
  execute_or_queue_command(command, &block)
5016
5281
  end
5017
5282
 
5283
+ # Searches for resources in the given FHIR store according to criteria specified
5284
+ # as query parameters. Implements the FHIR standard search interaction ([DSTU2](
5285
+ # https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https:
5286
+ # //hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.
5287
+ # org/implement/standards/fhir/R4/http.html#search)) using the search semantics
5288
+ # described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/
5289
+ # standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/
5290
+ # fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/
5291
+ # search.html)). Supports four methods of search defined by the specification: *
5292
+ # `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?
5293
+ # [parameters]` to search resources of a specified type. * `POST [base]/_search?[
5294
+ # parameters]` as an alternate form having the same semantics as the `GET`
5295
+ # method across all resources. * `POST [base]/[type]/_search?[parameters]` as an
5296
+ # alternate form having the same semantics as the `GET` method for the specified
5297
+ # type. The `GET` and `POST` methods do not support compartment searches. The `
5298
+ # POST` method does not support `application/x-www-form-urlencoded` search
5299
+ # parameters. On success, the response body contains a JSON-encoded
5300
+ # representation of a `Bundle` resource of type `searchset`, containing the
5301
+ # results of the search. Errors generated by the FHIR store contain a JSON-
5302
+ # encoded `OperationOutcome` resource describing the reason for the error. If
5303
+ # the request cannot be mapped to a valid API method on a FHIR store, a generic
5304
+ # GCP error might be returned instead. The server's capability statement,
5305
+ # retrieved through capabilities, indicates what search parameters are supported
5306
+ # on each FHIR resource. A list of all search parameters defined by the
5307
+ # specification can be found in the FHIR Search Parameter Registry ([STU3](https:
5308
+ # //hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](
5309
+ # https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)).
5310
+ # FHIR search parameters for DSTU2 can be found on each resource's definition
5311
+ # page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `
5312
+ # :in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`.
5313
+ # Supported search result parameters: `_sort`, `_count`, `_include`, `
5314
+ # _revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum
5315
+ # number of search results returned defaults to 100, which can be overridden by
5316
+ # the `_count` parameter up to a maximum limit of 1000. If there are additional
5317
+ # results, the returned `Bundle` contains pagination links. Resources with a
5318
+ # total size larger than 5MB or a field count larger than 50,000 might not be
5319
+ # fully searchable as the server might trim its generated search index in those
5320
+ # cases. Note: FHIR resources are indexed asynchronously, so there might be a
5321
+ # slight delay between the time a resource is created or changes and when the
5322
+ # change is reflected in search results. For samples and detailed information,
5323
+ # see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [
5324
+ # Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search).
5325
+ # @param [String] parent
5326
+ # Name of the FHIR store to retrieve resources from.
5327
+ # @param [String] resource_type
5328
+ # The FHIR resource type to search, such as Patient or Observation. For a
5329
+ # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
5330
+ # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
5331
+ # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
5332
+ # standards/fhir/R4/resourcelist.html)).
5333
+ # @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object
5334
+ # @param [String] fields
5335
+ # Selector specifying which fields to include in a partial response.
5336
+ # @param [String] quota_user
5337
+ # Available to use for quota purposes for server-side applications. Can be any
5338
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5339
+ # @param [Google::Apis::RequestOptions] options
5340
+ # Request-specific options
5341
+ #
5342
+ # @yield [result, err] Result & error if block supplied
5343
+ # @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object
5344
+ # @yieldparam err [StandardError] error object if request failed
5345
+ #
5346
+ # @return [Google::Apis::HealthcareV1beta1::HttpBody]
5347
+ #
5348
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5349
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5350
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5351
+ def search_project_location_dataset_fhir_store_fhir_type(parent, resource_type, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5352
+ command = make_simple_command(:post, 'v1beta1/{+parent}/fhir/{resourceType}/_search', options)
5353
+ command.request_representation = Google::Apis::HealthcareV1beta1::SearchResourcesRequest::Representation
5354
+ command.request_object = search_resources_request_object
5355
+ command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
5356
+ command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
5357
+ command.params['parent'] = parent unless parent.nil?
5358
+ command.params['resourceType'] = resource_type unless resource_type.nil?
5359
+ command.query['fields'] = fields unless fields.nil?
5360
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5361
+ execute_or_queue_command(command, &block)
5362
+ end
5363
+
5018
5364
  # Updates the entire contents of a resource. Implements the FHIR standard update
5019
5365
  # interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#
5020
5366
  # update), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#update)
5021
5367
  # , [R4](https://hl7.org/implement/standards/fhir/R4/http.html#update)). If the
5022
5368
  # specified resource does not exist and the FHIR store has enable_update_create
5023
- # set, creates the resource with the client-specified ID. The request body must
5369
+ # set, creates the resource with the client-specified ID. It is strongly advised
5370
+ # not to include or encode any sensitive data such as patient identifiers in
5371
+ # client-specified resource IDs. Those IDs are part of the FHIR resource path
5372
+ # recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
5373
+ # contained in reference fields within other resources. The request body must
5024
5374
  # contain a JSON-encoded FHIR resource, and the request headers must contain `
5025
5375
  # Content-Type: application/fhir+json`. The resource must contain an `id`
5026
5376
  # element having an identical value to the ID in the REST path of the request.
@@ -5300,10 +5650,11 @@ module Google
5300
5650
  # successfully imported messages are not rolled back. This method returns an
5301
5651
  # Operation that can be used to track the status of the import by calling
5302
5652
  # GetOperation. Immediate fatal errors appear in the error field, errors are
5303
- # also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/
5304
- # logging)). Otherwise, when the operation finishes, a response of type
5305
- # ImportMessagesResponse is returned in the response field. The metadata field
5306
- # type for this operation is OperationMetadata.
5653
+ # also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https:/
5654
+ # /cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the
5655
+ # operation finishes, a response of type ImportMessagesResponse is returned in
5656
+ # the response field. The metadata field type for this operation is
5657
+ # OperationMetadata.
5307
5658
  # @param [String] name
5308
5659
  # The name of the target HL7v2 store, in the format `projects/`project_id`/
5309
5660
  # locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`hl7v2_store_id``
@@ -5341,9 +5692,28 @@ module Google
5341
5692
  # @param [String] parent
5342
5693
  # Name of the dataset.
5343
5694
  # @param [String] filter
5344
- # Restricts stores returned to those matching a filter. Syntax: https://cloud.
5345
- # google.com/appengine/docs/standard/python/search/query_strings Only filtering
5346
- # on labels is supported. For example, `labels.key=value`.
5695
+ # Restricts stores returned to those matching a filter. The following syntax is
5696
+ # available: * A string field value can be written as text inside quotation
5697
+ # marks, for example `"query text"`. The only valid relational operation for
5698
+ # text fields is equality (`=`), where text is searched within the field, rather
5699
+ # than having the field be equal to the text. For example, `"Comment = great"`
5700
+ # returns messages with `great` in the comment field. * A number field value can
5701
+ # be written as an integer, a decimal, or an exponential. The valid relational
5702
+ # operators for number fields are the equality operator (`=`), along with the
5703
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
5704
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
5705
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
5706
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
5707
+ # required for one-digit months and days. The valid relational operators for
5708
+ # date fields are the equality operator (`=`) , along with the less than/greater
5709
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
5710
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
5711
+ # Multiple field query expressions can be combined in one query by adding `AND`
5712
+ # or `OR` operators between the expressions. If a boolean operator appears
5713
+ # within a quoted string, it is not treated as special, it's just another part
5714
+ # of the character string to be matched. You can prepend the `NOT` operator to
5715
+ # an expression to negate it. Only filtering on labels is supported. For example,
5716
+ # `labels.key=value`.
5347
5717
  # @param [Fixnum] page_size
5348
5718
  # Limit on the number of HL7v2 stores to return in a single response. If not
5349
5719
  # specified, 100 is used. May not be larger than 1000.
@@ -5492,11 +5862,52 @@ module Google
5492
5862
  execute_or_queue_command(command, &block)
5493
5863
  end
5494
5864
 
5865
+ # Gets multiple messages in the given HL7v2 store.
5866
+ # @param [String] parent
5867
+ # Name of the HL7v2 store to retrieve messages from, in the format: `projects/`
5868
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`
5869
+ # hl7v2_store_id``.
5870
+ # @param [Array<String>, String] ids
5871
+ # The resource id of the HL7v2 messages to retrieve in the format: ``message_id``
5872
+ # , where the full resource name is ``parent`/messages/`message_id`` A maximum
5873
+ # of 100 messages can be retrieved in a batch. All 'ids' have to be under parent.
5874
+ # @param [String] view
5875
+ # Specifies the parts of the Messages resource to return in the response. When
5876
+ # unspecified, equivalent to BASIC.
5877
+ # @param [String] fields
5878
+ # Selector specifying which fields to include in a partial response.
5879
+ # @param [String] quota_user
5880
+ # Available to use for quota purposes for server-side applications. Can be any
5881
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5882
+ # @param [Google::Apis::RequestOptions] options
5883
+ # Request-specific options
5884
+ #
5885
+ # @yield [result, err] Result & error if block supplied
5886
+ # @yieldparam result [Google::Apis::HealthcareV1beta1::BatchGetMessagesResponse] parsed result object
5887
+ # @yieldparam err [StandardError] error object if request failed
5888
+ #
5889
+ # @return [Google::Apis::HealthcareV1beta1::BatchGetMessagesResponse]
5890
+ #
5891
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5892
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5893
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5894
+ def batch_project_location_dataset_hl7_v2_store_message_get(parent, ids: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
5895
+ command = make_simple_command(:get, 'v1beta1/{+parent}/messages:batchGet', options)
5896
+ command.response_representation = Google::Apis::HealthcareV1beta1::BatchGetMessagesResponse::Representation
5897
+ command.response_class = Google::Apis::HealthcareV1beta1::BatchGetMessagesResponse
5898
+ command.params['parent'] = parent unless parent.nil?
5899
+ command.query['ids'] = ids unless ids.nil?
5900
+ command.query['view'] = view unless view.nil?
5901
+ command.query['fields'] = fields unless fields.nil?
5902
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5903
+ execute_or_queue_command(command, &block)
5904
+ end
5905
+
5495
5906
  # Parses and stores an HL7v2 message. This method triggers an asynchronous
5496
- # notification to any Cloud Pub/Sub topic configured in projects.locations.
5497
- # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the
5498
- # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic,
5499
- # the adapter transmits the message when a notification is received.
5907
+ # notification to any Pub/Sub topic configured in Hl7V2Store.
5908
+ # Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
5909
+ # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
5910
+ # message when a notification is received.
5500
5911
  # @param [String] parent
5501
5912
  # The name of the dataset this message belongs to.
5502
5913
  # @param [Google::Apis::HealthcareV1beta1::CreateMessageRequest] create_message_request_object
@@ -5594,14 +6005,14 @@ module Google
5594
6005
  end
5595
6006
 
5596
6007
  # Parses and stores an HL7v2 message. This method triggers an asynchronous
5597
- # notification to any Cloud Pub/Sub topic configured in projects.locations.
5598
- # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the
5599
- # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic,
5600
- # the adapter transmits the message when a notification is received. This method
5601
- # also generates a response containing an HL7v2 acknowledgement (`ACK`) message
5602
- # when successful or a negative acknowledgement (`NACK`) message in case of
5603
- # error, suitable for replying to HL7v2 interface systems that expect these
5604
- # acknowledgements.
6008
+ # notification to any Pub/Sub topic configured in Hl7V2Store.
6009
+ # Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
6010
+ # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
6011
+ # message when a notification is received. If the method is successful, it
6012
+ # generates a response containing an HL7v2 acknowledgment (`ACK`) message. If
6013
+ # the method encounters an error, it returns a negative acknowledgment (`NACK`)
6014
+ # message. This behavior is suitable for replying to HL7v2 interface systems
6015
+ # that expect these acknowledgments.
5605
6016
  # @param [String] parent
5606
6017
  # The name of the HL7v2 store this message belongs to.
5607
6018
  # @param [Google::Apis::HealthcareV1beta1::IngestMessageRequest] ingest_message_request_object
@@ -5641,22 +6052,43 @@ module Google
5641
6052
  # @param [String] parent
5642
6053
  # Name of the HL7v2 store to retrieve messages from.
5643
6054
  # @param [String] filter
5644
- # Restricts messages returned to those matching a filter. Syntax: https://cloud.
5645
- # google.com/appengine/docs/standard/python/search/query_strings The following
5646
- # fields and functions are available for filtering: * `message_type`, from the
5647
- # MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `
5648
- # sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone,
5649
- # from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`
5650
- # , the timestamp when the message was sent, using the RFC3339 time format for
5651
- # comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:
5652
- # 00:00-05:00"`. * `send_facility`, the care center that the message came from,
5653
- # from the MSH-4 segment. For example, `send_facility = "ABC"`. * `PatientId(
5654
- # value, type)`, which matches if the message lists a patient having an ID of
5655
- # the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `
5656
- # PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with
5657
- # key `x` as set using the Message.labels map. For example, `labels."priority"="
5658
- # high"`. The operator `:*` can be used to assert the existence of a label. For
5659
- # example, `labels."priority":*`.
6055
+ # Restricts messages returned to those matching a filter. The following syntax
6056
+ # is available: * A string field value can be written as text inside quotation
6057
+ # marks, for example `"query text"`. The only valid relational operation for
6058
+ # text fields is equality (`=`), where text is searched within the field, rather
6059
+ # than having the field be equal to the text. For example, `"Comment = great"`
6060
+ # returns messages with `great` in the comment field. * A number field value can
6061
+ # be written as an integer, a decimal, or an exponential. The valid relational
6062
+ # operators for number fields are the equality operator (`=`), along with the
6063
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
6064
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
6065
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
6066
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
6067
+ # required for one-digit months and days. The valid relational operators for
6068
+ # date fields are the equality operator (`=`) , along with the less than/greater
6069
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
6070
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
6071
+ # Multiple field query expressions can be combined in one query by adding `AND`
6072
+ # or `OR` operators between the expressions. If a boolean operator appears
6073
+ # within a quoted string, it is not treated as special, it's just another part
6074
+ # of the character string to be matched. You can prepend the `NOT` operator to
6075
+ # an expression to negate it. Fields/functions available for filtering are: * `
6076
+ # message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`.
6077
+ # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the
6078
+ # dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-
6079
+ # 01-02"`. * `send_time`, the timestamp when the message was sent, using the
6080
+ # RFC3339 time format for comparisons, from the MSH-7 segment. For example, `
6081
+ # send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when
6082
+ # the message was created in the HL7v2 store. Use the RFC3339 time format for
6083
+ # comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `
6084
+ # send_facility`, the care center that the message came from, from the MSH-4
6085
+ # segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`,
6086
+ # which matches if the message lists a patient having an ID of the given value
6087
+ # and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("
6088
+ # 123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as
6089
+ # set using the Message.labels map. For example, `labels."priority"="high"`. The
6090
+ # operator `:*` can be used to assert the existence of a label. For example, `
6091
+ # labels."priority":*`.
5660
6092
  # @param [String] order_by
5661
6093
  # Orders messages returned by the specified order_by clause. Syntax: https://
5662
6094
  # cloud.google.com/apis/design/design_patterns#sorting_order Fields available