google-apis-healthcare_v1beta1 0.2.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +21 -0
- data/lib/google/apis/healthcare_v1beta1.rb +1 -1
- data/lib/google/apis/healthcare_v1beta1/classes.rb +209 -316
- data/lib/google/apis/healthcare_v1beta1/gem_version.rb +3 -3
- data/lib/google/apis/healthcare_v1beta1/representations.rb +0 -60
- data/lib/google/apis/healthcare_v1beta1/service.rb +482 -249
- metadata +5 -5
@@ -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.
|
19
|
+
GEM_VERSION = "0.7.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.2.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210414"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -502,30 +502,6 @@ module Google
|
|
502
502
|
include Google::Apis::Core::JsonObjectSupport
|
503
503
|
end
|
504
504
|
|
505
|
-
class GoogleCloudHealthcareV1beta1FhirRestExportResourcesErrorDetails
|
506
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
507
|
-
|
508
|
-
include Google::Apis::Core::JsonObjectSupport
|
509
|
-
end
|
510
|
-
|
511
|
-
class GoogleCloudHealthcareV1beta1FhirRestExportResourcesResponse
|
512
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
513
|
-
|
514
|
-
include Google::Apis::Core::JsonObjectSupport
|
515
|
-
end
|
516
|
-
|
517
|
-
class GoogleCloudHealthcareV1beta1FhirRestImportResourcesErrorDetails
|
518
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
519
|
-
|
520
|
-
include Google::Apis::Core::JsonObjectSupport
|
521
|
-
end
|
522
|
-
|
523
|
-
class GoogleCloudHealthcareV1beta1FhirRestImportResourcesResponse
|
524
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
525
|
-
|
526
|
-
include Google::Apis::Core::JsonObjectSupport
|
527
|
-
end
|
528
|
-
|
529
505
|
class GroupOrSegment
|
530
506
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
531
507
|
|
@@ -1715,42 +1691,6 @@ module Google
|
|
1715
1691
|
end
|
1716
1692
|
end
|
1717
1693
|
|
1718
|
-
class GoogleCloudHealthcareV1beta1FhirRestExportResourcesErrorDetails
|
1719
|
-
# @private
|
1720
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
1721
|
-
property :error_count, :numeric_string => true, as: 'errorCount'
|
1722
|
-
property :fhir_store, as: 'fhirStore'
|
1723
|
-
property :resource_count, :numeric_string => true, as: 'resourceCount'
|
1724
|
-
property :success_count, :numeric_string => true, as: 'successCount'
|
1725
|
-
end
|
1726
|
-
end
|
1727
|
-
|
1728
|
-
class GoogleCloudHealthcareV1beta1FhirRestExportResourcesResponse
|
1729
|
-
# @private
|
1730
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
1731
|
-
property :fhir_store, as: 'fhirStore'
|
1732
|
-
property :resource_count, :numeric_string => true, as: 'resourceCount'
|
1733
|
-
end
|
1734
|
-
end
|
1735
|
-
|
1736
|
-
class GoogleCloudHealthcareV1beta1FhirRestImportResourcesErrorDetails
|
1737
|
-
# @private
|
1738
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
1739
|
-
property :error_count, :numeric_string => true, as: 'errorCount'
|
1740
|
-
property :fhir_store, as: 'fhirStore'
|
1741
|
-
property :input_size, :numeric_string => true, as: 'inputSize'
|
1742
|
-
property :success_count, :numeric_string => true, as: 'successCount'
|
1743
|
-
end
|
1744
|
-
end
|
1745
|
-
|
1746
|
-
class GoogleCloudHealthcareV1beta1FhirRestImportResourcesResponse
|
1747
|
-
# @private
|
1748
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
1749
|
-
property :fhir_store, as: 'fhirStore'
|
1750
|
-
property :input_size, :numeric_string => true, as: 'inputSize'
|
1751
|
-
end
|
1752
|
-
end
|
1753
|
-
|
1754
1694
|
class GroupOrSegment
|
1755
1695
|
# @private
|
1756
1696
|
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
|
-
#
|
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
|
90
|
+
# The maximum number of results to return. If not set, the service selects a
|
91
|
+
# default.
|
89
92
|
# @param [String] page_token
|
90
|
-
#
|
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
|
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/
|
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](
|
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.
|
719
|
-
#
|
720
|
-
#
|
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
|
1057
|
-
# store is consented for
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
1163
|
-
#
|
1164
|
-
#
|
1165
|
-
#
|
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
|
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
|
1222
|
+
# Gets the specified consent store.
|
1199
1223
|
# @param [String] name
|
1200
|
-
# Required. The resource name of the
|
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
|
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.
|
1274
|
-
#
|
1275
|
-
#
|
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
|
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
|
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
|
1355
|
+
# Updates the specified consent store.
|
1312
1356
|
# @param [String] name
|
1313
|
-
# Resource name of the
|
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`
|
1319
|
-
# see https://developers.google.com/protocol-buffers/docs/reference/
|
1320
|
-
# protobuf#fieldmask.
|
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
|
1352
|
-
# store and writes them to a specified destination. The returned
|
1353
|
-
# includes a progress counter for the number of User data mappings
|
1354
|
-
# Errors are logged to Cloud Logging (see [Viewing logs
|
1355
|
-
# tos/logging)). For
|
1356
|
-
#
|
1357
|
-
# to consent store
|
1358
|
-
# dataset_id`/
|
1359
|
-
# type.
|
1360
|
-
# QueryAccessibleDataLogEntry"
|
1361
|
-
# consent policy" ` resourceName: "
|
1362
|
-
#
|
1363
|
-
# logName: "projects/`
|
1364
|
-
# 2Fquery_accessible_data" operation:
|
1365
|
-
# location_id`/datasets/`dataset_id`/
|
1366
|
-
# healthcare.googleapis.com/
|
1367
|
-
#
|
1368
|
-
#
|
1369
|
-
#
|
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
|
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
|
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
|
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
|
1625
|
+
# Lists the Attribute definitions in the specified consent store.
|
1578
1626
|
# @param [String] parent
|
1579
|
-
# Required. Name of the
|
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.
|
1582
|
-
#
|
1583
|
-
#
|
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
|
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
|
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
|
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`
|
1627
|
-
# see https://developers.google.com/protocol-buffers/docs/reference/
|
1628
|
-
# protobuf#fieldmask.
|
1629
|
-
# consent_default_values
|
1630
|
-
#
|
1631
|
-
#
|
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
|
1731
|
+
# Creates a new Consent artifact in the parent consent store.
|
1663
1732
|
# @param [String] parent
|
1664
|
-
# Required. The name of the
|
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
|
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
|
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
|
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
|
1827
|
+
# Lists the Consent artifacts in the specified consent store.
|
1757
1828
|
# @param [String] parent
|
1758
|
-
# Required. Name of the
|
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.
|
1761
|
-
#
|
1762
|
-
#
|
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
|
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,
|
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
|
1800
|
-
#
|
1801
|
-
# FAILED_PRECONDITION error occurs if the latest revision of the
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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.
|
1983
|
-
#
|
1984
|
-
#
|
1985
|
-
#
|
1986
|
-
#
|
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
|
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,
|
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
|
2135
|
+
# Lists the revisions of the specified Consent in reverse chronological order.
|
2023
2136
|
# @param [String] name
|
2024
|
-
# Required. The resource name of the
|
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.
|
2027
|
-
#
|
2028
|
-
#
|
2029
|
-
#
|
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
|
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
|
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
|
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`
|
2076
|
-
# https://developers.google.com/protocol-buffers/docs/reference/
|
2077
|
-
# fieldmask.
|
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
|
-
#
|
2112
|
-
# FAILED_PRECONDITION error occurs if the latest revision of the
|
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
|
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
|
-
#
|
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
|
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
|
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
|
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
|
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
|
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
|
2448
|
+
# Lists the User data mappings in the specified consent store.
|
2316
2449
|
# @param [String] parent
|
2317
|
-
# Required. Name of the
|
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.
|
2320
|
-
#
|
2321
|
-
#
|
2322
|
-
#
|
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
|
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
|
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`
|
2366
|
-
# see https://developers.google.com/protocol-buffers/docs/reference/
|
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
|
-
#
|
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
|
2618
|
-
# healthcare/docs/how-tos/
|
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.
|
2658
|
-
#
|
2659
|
-
#
|
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.
|
@@ -2983,11 +3157,10 @@ module Google
|
|
2983
3157
|
|
2984
3158
|
# DeleteStudy deletes all instances within the given study using a long running
|
2985
3159
|
# operation. The method returns an Operation which will be marked successful
|
2986
|
-
# when the deletion is complete. Warning:
|
2987
|
-
#
|
2988
|
-
#
|
2989
|
-
#
|
2990
|
-
# or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
|
3160
|
+
# when the deletion is complete. Warning: Instances cannot be inserted into a
|
3161
|
+
# study that is being deleted by an operation until the operation completes. For
|
3162
|
+
# samples that show how to call DeleteStudy, see [Deleting a study, series, or
|
3163
|
+
# instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
|
2991
3164
|
# deleting_a_study_series_or_instance).
|
2992
3165
|
# @param [String] parent
|
2993
3166
|
# @param [String] dicom_web_path
|
@@ -3242,12 +3415,11 @@ module Google
|
|
3242
3415
|
|
3243
3416
|
# DeleteSeries deletes all instances within the given study and series using a
|
3244
3417
|
# long running operation. The method returns an Operation which will be marked
|
3245
|
-
# successful when the deletion is complete. Warning:
|
3246
|
-
# into a series
|
3247
|
-
#
|
3248
|
-
#
|
3249
|
-
#
|
3250
|
-
# healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
|
3418
|
+
# successful when the deletion is complete. Warning: Instances cannot be
|
3419
|
+
# inserted into a series that is being deleted by an operation until the
|
3420
|
+
# operation completes. For samples that show how to call DeleteSeries, see [
|
3421
|
+
# Deleting a study, series, or instance](https://cloud.google.com/healthcare/
|
3422
|
+
# docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
|
3251
3423
|
# @param [String] parent
|
3252
3424
|
# The name of the DICOM store that is being accessed. For example, `projects/`
|
3253
3425
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
|
@@ -3719,8 +3891,8 @@ module Google
|
|
3719
3891
|
# store. The metadata field type is OperationMetadata. If the request is
|
3720
3892
|
# successful, the response field type is DeidentifyFhirStoreSummary. The number
|
3721
3893
|
# of resources processed are tracked in Operation.metadata. Error details are
|
3722
|
-
# logged to Cloud Logging. For more information, see [Viewing logs
|
3723
|
-
# docs/how-tos/logging).
|
3894
|
+
# logged to Cloud Logging. For more information, see [Viewing error logs in
|
3895
|
+
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
|
3724
3896
|
# @param [String] source_store
|
3725
3897
|
# Source FHIR store resource name. For example, `projects/`project_id`/locations/
|
3726
3898
|
# `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
|
@@ -3787,10 +3959,11 @@ module Google
|
|
3787
3959
|
# Export resources from the FHIR store to the specified destination. This method
|
3788
3960
|
# returns an Operation that can be used to track the status of the export by
|
3789
3961
|
# calling GetOperation. Immediate fatal errors appear in the error field, errors
|
3790
|
-
# are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](
|
3791
|
-
# healthcare/docs/how-tos/logging)). Otherwise, when
|
3792
|
-
# detailed response of type ExportResourcesResponse is
|
3793
|
-
# field. The metadata field type for this operation is
|
3962
|
+
# are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](
|
3963
|
+
# https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when
|
3964
|
+
# the operation finishes, a detailed response of type ExportResourcesResponse is
|
3965
|
+
# returned in the response field. The metadata field type for this operation is
|
3966
|
+
# OperationMetadata.
|
3794
3967
|
# @param [String] name
|
3795
3968
|
# The name of the FHIR store to export resource from, in the format of `projects/
|
3796
3969
|
# `project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
@@ -3906,7 +4079,7 @@ module Google
|
|
3906
4079
|
# stored using the supplied ID regardless of the enable_update_create setting on
|
3907
4080
|
# the FHIR store. It is strongly advised not to include or encode any sensitive
|
3908
4081
|
# data such as patient identifiers in client-specified resource IDs. Those IDs
|
3909
|
-
# are part of the FHIR resource path recorded in Cloud
|
4082
|
+
# are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/
|
3910
4083
|
# Sub notifications. Those IDs can also be contained in reference fields within
|
3911
4084
|
# other resources. The import process does not enforce referential integrity,
|
3912
4085
|
# regardless of the disable_referential_integrity setting on the FHIR store.
|
@@ -3944,10 +4117,11 @@ module Google
|
|
3944
4117
|
# searchset` bundles produced by a FHIR search or Patient-everything operation.
|
3945
4118
|
# This method returns an Operation that can be used to track the status of the
|
3946
4119
|
# import by calling GetOperation. Immediate fatal errors appear in the error
|
3947
|
-
# field, errors are also logged to Cloud Logging (see [Viewing logs
|
3948
|
-
# docs/how-tos/logging)).
|
3949
|
-
#
|
3950
|
-
#
|
4120
|
+
# field, errors are also logged to Cloud Logging (see [Viewing error logs in
|
4121
|
+
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
|
4122
|
+
# Otherwise, when the operation finishes, a detailed response of type
|
4123
|
+
# ImportResourcesResponse is returned in the response field. The metadata field
|
4124
|
+
# type for this operation is OperationMetadata.
|
3951
4125
|
# @param [String] name
|
3952
4126
|
# The name of the FHIR store to import FHIR resources to, in the format of `
|
3953
4127
|
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
|
@@ -3986,9 +4160,28 @@ module Google
|
|
3986
4160
|
# @param [String] parent
|
3987
4161
|
# Name of the dataset.
|
3988
4162
|
# @param [String] filter
|
3989
|
-
# Restricts stores returned to those matching a filter.
|
3990
|
-
#
|
3991
|
-
#
|
4163
|
+
# Restricts stores returned to those matching a filter. The following syntax is
|
4164
|
+
# available: * A string field value can be written as text inside quotation
|
4165
|
+
# marks, for example `"query text"`. The only valid relational operation for
|
4166
|
+
# text fields is equality (`=`), where text is searched within the field, rather
|
4167
|
+
# than having the field be equal to the text. For example, `"Comment = great"`
|
4168
|
+
# returns messages with `great` in the comment field. * A number field value can
|
4169
|
+
# be written as an integer, a decimal, or an exponential. The valid relational
|
4170
|
+
# operators for number fields are the equality operator (`=`), along with the
|
4171
|
+
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
|
4172
|
+
# inequality (`!=`) operator. You can prepend the `NOT` operator to an
|
4173
|
+
# expression to negate it. * A date field value must be written in `yyyy-mm-dd`
|
4174
|
+
# form. Fields with date and time use the RFC3339 time format. Leading zeros are
|
4175
|
+
# required for one-digit months and days. The valid relational operators for
|
4176
|
+
# date fields are the equality operator (`=`) , along with the less than/greater
|
4177
|
+
# than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
|
4178
|
+
# operator. You can prepend the `NOT` operator to an expression to negate it. *
|
4179
|
+
# Multiple field query expressions can be combined in one query by adding `AND`
|
4180
|
+
# or `OR` operators between the expressions. If a boolean operator appears
|
4181
|
+
# within a quoted string, it is not treated as special, it's just another part
|
4182
|
+
# of the character string to be matched. You can prepend the `NOT` operator to
|
4183
|
+
# an expression to negate it. Only filtering on labels is supported, for example
|
4184
|
+
# `labels.key=value`.
|
3992
4185
|
# @param [Fixnum] page_size
|
3993
4186
|
# Limit on the number of FHIR stores to return in a single response. If not
|
3994
4187
|
# specified, 100 is used. May not be larger than 1000.
|
@@ -4637,22 +4830,21 @@ module Google
|
|
4637
4830
|
# set, creates the resource with the client-specified ID. It is strongly advised
|
4638
4831
|
# not to include or encode any sensitive data such as patient identifiers in
|
4639
4832
|
# client-specified resource IDs. Those IDs are part of the FHIR resource path
|
4640
|
-
# recorded in Cloud
|
4641
|
-
#
|
4642
|
-
#
|
4643
|
-
#
|
4644
|
-
#
|
4645
|
-
#
|
4646
|
-
#
|
4647
|
-
#
|
4648
|
-
#
|
4649
|
-
#
|
4650
|
-
#
|
4651
|
-
#
|
4652
|
-
#
|
4653
|
-
#
|
4654
|
-
#
|
4655
|
-
# conditionally_updating_a_fhir_resource).
|
4833
|
+
# recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
|
4834
|
+
# contained in reference fields within other resources. If the search criteria
|
4835
|
+
# identify zero matches, and the supplied resource body does not contain an `id`,
|
4836
|
+
# the resource is created with a server-assigned ID as per the create method.
|
4837
|
+
# The request body must contain a JSON-encoded FHIR resource, and the request
|
4838
|
+
# headers must contain `Content-Type: application/fhir+json`. On success, the
|
4839
|
+
# response body contains a JSON-encoded representation of the updated resource,
|
4840
|
+
# including the server-assigned version ID. Errors generated by the FHIR store
|
4841
|
+
# contain a JSON-encoded `OperationOutcome` resource describing the reason for
|
4842
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
4843
|
+
# store, a generic GCP error might be returned instead. This method requires the`
|
4844
|
+
# healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update`
|
4845
|
+
# permissions on the parent FHIR store. For samples that show how to call `
|
4846
|
+
# conditionalUpdate`, see [Conditionally updating a FHIR resource](/healthcare/
|
4847
|
+
# docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).
|
4656
4848
|
# @param [String] parent
|
4657
4849
|
# The name of the FHIR store this resource belongs to.
|
4658
4850
|
# @param [String] type
|
@@ -5175,14 +5367,14 @@ module Google
|
|
5175
5367
|
# set, creates the resource with the client-specified ID. It is strongly advised
|
5176
5368
|
# not to include or encode any sensitive data such as patient identifiers in
|
5177
5369
|
# client-specified resource IDs. Those IDs are part of the FHIR resource path
|
5178
|
-
# recorded in Cloud
|
5179
|
-
#
|
5180
|
-
#
|
5181
|
-
#
|
5182
|
-
#
|
5183
|
-
#
|
5184
|
-
#
|
5185
|
-
#
|
5370
|
+
# recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
|
5371
|
+
# contained in reference fields within other resources. The request body must
|
5372
|
+
# contain a JSON-encoded FHIR resource, and the request headers must contain `
|
5373
|
+
# Content-Type: application/fhir+json`. The resource must contain an `id`
|
5374
|
+
# element having an identical value to the ID in the REST path of the request.
|
5375
|
+
# On success, the response body contains a JSON-encoded representation of the
|
5376
|
+
# updated resource, including the server-assigned version ID. Errors generated
|
5377
|
+
# by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
5186
5378
|
# describing the reason for the error. If the request cannot be mapped to a
|
5187
5379
|
# valid API method on a FHIR store, a generic GCP error might be returned
|
5188
5380
|
# instead. For samples that show how to call `update`, see [Updating a FHIR
|
@@ -5456,10 +5648,11 @@ module Google
|
|
5456
5648
|
# successfully imported messages are not rolled back. This method returns an
|
5457
5649
|
# Operation that can be used to track the status of the import by calling
|
5458
5650
|
# GetOperation. Immediate fatal errors appear in the error field, errors are
|
5459
|
-
# also logged to Cloud Logging (see [Viewing logs](
|
5460
|
-
# logging)). Otherwise, when the
|
5461
|
-
#
|
5462
|
-
# type for this operation is
|
5651
|
+
# also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https:/
|
5652
|
+
# /cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the
|
5653
|
+
# operation finishes, a response of type ImportMessagesResponse is returned in
|
5654
|
+
# the response field. The metadata field type for this operation is
|
5655
|
+
# OperationMetadata.
|
5463
5656
|
# @param [String] name
|
5464
5657
|
# The name of the target HL7v2 store, in the format `projects/`project_id`/
|
5465
5658
|
# locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`hl7v2_store_id``
|
@@ -5497,9 +5690,28 @@ module Google
|
|
5497
5690
|
# @param [String] parent
|
5498
5691
|
# Name of the dataset.
|
5499
5692
|
# @param [String] filter
|
5500
|
-
# Restricts stores returned to those matching a filter.
|
5501
|
-
#
|
5502
|
-
#
|
5693
|
+
# Restricts stores returned to those matching a filter. The following syntax is
|
5694
|
+
# available: * A string field value can be written as text inside quotation
|
5695
|
+
# marks, for example `"query text"`. The only valid relational operation for
|
5696
|
+
# text fields is equality (`=`), where text is searched within the field, rather
|
5697
|
+
# than having the field be equal to the text. For example, `"Comment = great"`
|
5698
|
+
# returns messages with `great` in the comment field. * A number field value can
|
5699
|
+
# be written as an integer, a decimal, or an exponential. The valid relational
|
5700
|
+
# operators for number fields are the equality operator (`=`), along with the
|
5701
|
+
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
|
5702
|
+
# inequality (`!=`) operator. You can prepend the `NOT` operator to an
|
5703
|
+
# expression to negate it. * A date field value must be written in `yyyy-mm-dd`
|
5704
|
+
# form. Fields with date and time use the RFC3339 time format. Leading zeros are
|
5705
|
+
# required for one-digit months and days. The valid relational operators for
|
5706
|
+
# date fields are the equality operator (`=`) , along with the less than/greater
|
5707
|
+
# than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
|
5708
|
+
# operator. You can prepend the `NOT` operator to an expression to negate it. *
|
5709
|
+
# Multiple field query expressions can be combined in one query by adding `AND`
|
5710
|
+
# or `OR` operators between the expressions. If a boolean operator appears
|
5711
|
+
# within a quoted string, it is not treated as special, it's just another part
|
5712
|
+
# of the character string to be matched. You can prepend the `NOT` operator to
|
5713
|
+
# an expression to negate it. Only filtering on labels is supported. For example,
|
5714
|
+
# `labels.key=value`.
|
5503
5715
|
# @param [Fixnum] page_size
|
5504
5716
|
# Limit on the number of HL7v2 stores to return in a single response. If not
|
5505
5717
|
# specified, 100 is used. May not be larger than 1000.
|
@@ -5690,10 +5902,10 @@ module Google
|
|
5690
5902
|
end
|
5691
5903
|
|
5692
5904
|
# Parses and stores an HL7v2 message. This method triggers an asynchronous
|
5693
|
-
# notification to any
|
5694
|
-
#
|
5695
|
-
#
|
5696
|
-
#
|
5905
|
+
# notification to any Pub/Sub topic configured in Hl7V2Store.
|
5906
|
+
# Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
|
5907
|
+
# adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
|
5908
|
+
# message when a notification is received.
|
5697
5909
|
# @param [String] parent
|
5698
5910
|
# The name of the dataset this message belongs to.
|
5699
5911
|
# @param [Google::Apis::HealthcareV1beta1::CreateMessageRequest] create_message_request_object
|
@@ -5791,14 +6003,14 @@ module Google
|
|
5791
6003
|
end
|
5792
6004
|
|
5793
6005
|
# Parses and stores an HL7v2 message. This method triggers an asynchronous
|
5794
|
-
# notification to any
|
5795
|
-
#
|
5796
|
-
#
|
5797
|
-
#
|
5798
|
-
#
|
5799
|
-
#
|
5800
|
-
#
|
5801
|
-
#
|
6006
|
+
# notification to any Pub/Sub topic configured in Hl7V2Store.
|
6007
|
+
# Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
|
6008
|
+
# adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
|
6009
|
+
# message when a notification is received. If the method is successful, it
|
6010
|
+
# generates a response containing an HL7v2 acknowledgment (`ACK`) message. If
|
6011
|
+
# the method encounters an error, it returns a negative acknowledgment (`NACK`)
|
6012
|
+
# message. This behavior is suitable for replying to HL7v2 interface systems
|
6013
|
+
# that expect these acknowledgments.
|
5802
6014
|
# @param [String] parent
|
5803
6015
|
# The name of the HL7v2 store this message belongs to.
|
5804
6016
|
# @param [Google::Apis::HealthcareV1beta1::IngestMessageRequest] ingest_message_request_object
|
@@ -5838,22 +6050,43 @@ module Google
|
|
5838
6050
|
# @param [String] parent
|
5839
6051
|
# Name of the HL7v2 store to retrieve messages from.
|
5840
6052
|
# @param [String] filter
|
5841
|
-
# Restricts messages returned to those matching a filter.
|
5842
|
-
#
|
5843
|
-
#
|
5844
|
-
#
|
5845
|
-
#
|
5846
|
-
#
|
5847
|
-
#
|
5848
|
-
#
|
5849
|
-
#
|
5850
|
-
#
|
5851
|
-
#
|
5852
|
-
#
|
5853
|
-
#
|
5854
|
-
#
|
5855
|
-
#
|
5856
|
-
#
|
6053
|
+
# Restricts messages returned to those matching a filter. The following syntax
|
6054
|
+
# is available: * A string field value can be written as text inside quotation
|
6055
|
+
# marks, for example `"query text"`. The only valid relational operation for
|
6056
|
+
# text fields is equality (`=`), where text is searched within the field, rather
|
6057
|
+
# than having the field be equal to the text. For example, `"Comment = great"`
|
6058
|
+
# returns messages with `great` in the comment field. * A number field value can
|
6059
|
+
# be written as an integer, a decimal, or an exponential. The valid relational
|
6060
|
+
# operators for number fields are the equality operator (`=`), along with the
|
6061
|
+
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
|
6062
|
+
# inequality (`!=`) operator. You can prepend the `NOT` operator to an
|
6063
|
+
# expression to negate it. * A date field value must be written in `yyyy-mm-dd`
|
6064
|
+
# form. Fields with date and time use the RFC3339 time format. Leading zeros are
|
6065
|
+
# required for one-digit months and days. The valid relational operators for
|
6066
|
+
# date fields are the equality operator (`=`) , along with the less than/greater
|
6067
|
+
# than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
|
6068
|
+
# operator. You can prepend the `NOT` operator to an expression to negate it. *
|
6069
|
+
# Multiple field query expressions can be combined in one query by adding `AND`
|
6070
|
+
# or `OR` operators between the expressions. If a boolean operator appears
|
6071
|
+
# within a quoted string, it is not treated as special, it's just another part
|
6072
|
+
# of the character string to be matched. You can prepend the `NOT` operator to
|
6073
|
+
# an expression to negate it. Fields/functions available for filtering are: * `
|
6074
|
+
# message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`.
|
6075
|
+
# * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the
|
6076
|
+
# dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-
|
6077
|
+
# 01-02"`. * `send_time`, the timestamp when the message was sent, using the
|
6078
|
+
# RFC3339 time format for comparisons, from the MSH-7 segment. For example, `
|
6079
|
+
# send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when
|
6080
|
+
# the message was created in the HL7v2 store. Use the RFC3339 time format for
|
6081
|
+
# comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `
|
6082
|
+
# send_facility`, the care center that the message came from, from the MSH-4
|
6083
|
+
# segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`,
|
6084
|
+
# which matches if the message lists a patient having an ID of the given value
|
6085
|
+
# and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("
|
6086
|
+
# 123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as
|
6087
|
+
# set using the Message.labels map. For example, `labels."priority"="high"`. The
|
6088
|
+
# operator `:*` can be used to assert the existence of a label. For example, `
|
6089
|
+
# labels."priority":*`.
|
5857
6090
|
# @param [String] order_by
|
5858
6091
|
# Orders messages returned by the specified order_by clause. Syntax: https://
|
5859
6092
|
# cloud.google.com/apis/design/design_patterns#sorting_order Fields available
|