google-apis-healthcare_v1 0.52.0 → 0.54.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -32,6 +32,8 @@ module Google
|
|
32
32
|
#
|
33
33
|
# @see https://cloud.google.com/healthcare
|
34
34
|
class CloudHealthcareService < Google::Apis::Core::BaseService
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "https://healthcare.$UNIVERSE_DOMAIN$/"
|
36
|
+
|
35
37
|
# @return [String]
|
36
38
|
# API key. Your API key identifies your project and provides you with API access,
|
37
39
|
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
@@ -43,7 +45,7 @@ module Google
|
|
43
45
|
attr_accessor :quota_user
|
44
46
|
|
45
47
|
def initialize
|
46
|
-
super(
|
48
|
+
super(DEFAULT_ENDPOINT_TEMPLATE, '',
|
47
49
|
client_name: 'google-apis-healthcare_v1',
|
48
50
|
client_version: Google::Apis::HealthcareV1::GEM_VERSION)
|
49
51
|
@batch_path = 'batch'
|
@@ -172,8 +174,8 @@ module Google
|
|
172
174
|
# error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
|
173
175
|
# logging).
|
174
176
|
# @param [String] source_dataset
|
175
|
-
# Source dataset resource name. For example, `projects/`project_id`/
|
176
|
-
# location_id`/datasets/`dataset_id``.
|
177
|
+
# Required. Source dataset resource name. For example, `projects/`project_id`/
|
178
|
+
# locations/`location_id`/datasets/`dataset_id``.
|
177
179
|
# @param [Google::Apis::HealthcareV1::DeidentifyDatasetRequest] deidentify_dataset_request_object
|
178
180
|
# @param [String] fields
|
179
181
|
# Selector specifying which fields to include in a partial response.
|
@@ -1044,10 +1046,10 @@ module Google
|
|
1044
1046
|
|
1045
1047
|
# Updates the specified Attribute definition.
|
1046
1048
|
# @param [String] name
|
1047
|
-
# Resource name of the Attribute definition, of the form `projects/`
|
1048
|
-
# locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1049
|
-
# attributeDefinitions/`attribute_definition_id``. Cannot be
|
1050
|
-
# creation.
|
1049
|
+
# Identifier. Resource name of the Attribute definition, of the form `projects/`
|
1050
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1051
|
+
# consent_store_id`/attributeDefinitions/`attribute_definition_id``. Cannot be
|
1052
|
+
# changed after creation.
|
1051
1053
|
# @param [Google::Apis::HealthcareV1::AttributeDefinition] attribute_definition_object
|
1052
1054
|
# @param [String] update_mask
|
1053
1055
|
# Required. The update mask that applies to the resource. For the `FieldMask`
|
@@ -1909,11 +1911,11 @@ module Google
|
|
1909
1911
|
|
1910
1912
|
# Creates a new DICOM store within the parent dataset.
|
1911
1913
|
# @param [String] parent
|
1912
|
-
# The name of the dataset this DICOM store belongs to.
|
1914
|
+
# Required. The name of the dataset this DICOM store belongs to.
|
1913
1915
|
# @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object
|
1914
1916
|
# @param [String] dicom_store_id
|
1915
|
-
# The ID of the DICOM store that is being created. Any string value up
|
1916
|
-
# characters in length.
|
1917
|
+
# Required. The ID of the DICOM store that is being created. Any string value up
|
1918
|
+
# to 256 characters in length.
|
1917
1919
|
# @param [String] fields
|
1918
1920
|
# Selector specifying which fields to include in a partial response.
|
1919
1921
|
# @param [String] quota_user
|
@@ -1954,8 +1956,8 @@ module Google
|
|
1954
1956
|
# Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/
|
1955
1957
|
# how-tos/logging)).
|
1956
1958
|
# @param [String] source_store
|
1957
|
-
# Source DICOM store resource name. For example, `projects/`project_id
|
1958
|
-
# locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
|
1959
|
+
# Required. Source DICOM store resource name. For example, `projects/`project_id`
|
1960
|
+
# /locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
|
1959
1961
|
# @param [Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest] deidentify_dicom_store_request_object
|
1960
1962
|
# @param [String] fields
|
1961
1963
|
# Selector specifying which fields to include in a partial response.
|
@@ -1989,7 +1991,7 @@ module Google
|
|
1989
1991
|
# Deletes the specified DICOM store and removes all images that are contained
|
1990
1992
|
# within it.
|
1991
1993
|
# @param [String] name
|
1992
|
-
# The resource name of the DICOM store to delete.
|
1994
|
+
# Required. The resource name of the DICOM store to delete.
|
1993
1995
|
# @param [String] fields
|
1994
1996
|
# Selector specifying which fields to include in a partial response.
|
1995
1997
|
# @param [String] quota_user
|
@@ -2022,8 +2024,8 @@ module Google
|
|
2022
2024
|
# error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
|
2023
2025
|
# logging). The metadata field type is OperationMetadata.
|
2024
2026
|
# @param [String] name
|
2025
|
-
# The DICOM store resource name from which to export the data. For
|
2026
|
-
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2027
|
+
# Required. The DICOM store resource name from which to export the data. For
|
2028
|
+
# example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2027
2029
|
# dicomStores/`dicom_store_id``.
|
2028
2030
|
# @param [Google::Apis::HealthcareV1::ExportDicomDataRequest] export_dicom_data_request_object
|
2029
2031
|
# @param [String] fields
|
@@ -2057,7 +2059,7 @@ module Google
|
|
2057
2059
|
|
2058
2060
|
# Gets the specified DICOM store.
|
2059
2061
|
# @param [String] name
|
2060
|
-
# The resource name of the DICOM store to get.
|
2062
|
+
# Required. The resource name of the DICOM store to get.
|
2061
2063
|
# @param [String] fields
|
2062
2064
|
# Selector specifying which fields to include in a partial response.
|
2063
2065
|
# @param [String] quota_user
|
@@ -2087,7 +2089,7 @@ module Google
|
|
2087
2089
|
|
2088
2090
|
# Gets metrics associated with the DICOM store.
|
2089
2091
|
# @param [String] name
|
2090
|
-
# The resource name of the DICOM store to get metrics for.
|
2092
|
+
# Required. The resource name of the DICOM store to get metrics for.
|
2091
2093
|
# @param [String] fields
|
2092
2094
|
# Selector specifying which fields to include in a partial response.
|
2093
2095
|
# @param [String] quota_user
|
@@ -2165,9 +2167,9 @@ module Google
|
|
2165
2167
|
# logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
|
2166
2168
|
# logging). The metadata field type is OperationMetadata.
|
2167
2169
|
# @param [String] name
|
2168
|
-
# The name of the DICOM store resource into which the data is imported.
|
2169
|
-
# example, `projects/`project_id`/locations/`location_id`/datasets/`
|
2170
|
-
# dicomStores/`dicom_store_id``.
|
2170
|
+
# Required. The name of the DICOM store resource into which the data is imported.
|
2171
|
+
# For example, `projects/`project_id`/locations/`location_id`/datasets/`
|
2172
|
+
# dataset_id`/dicomStores/`dicom_store_id``.
|
2171
2173
|
# @param [Google::Apis::HealthcareV1::ImportDicomDataRequest] import_dicom_data_request_object
|
2172
2174
|
# @param [String] fields
|
2173
2175
|
# Selector specifying which fields to include in a partial response.
|
@@ -2200,7 +2202,7 @@ module Google
|
|
2200
2202
|
|
2201
2203
|
# Lists the DICOM stores in the given dataset.
|
2202
2204
|
# @param [String] parent
|
2203
|
-
# Name of the dataset.
|
2205
|
+
# Required. Name of the dataset.
|
2204
2206
|
# @param [String] filter
|
2205
2207
|
# Restricts stores returned to those matching a filter. The following syntax is
|
2206
2208
|
# available: * A string field value can be written as text inside quotation
|
@@ -2261,13 +2263,14 @@ module Google
|
|
2261
2263
|
|
2262
2264
|
# Updates the specified DICOM store.
|
2263
2265
|
# @param [String] name
|
2264
|
-
# Resource name of the DICOM store, of the form `projects/`
|
2265
|
-
#
|
2266
|
+
# Identifier. Resource name of the DICOM store, of the form `projects/`
|
2267
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
|
2268
|
+
# dicom_store_id``.
|
2266
2269
|
# @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object
|
2267
2270
|
# @param [String] update_mask
|
2268
|
-
# The update mask applies to the resource. For the `FieldMask`
|
2269
|
-
# https://developers.google.com/protocol-buffers/docs/reference/
|
2270
|
-
# fieldmask
|
2271
|
+
# Required. The update mask applies to the resource. For the `FieldMask`
|
2272
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
2273
|
+
# google.protobuf#fieldmask
|
2271
2274
|
# @param [String] fields
|
2272
2275
|
# Selector specifying which fields to include in a partial response.
|
2273
2276
|
# @param [String] quota_user
|
@@ -2306,13 +2309,13 @@ module Google
|
|
2306
2309
|
# samples that show how to call SearchForInstances, see [Search for DICOM data](
|
2307
2310
|
# https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
|
2308
2311
|
# @param [String] parent
|
2309
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2310
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2311
|
-
# dicom_store_id``.
|
2312
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2313
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2314
|
+
# dicomStores/`dicom_store_id``.
|
2312
2315
|
# @param [String] dicom_web_path
|
2313
|
-
# The path of the SearchForInstancesRequest DICOMweb request. For
|
2314
|
-
# instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
|
2315
|
-
#
|
2316
|
+
# Required. The path of the SearchForInstancesRequest DICOMweb request. For
|
2317
|
+
# example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
|
2318
|
+
# instances`.
|
2316
2319
|
# @param [String] fields
|
2317
2320
|
# Selector specifying which fields to include in a partial response.
|
2318
2321
|
# @param [String] quota_user
|
@@ -2349,12 +2352,12 @@ module Google
|
|
2349
2352
|
# SearchForSeries, see [Search for DICOM data](https://cloud.google.com/
|
2350
2353
|
# healthcare/docs/how-tos/dicomweb#search-dicom).
|
2351
2354
|
# @param [String] parent
|
2352
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2353
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2354
|
-
# dicom_store_id``.
|
2355
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2356
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2357
|
+
# dicomStores/`dicom_store_id``.
|
2355
2358
|
# @param [String] dicom_web_path
|
2356
|
-
# The path of the SearchForSeries DICOMweb request. For example, `
|
2357
|
-
# studies/`study_uid`/series`.
|
2359
|
+
# Required. The path of the SearchForSeries DICOMweb request. For example, `
|
2360
|
+
# series` or `studies/`study_uid`/series`.
|
2358
2361
|
# @param [String] fields
|
2359
2362
|
# Selector specifying which fields to include in a partial response.
|
2360
2363
|
# @param [String] quota_user
|
@@ -2391,11 +2394,12 @@ module Google
|
|
2391
2394
|
# to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/
|
2392
2395
|
# healthcare/docs/how-tos/dicomweb#search-dicom).
|
2393
2396
|
# @param [String] parent
|
2394
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2395
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2396
|
-
# dicom_store_id``.
|
2397
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2398
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2399
|
+
# dicomStores/`dicom_store_id``.
|
2397
2400
|
# @param [String] dicom_web_path
|
2398
|
-
# The path of the SearchForStudies DICOMweb request. For example, `
|
2401
|
+
# Required. The path of the SearchForStudies DICOMweb request. For example, `
|
2402
|
+
# studies`.
|
2399
2403
|
# @param [String] fields
|
2400
2404
|
# Selector specifying which fields to include in a partial response.
|
2401
2405
|
# @param [String] quota_user
|
@@ -2470,12 +2474,12 @@ module Google
|
|
2470
2474
|
# Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
|
2471
2475
|
# store-dicom).
|
2472
2476
|
# @param [String] parent
|
2473
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2474
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2475
|
-
# dicom_store_id``.
|
2477
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2478
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2479
|
+
# dicomStores/`dicom_store_id``.
|
2476
2480
|
# @param [String] dicom_web_path
|
2477
|
-
# The path of the StoreInstances DICOMweb request. For example, `
|
2478
|
-
# study_uid`]`. Note that the `study_uid` is optional.
|
2481
|
+
# Required. The path of the StoreInstances DICOMweb request. For example, `
|
2482
|
+
# studies/[`study_uid`]`. Note that the `study_uid` is optional.
|
2479
2483
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
2480
2484
|
# @param [String] fields
|
2481
2485
|
# Selector specifying which fields to include in a partial response.
|
@@ -2548,9 +2552,9 @@ module Google
|
|
2548
2552
|
|
2549
2553
|
# GetStudyMetrics returns metrics for a study.
|
2550
2554
|
# @param [String] study
|
2551
|
-
# The study resource path. For example, `projects/`project_id`/
|
2552
|
-
# location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/
|
2553
|
-
# studies/`study_uid``.
|
2555
|
+
# Required. The study resource path. For example, `projects/`project_id`/
|
2556
|
+
# locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/
|
2557
|
+
# dicomWeb/studies/`study_uid``.
|
2554
2558
|
# @param [String] fields
|
2555
2559
|
# Selector specifying which fields to include in a partial response.
|
2556
2560
|
# @param [String] quota_user
|
@@ -2580,9 +2584,9 @@ module Google
|
|
2580
2584
|
|
2581
2585
|
# GetSeriesMetrics returns metrics for a series.
|
2582
2586
|
# @param [String] series
|
2583
|
-
# The series resource path. For example, `projects/`project_id`/
|
2584
|
-
# location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/
|
2585
|
-
# studies/`study_uid`/series/`series_uid``.
|
2587
|
+
# Required. The series resource path. For example, `projects/`project_id`/
|
2588
|
+
# locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/
|
2589
|
+
# dicomWeb/studies/`study_uid`/series/`series_uid``.
|
2586
2590
|
# @param [String] fields
|
2587
2591
|
# Selector specifying which fields to include in a partial response.
|
2588
2592
|
# @param [String] quota_user
|
@@ -2619,7 +2623,8 @@ module Google
|
|
2619
2623
|
# cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).
|
2620
2624
|
# @param [String] parent
|
2621
2625
|
# @param [String] dicom_web_path
|
2622
|
-
# The path of the DeleteStudy request. For example, `studies/`
|
2626
|
+
# Required. The path of the DeleteStudy request. For example, `studies/`
|
2627
|
+
# study_uid``.
|
2623
2628
|
# @param [String] fields
|
2624
2629
|
# Selector specifying which fields to include in a partial response.
|
2625
2630
|
# @param [String] quota_user
|
@@ -2657,12 +2662,12 @@ module Google
|
|
2657
2662
|
# to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.
|
2658
2663
|
# com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
|
2659
2664
|
# @param [String] parent
|
2660
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2661
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2662
|
-
# dicom_store_id``.
|
2665
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2666
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2667
|
+
# dicomStores/`dicom_store_id``.
|
2663
2668
|
# @param [String] dicom_web_path
|
2664
|
-
# The path of the RetrieveStudyMetadata DICOMweb request. For example,
|
2665
|
-
# study_uid`/metadata`.
|
2669
|
+
# Required. The path of the RetrieveStudyMetadata DICOMweb request. For example,
|
2670
|
+
# `studies/`study_uid`/metadata`.
|
2666
2671
|
# @param [String] fields
|
2667
2672
|
# Selector specifying which fields to include in a partial response.
|
2668
2673
|
# @param [String] quota_user
|
@@ -2700,12 +2705,12 @@ module Google
|
|
2700
2705
|
# DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-
|
2701
2706
|
# dicom).
|
2702
2707
|
# @param [String] parent
|
2703
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2704
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2705
|
-
# dicom_store_id``.
|
2708
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2709
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2710
|
+
# dicomStores/`dicom_store_id``.
|
2706
2711
|
# @param [String] dicom_web_path
|
2707
|
-
# The path of the RetrieveStudy DICOMweb request. For example, `
|
2708
|
-
# study_uid``.
|
2712
|
+
# Required. The path of the RetrieveStudy DICOMweb request. For example, `
|
2713
|
+
# studies/`study_uid``.
|
2709
2714
|
# @param [String] fields
|
2710
2715
|
# Selector specifying which fields to include in a partial response.
|
2711
2716
|
# @param [String] quota_user
|
@@ -2742,13 +2747,13 @@ module Google
|
|
2742
2747
|
# samples that show how to call SearchForInstances, see [Search for DICOM data](
|
2743
2748
|
# https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
|
2744
2749
|
# @param [String] parent
|
2745
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2746
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2747
|
-
# dicom_store_id``.
|
2750
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2751
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2752
|
+
# dicomStores/`dicom_store_id``.
|
2748
2753
|
# @param [String] dicom_web_path
|
2749
|
-
# The path of the SearchForInstancesRequest DICOMweb request. For
|
2750
|
-
# instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
|
2751
|
-
#
|
2754
|
+
# Required. The path of the SearchForInstancesRequest DICOMweb request. For
|
2755
|
+
# example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
|
2756
|
+
# instances`.
|
2752
2757
|
# @param [String] fields
|
2753
2758
|
# Selector specifying which fields to include in a partial response.
|
2754
2759
|
# @param [String] quota_user
|
@@ -2785,12 +2790,12 @@ module Google
|
|
2785
2790
|
# SearchForSeries, see [Search for DICOM data](https://cloud.google.com/
|
2786
2791
|
# healthcare/docs/how-tos/dicomweb#search-dicom).
|
2787
2792
|
# @param [String] parent
|
2788
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2789
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2790
|
-
# dicom_store_id``.
|
2793
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2794
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2795
|
+
# dicomStores/`dicom_store_id``.
|
2791
2796
|
# @param [String] dicom_web_path
|
2792
|
-
# The path of the SearchForSeries DICOMweb request. For example, `
|
2793
|
-
# studies/`study_uid`/series`.
|
2797
|
+
# Required. The path of the SearchForSeries DICOMweb request. For example, `
|
2798
|
+
# series` or `studies/`study_uid`/series`.
|
2794
2799
|
# @param [String] fields
|
2795
2800
|
# Selector specifying which fields to include in a partial response.
|
2796
2801
|
# @param [String] quota_user
|
@@ -2828,12 +2833,12 @@ module Google
|
|
2828
2833
|
# Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
|
2829
2834
|
# store-dicom).
|
2830
2835
|
# @param [String] parent
|
2831
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2832
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2833
|
-
# dicom_store_id``.
|
2836
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2837
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2838
|
+
# dicomStores/`dicom_store_id``.
|
2834
2839
|
# @param [String] dicom_web_path
|
2835
|
-
# The path of the StoreInstances DICOMweb request. For example, `
|
2836
|
-
# study_uid`]`. Note that the `study_uid` is optional.
|
2840
|
+
# Required. The path of the StoreInstances DICOMweb request. For example, `
|
2841
|
+
# studies/[`study_uid`]`. Note that the `study_uid` is optional.
|
2837
2842
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
2838
2843
|
# @param [String] fields
|
2839
2844
|
# Selector specifying which fields to include in a partial response.
|
@@ -2874,12 +2879,12 @@ module Google
|
|
2874
2879
|
# or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-
|
2875
2880
|
# dicom).
|
2876
2881
|
# @param [String] parent
|
2877
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2878
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2879
|
-
# dicom_store_id``.
|
2882
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2883
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2884
|
+
# dicomStores/`dicom_store_id``.
|
2880
2885
|
# @param [String] dicom_web_path
|
2881
|
-
# The path of the DeleteSeries request. For example, `studies/`
|
2882
|
-
#
|
2886
|
+
# Required. The path of the DeleteSeries request. For example, `studies/`
|
2887
|
+
# study_uid`/series/`series_uid``.
|
2883
2888
|
# @param [String] fields
|
2884
2889
|
# Selector specifying which fields to include in a partial response.
|
2885
2890
|
# @param [String] quota_user
|
@@ -2918,12 +2923,12 @@ module Google
|
|
2918
2923
|
# RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/
|
2919
2924
|
# healthcare/docs/how-tos/dicomweb#retrieve-metadata).
|
2920
2925
|
# @param [String] parent
|
2921
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2922
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2923
|
-
# dicom_store_id``.
|
2926
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2927
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2928
|
+
# dicomStores/`dicom_store_id``.
|
2924
2929
|
# @param [String] dicom_web_path
|
2925
|
-
# The path of the RetrieveSeriesMetadata DICOMweb request. For example,
|
2926
|
-
# `study_uid`/series/`series_uid`/metadata`.
|
2930
|
+
# Required. The path of the RetrieveSeriesMetadata DICOMweb request. For example,
|
2931
|
+
# `studies/`study_uid`/series/`series_uid`/metadata`.
|
2927
2932
|
# @param [String] fields
|
2928
2933
|
# Selector specifying which fields to include in a partial response.
|
2929
2934
|
# @param [String] quota_user
|
@@ -2961,12 +2966,12 @@ module Google
|
|
2961
2966
|
# DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-
|
2962
2967
|
# dicom).
|
2963
2968
|
# @param [String] parent
|
2964
|
-
# The name of the DICOM store that is being accessed. For example, `
|
2965
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2966
|
-
# dicom_store_id``.
|
2969
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
2970
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
2971
|
+
# dicomStores/`dicom_store_id``.
|
2967
2972
|
# @param [String] dicom_web_path
|
2968
|
-
# The path of the RetrieveSeries DICOMweb request. For example, `
|
2969
|
-
# study_uid`/series/`series_uid``.
|
2973
|
+
# Required. The path of the RetrieveSeries DICOMweb request. For example, `
|
2974
|
+
# studies/`study_uid`/series/`series_uid``.
|
2970
2975
|
# @param [String] fields
|
2971
2976
|
# Selector specifying which fields to include in a partial response.
|
2972
2977
|
# @param [String] quota_user
|
@@ -3003,13 +3008,13 @@ module Google
|
|
3003
3008
|
# samples that show how to call SearchForInstances, see [Search for DICOM data](
|
3004
3009
|
# https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
|
3005
3010
|
# @param [String] parent
|
3006
|
-
# The name of the DICOM store that is being accessed. For example, `
|
3007
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3008
|
-
# dicom_store_id``.
|
3011
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
3012
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3013
|
+
# dicomStores/`dicom_store_id``.
|
3009
3014
|
# @param [String] dicom_web_path
|
3010
|
-
# The path of the SearchForInstancesRequest DICOMweb request. For
|
3011
|
-
# instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
|
3012
|
-
#
|
3015
|
+
# Required. The path of the SearchForInstancesRequest DICOMweb request. For
|
3016
|
+
# example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
|
3017
|
+
# instances`.
|
3013
3018
|
# @param [String] fields
|
3014
3019
|
# Selector specifying which fields to include in a partial response.
|
3015
3020
|
# @param [String] quota_user
|
@@ -3046,12 +3051,12 @@ module Google
|
|
3046
3051
|
# a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/
|
3047
3052
|
# dicomweb#delete-dicom).
|
3048
3053
|
# @param [String] parent
|
3049
|
-
# The name of the DICOM store that is being accessed. For example, `
|
3050
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3051
|
-
# dicom_store_id``.
|
3054
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
3055
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3056
|
+
# dicomStores/`dicom_store_id``.
|
3052
3057
|
# @param [String] dicom_web_path
|
3053
|
-
# The path of the DeleteInstance request. For example, `studies/`
|
3054
|
-
# series/`series_uid`/instances/`instance_uid``.
|
3058
|
+
# Required. The path of the DeleteInstance request. For example, `studies/`
|
3059
|
+
# study_uid`/series/`series_uid`/instances/`instance_uid``.
|
3055
3060
|
# @param [String] fields
|
3056
3061
|
# Selector specifying which fields to include in a partial response.
|
3057
3062
|
# @param [String] quota_user
|
@@ -3090,12 +3095,12 @@ module Google
|
|
3090
3095
|
# call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/
|
3091
3096
|
# healthcare/docs/how-tos/dicomweb#retrieve-instance).
|
3092
3097
|
# @param [String] parent
|
3093
|
-
# The name of the DICOM store that is being accessed. For example, `
|
3094
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3095
|
-
# dicom_store_id``.
|
3098
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
3099
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3100
|
+
# dicomStores/`dicom_store_id``.
|
3096
3101
|
# @param [String] dicom_web_path
|
3097
|
-
# The path of the RetrieveInstance DICOMweb request. For example, `
|
3098
|
-
# study_uid`/series/`series_uid`/instances/`instance_uid``.
|
3102
|
+
# Required. The path of the RetrieveInstance DICOMweb request. For example, `
|
3103
|
+
# studies/`study_uid`/series/`series_uid`/instances/`instance_uid``.
|
3099
3104
|
# @param [String] fields
|
3100
3105
|
# Selector specifying which fields to include in a partial response.
|
3101
3106
|
# @param [String] quota_user
|
@@ -3134,12 +3139,13 @@ module Google
|
|
3134
3139
|
# RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/
|
3135
3140
|
# healthcare/docs/how-tos/dicomweb#retrieve-metadata).
|
3136
3141
|
# @param [String] parent
|
3137
|
-
# The name of the DICOM store that is being accessed. For example, `
|
3138
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3139
|
-
# dicom_store_id``.
|
3142
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
3143
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3144
|
+
# dicomStores/`dicom_store_id``.
|
3140
3145
|
# @param [String] dicom_web_path
|
3141
|
-
# The path of the RetrieveInstanceMetadata DICOMweb request. For
|
3142
|
-
# studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
|
3146
|
+
# Required. The path of the RetrieveInstanceMetadata DICOMweb request. For
|
3147
|
+
# example, `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
|
3148
|
+
# metadata`.
|
3143
3149
|
# @param [String] fields
|
3144
3150
|
# Selector specifying which fields to include in a partial response.
|
3145
3151
|
# @param [String] quota_user
|
@@ -3178,12 +3184,13 @@ module Google
|
|
3178
3184
|
# RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.
|
3179
3185
|
# google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
|
3180
3186
|
# @param [String] parent
|
3181
|
-
# The name of the DICOM store that is being accessed. For example, `
|
3182
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3183
|
-
# dicom_store_id``.
|
3187
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
3188
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3189
|
+
# dicomStores/`dicom_store_id``.
|
3184
3190
|
# @param [String] dicom_web_path
|
3185
|
-
# The path of the RetrieveRenderedInstance DICOMweb request. For
|
3186
|
-
# studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
|
3191
|
+
# Required. The path of the RetrieveRenderedInstance DICOMweb request. For
|
3192
|
+
# example, `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
|
3193
|
+
# rendered`.
|
3187
3194
|
# @param [String] fields
|
3188
3195
|
# Selector specifying which fields to include in a partial response.
|
3189
3196
|
# @param [String] quota_user
|
@@ -3221,12 +3228,13 @@ module Google
|
|
3221
3228
|
# Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
|
3222
3229
|
# retrieve-dicom).
|
3223
3230
|
# @param [String] parent
|
3224
|
-
# The name of the DICOM store that is being accessed. For example, `
|
3225
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3226
|
-
# dicom_store_id``.
|
3231
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
3232
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3233
|
+
# dicomStores/`dicom_store_id``.
|
3227
3234
|
# @param [String] dicom_web_path
|
3228
|
-
# The path of the RetrieveFrames DICOMweb request. For example, `
|
3229
|
-
# study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
|
3235
|
+
# Required. The path of the RetrieveFrames DICOMweb request. For example, `
|
3236
|
+
# studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
|
3237
|
+
# frame_list``.
|
3230
3238
|
# @param [String] fields
|
3231
3239
|
# Selector specifying which fields to include in a partial response.
|
3232
3240
|
# @param [String] quota_user
|
@@ -3265,13 +3273,13 @@ module Google
|
|
3265
3273
|
# RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.
|
3266
3274
|
# google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
|
3267
3275
|
# @param [String] parent
|
3268
|
-
# The name of the DICOM store that is being accessed. For example, `
|
3269
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3270
|
-
# dicom_store_id``.
|
3276
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
3277
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3278
|
+
# dicomStores/`dicom_store_id``.
|
3271
3279
|
# @param [String] dicom_web_path
|
3272
|
-
# The path of the RetrieveRenderedFrames DICOMweb request. For example,
|
3273
|
-
# `study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
|
3274
|
-
# rendered`.
|
3280
|
+
# Required. The path of the RetrieveRenderedFrames DICOMweb request. For example,
|
3281
|
+
# `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
|
3282
|
+
# frame_list`/rendered`.
|
3275
3283
|
# @param [String] fields
|
3276
3284
|
# Selector specifying which fields to include in a partial response.
|
3277
3285
|
# @param [String] quota_user
|
@@ -3302,11 +3310,11 @@ module Google
|
|
3302
3310
|
|
3303
3311
|
# Creates a new FHIR store within the parent dataset.
|
3304
3312
|
# @param [String] parent
|
3305
|
-
# The name of the dataset this FHIR store belongs to.
|
3313
|
+
# Required. The name of the dataset this FHIR store belongs to.
|
3306
3314
|
# @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object
|
3307
3315
|
# @param [String] fhir_store_id
|
3308
|
-
# The ID of the FHIR store that is being created. The string must
|
3309
|
-
# following regex: `[\p`L`\p`N`_\-\.]`1,256``.
|
3316
|
+
# Required. The ID of the FHIR store that is being created. The string must
|
3317
|
+
# match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
|
3310
3318
|
# @param [String] fields
|
3311
3319
|
# Selector specifying which fields to include in a partial response.
|
3312
3320
|
# @param [String] quota_user
|
@@ -3344,8 +3352,8 @@ module Google
|
|
3344
3352
|
# Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/
|
3345
3353
|
# how-tos/logging)).
|
3346
3354
|
# @param [String] source_store
|
3347
|
-
# Source FHIR store resource name. For example, `projects/`project_id`/
|
3348
|
-
#
|
3355
|
+
# Required. Source FHIR store resource name. For example, `projects/`project_id`/
|
3356
|
+
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
|
3349
3357
|
# @param [Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object
|
3350
3358
|
# @param [String] fields
|
3351
3359
|
# Selector specifying which fields to include in a partial response.
|
@@ -3378,7 +3386,7 @@ module Google
|
|
3378
3386
|
|
3379
3387
|
# Deletes the specified FHIR store and removes all resources within it.
|
3380
3388
|
# @param [String] name
|
3381
|
-
# The resource name of the FHIR store to delete.
|
3389
|
+
# Required. The resource name of the FHIR store to delete.
|
3382
3390
|
# @param [String] fields
|
3383
3391
|
# Selector specifying which fields to include in a partial response.
|
3384
3392
|
# @param [String] quota_user
|
@@ -3415,9 +3423,9 @@ module Google
|
|
3415
3423
|
# returned in the response field. The metadata field type for this operation is
|
3416
3424
|
# OperationMetadata.
|
3417
3425
|
# @param [String] name
|
3418
|
-
# The name of the FHIR store to export resource from, in the format of
|
3419
|
-
# `project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3420
|
-
# fhir_store_id``.
|
3426
|
+
# Required. The name of the FHIR store to export resource from, in the format of
|
3427
|
+
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3428
|
+
# fhirStores/`fhir_store_id``.
|
3421
3429
|
# @param [Google::Apis::HealthcareV1::ExportResourcesRequest] export_resources_request_object
|
3422
3430
|
# @param [String] fields
|
3423
3431
|
# Selector specifying which fields to include in a partial response.
|
@@ -3450,7 +3458,7 @@ module Google
|
|
3450
3458
|
|
3451
3459
|
# Gets the configuration of the specified FHIR store.
|
3452
3460
|
# @param [String] name
|
3453
|
-
# The resource name of the FHIR store to get.
|
3461
|
+
# Required. The resource name of the FHIR store to get.
|
3454
3462
|
# @param [String] fields
|
3455
3463
|
# Selector specifying which fields to include in a partial response.
|
3456
3464
|
# @param [String] quota_user
|
@@ -3480,7 +3488,7 @@ module Google
|
|
3480
3488
|
|
3481
3489
|
# Gets metrics associated with the FHIR store.
|
3482
3490
|
# @param [String] name
|
3483
|
-
# The resource name of the FHIR store to get metrics for.
|
3491
|
+
# Required. The resource name of the FHIR store to get metrics for.
|
3484
3492
|
# @param [String] fields
|
3485
3493
|
# Selector specifying which fields to include in a partial response.
|
3486
3494
|
# @param [String] quota_user
|
@@ -3607,9 +3615,9 @@ module Google
|
|
3607
3615
|
# ImportResourcesResponse is returned in the response field. The metadata field
|
3608
3616
|
# type for this operation is OperationMetadata.
|
3609
3617
|
# @param [String] name
|
3610
|
-
# The name of the FHIR store to import FHIR resources to, in the
|
3611
|
-
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3612
|
-
#
|
3618
|
+
# Required. The name of the FHIR store to import FHIR resources to, in the
|
3619
|
+
# format of `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3620
|
+
# fhirStores/`fhir_store_id``.
|
3613
3621
|
# @param [Google::Apis::HealthcareV1::ImportResourcesRequest] import_resources_request_object
|
3614
3622
|
# @param [String] fields
|
3615
3623
|
# Selector specifying which fields to include in a partial response.
|
@@ -3642,7 +3650,7 @@ module Google
|
|
3642
3650
|
|
3643
3651
|
# Lists the FHIR stores in the given dataset.
|
3644
3652
|
# @param [String] parent
|
3645
|
-
# Name of the dataset.
|
3653
|
+
# Required. Name of the dataset.
|
3646
3654
|
# @param [String] filter
|
3647
3655
|
# Restricts stores returned to those matching a filter. The following syntax is
|
3648
3656
|
# available: * A string field value can be written as text inside quotation
|
@@ -3703,13 +3711,13 @@ module Google
|
|
3703
3711
|
|
3704
3712
|
# Updates the configuration of the specified FHIR store.
|
3705
3713
|
# @param [String] name
|
3706
|
-
# Output only. Resource name of the FHIR store, of the form `
|
3707
|
-
# project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
|
3714
|
+
# Output only. Identifier. Resource name of the FHIR store, of the form `
|
3715
|
+
# projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
|
3708
3716
|
# @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object
|
3709
3717
|
# @param [String] update_mask
|
3710
|
-
# The update mask applies to the resource. For the `FieldMask`
|
3711
|
-
# https://developers.google.com/protocol-buffers/docs/reference/
|
3712
|
-
# fieldmask
|
3718
|
+
# Required. The update mask applies to the resource. For the `FieldMask`
|
3719
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
3720
|
+
# google.protobuf#fieldmask
|
3713
3721
|
# @param [String] fields
|
3714
3722
|
# Selector specifying which fields to include in a partial response.
|
3715
3723
|
# @param [String] quota_user
|
@@ -3740,6 +3748,48 @@ module Google
|
|
3740
3748
|
execute_or_queue_command(command, &block)
|
3741
3749
|
end
|
3742
3750
|
|
3751
|
+
# Rolls back resources from the FHIR store to the specified time. This method
|
3752
|
+
# returns an Operation that can be used to track the status of the rollback by
|
3753
|
+
# calling GetOperation. Immediate fatal errors appear in the error field, errors
|
3754
|
+
# are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](
|
3755
|
+
# https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when
|
3756
|
+
# the operation finishes, a detailed response of type
|
3757
|
+
# RollbackFhirResourcesResponse is returned in the response field. The metadata
|
3758
|
+
# field type for this operation is OperationMetadata.
|
3759
|
+
# @param [String] name
|
3760
|
+
# Required. The name of the FHIR store to rollback, in the format of "projects/`
|
3761
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id` /fhirStores/`
|
3762
|
+
# fhir_store_id`".
|
3763
|
+
# @param [Google::Apis::HealthcareV1::RollbackFhirResourcesRequest] rollback_fhir_resources_request_object
|
3764
|
+
# @param [String] fields
|
3765
|
+
# Selector specifying which fields to include in a partial response.
|
3766
|
+
# @param [String] quota_user
|
3767
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3768
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3769
|
+
# @param [Google::Apis::RequestOptions] options
|
3770
|
+
# Request-specific options
|
3771
|
+
#
|
3772
|
+
# @yield [result, err] Result & error if block supplied
|
3773
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
|
3774
|
+
# @yieldparam err [StandardError] error object if request failed
|
3775
|
+
#
|
3776
|
+
# @return [Google::Apis::HealthcareV1::Operation]
|
3777
|
+
#
|
3778
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3779
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3780
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3781
|
+
def rollback_fhir_store_fhir_resources(name, rollback_fhir_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3782
|
+
command = make_simple_command(:post, 'v1/{+name}:rollback', options)
|
3783
|
+
command.request_representation = Google::Apis::HealthcareV1::RollbackFhirResourcesRequest::Representation
|
3784
|
+
command.request_object = rollback_fhir_resources_request_object
|
3785
|
+
command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
|
3786
|
+
command.response_class = Google::Apis::HealthcareV1::Operation
|
3787
|
+
command.params['name'] = name unless name.nil?
|
3788
|
+
command.query['fields'] = fields unless fields.nil?
|
3789
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3790
|
+
execute_or_queue_command(command, &block)
|
3791
|
+
end
|
3792
|
+
|
3743
3793
|
# Sets the access control policy on the specified resource. Replaces any
|
3744
3794
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
3745
3795
|
# PERMISSION_DENIED` errors.
|
@@ -3839,10 +3889,10 @@ module Google
|
|
3839
3889
|
# cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
3840
3890
|
# getting_all_patient_compartment_resources).
|
3841
3891
|
# @param [String] name
|
3842
|
-
# Name of the `Patient` resource for which the information is required.
|
3892
|
+
# Required. Name of the `Patient` resource for which the information is required.
|
3843
3893
|
# @param [Fixnum] _count
|
3844
|
-
# Maximum number of resources in a page. If not specified, 100 is used.
|
3845
|
-
# be larger than 1000.
|
3894
|
+
# Optional. Maximum number of resources in a page. If not specified, 100 is used.
|
3895
|
+
# May not be larger than 1000.
|
3846
3896
|
# @param [String] _page_token
|
3847
3897
|
# Used to retrieve the next or previous page of results when using pagination.
|
3848
3898
|
# Set `_page_token` to the value of _page_token set in next or previous page
|
@@ -3850,23 +3900,24 @@ module Google
|
|
3850
3900
|
# field, where `link.relation` is "previous" or "next". Omit `_page_token` if no
|
3851
3901
|
# previous request has been made.
|
3852
3902
|
# @param [String] _since
|
3853
|
-
# If provided, only resources updated after this time are returned.
|
3854
|
-
# uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-
|
3855
|
-
# 17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified
|
3856
|
-
# second and include a time zone.
|
3903
|
+
# Optional. If provided, only resources updated after this time are returned.
|
3904
|
+
# The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-
|
3905
|
+
# 07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified
|
3906
|
+
# to the second and include a time zone.
|
3857
3907
|
# @param [String] _type
|
3858
|
-
# String of comma-delimited FHIR resource types. If provided, only
|
3859
|
-
# the specified resource type(s) are returned. Specifying multiple `
|
3860
|
-
# parameters isn't supported. For example, the result of `_type=
|
3861
|
-
# _type=Encounter` is undefined. Use `_type=Observation,Encounter`
|
3908
|
+
# Optional. String of comma-delimited FHIR resource types. If provided, only
|
3909
|
+
# resources of the specified resource type(s) are returned. Specifying multiple `
|
3910
|
+
# _type` parameters isn't supported. For example, the result of `_type=
|
3911
|
+
# Observation&_type=Encounter` is undefined. Use `_type=Observation,Encounter`
|
3912
|
+
# instead.
|
3862
3913
|
# @param [String] end_
|
3863
|
-
# The response includes records prior to the end date. The date uses
|
3864
|
-
# YYYY-MM-DD. If no end date is provided, all records subsequent to
|
3865
|
-
# date are in scope.
|
3914
|
+
# Optional. The response includes records prior to the end date. The date uses
|
3915
|
+
# the format YYYY-MM-DD. If no end date is provided, all records subsequent to
|
3916
|
+
# the start date are in scope.
|
3866
3917
|
# @param [String] start
|
3867
|
-
# The response includes records subsequent to the start date. The date
|
3868
|
-
# format YYYY-MM-DD. If no start date is provided, all records prior to
|
3869
|
-
# date are in scope.
|
3918
|
+
# Optional. The response includes records subsequent to the start date. The date
|
3919
|
+
# uses the format YYYY-MM-DD. If no start date is provided, all records prior to
|
3920
|
+
# the end date are in scope.
|
3870
3921
|
# @param [String] fields
|
3871
3922
|
# Selector specifying which fields to include in a partial response.
|
3872
3923
|
# @param [String] quota_user
|
@@ -3908,7 +3959,7 @@ module Google
|
|
3908
3959
|
# healthcare/docs/how-tos/fhir-resources#
|
3909
3960
|
# deleting_historical_versions_of_a_fhir_resource).
|
3910
3961
|
# @param [String] name
|
3911
|
-
# The name of the resource to purge.
|
3962
|
+
# Required. The name of the resource to purge.
|
3912
3963
|
# @param [String] fields
|
3913
3964
|
# Selector specifying which fields to include in a partial response.
|
3914
3965
|
# @param [String] quota_user
|
@@ -3951,18 +4002,20 @@ module Google
|
|
3951
4002
|
# reason for the error. If the request cannot be mapped to a valid API method on
|
3952
4003
|
# a FHIR store, a generic GCP error might be returned instead.
|
3953
4004
|
# @param [String] parent
|
3954
|
-
# The name of the FHIR store that holds the profiles being used for
|
4005
|
+
# Required. The name of the FHIR store that holds the profiles being used for
|
4006
|
+
# validation.
|
3955
4007
|
# @param [String] type
|
3956
|
-
# The FHIR resource type of the resource being validated. For a
|
3957
|
-
# see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/
|
3958
|
-
# DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/
|
3959
|
-
# resourcelist.html), or [R4](http://hl7.org/implement/
|
3960
|
-
# resourcelist.html)). Must match the resource type in the
|
4008
|
+
# Required. The FHIR resource type of the resource being validated. For a
|
4009
|
+
# complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/
|
4010
|
+
# standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/
|
4011
|
+
# standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/
|
4012
|
+
# standards/fhir/R4/resourcelist.html)). Must match the resource type in the
|
4013
|
+
# provided content.
|
3961
4014
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
3962
4015
|
# @param [String] profile
|
3963
|
-
# The canonical URL of a profile that this resource should be
|
3964
|
-
# For example, to validate a Patient resource against the US
|
3965
|
-
# profile this parameter would be `http://hl7.org/fhir/us/core/
|
4016
|
+
# Required. The canonical URL of a profile that this resource should be
|
4017
|
+
# validated against. For example, to validate a Patient resource against the US
|
4018
|
+
# Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/
|
3966
4019
|
# StructureDefinition/us-core-patient`. A StructureDefinition with this
|
3967
4020
|
# canonical URL must exist in the FHIR store.
|
3968
4021
|
# @param [String] fields
|
@@ -4008,7 +4061,7 @@ module Google
|
|
4008
4061
|
# conformance) in the DSTU2 case. On success, the response body contains a JSON-
|
4009
4062
|
# encoded representation of a `CapabilityStatement` resource.
|
4010
4063
|
# @param [String] name
|
4011
|
-
# Name of the FHIR store to retrieve the capabilities for.
|
4064
|
+
# Required. Name of the FHIR store to retrieve the capabilities for.
|
4012
4065
|
# @param [String] fields
|
4013
4066
|
# Selector specifying which fields to include in a partial response.
|
4014
4067
|
# @param [String] quota_user
|
@@ -4049,13 +4102,13 @@ module Google
|
|
4049
4102
|
# Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/
|
4050
4103
|
# docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).
|
4051
4104
|
# @param [String] parent
|
4052
|
-
# The name of the FHIR store this resource belongs to.
|
4105
|
+
# Required. The name of the FHIR store this resource belongs to.
|
4053
4106
|
# @param [String] type
|
4054
|
-
# The FHIR resource type to delete, such as Patient or Observation.
|
4055
|
-
# complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
4056
|
-
# standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
|
4057
|
-
# standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
|
4058
|
-
# standards/fhir/R4/resourcelist.html)).
|
4107
|
+
# Required. The FHIR resource type to delete, such as Patient or Observation.
|
4108
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
4109
|
+
# implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
|
4110
|
+
# implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
|
4111
|
+
# implement/standards/fhir/R4/resourcelist.html)).
|
4059
4112
|
# @param [String] fields
|
4060
4113
|
# Selector specifying which fields to include in a partial response.
|
4061
4114
|
# @param [String] quota_user
|
@@ -4104,13 +4157,13 @@ module Google
|
|
4104
4157
|
# resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
4105
4158
|
# conditionally_patching_a_fhir_resource).
|
4106
4159
|
# @param [String] parent
|
4107
|
-
# The name of the FHIR store this resource belongs to.
|
4160
|
+
# Required. The name of the FHIR store this resource belongs to.
|
4108
4161
|
# @param [String] type
|
4109
|
-
# The FHIR resource type to update, such as Patient or Observation.
|
4110
|
-
# complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
4111
|
-
# standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
|
4112
|
-
# standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
|
4113
|
-
# standards/fhir/R4/resourcelist.html)).
|
4162
|
+
# Required. The FHIR resource type to update, such as Patient or Observation.
|
4163
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
4164
|
+
# implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
|
4165
|
+
# implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
|
4166
|
+
# implement/standards/fhir/R4/resourcelist.html)).
|
4114
4167
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4115
4168
|
# @param [String] fields
|
4116
4169
|
# Selector specifying which fields to include in a partial response.
|
@@ -4169,14 +4222,14 @@ module Google
|
|
4169
4222
|
# google.com/healthcare/docs/how-tos/fhir-resources#
|
4170
4223
|
# conditionally_updating_a_fhir_resource).
|
4171
4224
|
# @param [String] parent
|
4172
|
-
# The name of the FHIR store this resource belongs to.
|
4225
|
+
# Required. The name of the FHIR store this resource belongs to.
|
4173
4226
|
# @param [String] type
|
4174
|
-
# The FHIR resource type to update, such as Patient or Observation.
|
4175
|
-
# complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
4176
|
-
# standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
|
4177
|
-
# standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
|
4178
|
-
# standards/fhir/R4/resourcelist.html)). Must match the resource type
|
4179
|
-
# provided content.
|
4227
|
+
# Required. The FHIR resource type to update, such as Patient or Observation.
|
4228
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
4229
|
+
# implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
|
4230
|
+
# implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
|
4231
|
+
# implement/standards/fhir/R4/resourcelist.html)). Must match the resource type
|
4232
|
+
# in the provided content.
|
4180
4233
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4181
4234
|
# @param [String] fields
|
4182
4235
|
# Selector specifying which fields to include in a partial response.
|
@@ -4233,14 +4286,14 @@ module Google
|
|
4233
4286
|
# Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
4234
4287
|
# fhir-resources#creating_a_fhir_resource).
|
4235
4288
|
# @param [String] parent
|
4236
|
-
# The name of the FHIR store this resource belongs to.
|
4289
|
+
# Required. The name of the FHIR store this resource belongs to.
|
4237
4290
|
# @param [String] type
|
4238
|
-
# The FHIR resource type to create, such as Patient or Observation.
|
4239
|
-
# complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/
|
4240
|
-
# standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/
|
4241
|
-
# standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/
|
4242
|
-
# standards/fhir/R4/resourcelist.html)). Must match the resource type
|
4243
|
-
# provided content.
|
4291
|
+
# Required. The FHIR resource type to create, such as Patient or Observation.
|
4292
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/
|
4293
|
+
# implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/
|
4294
|
+
# implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/
|
4295
|
+
# implement/standards/fhir/R4/resourcelist.html)). Must match the resource type
|
4296
|
+
# in the provided content.
|
4244
4297
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4245
4298
|
# @param [String] fields
|
4246
4299
|
# Selector specifying which fields to include in a partial response.
|
@@ -4283,7 +4336,7 @@ module Google
|
|
4283
4336
|
# Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
4284
4337
|
# fhir-resources#deleting_a_fhir_resource).
|
4285
4338
|
# @param [String] name
|
4286
|
-
# The name of the resource to delete.
|
4339
|
+
# Required. The name of the resource to delete.
|
4287
4340
|
# @param [String] fields
|
4288
4341
|
# Selector specifying which fields to include in a partial response.
|
4289
4342
|
# @param [String] quota_user
|
@@ -4345,7 +4398,7 @@ module Google
|
|
4345
4398
|
# using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
4346
4399
|
# bundles).
|
4347
4400
|
# @param [String] parent
|
4348
|
-
# Name of the FHIR store in which this bundle will be executed.
|
4401
|
+
# Required. Name of the FHIR store in which this bundle will be executed.
|
4349
4402
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4350
4403
|
# @param [String] fields
|
4351
4404
|
# Selector specifying which fields to include in a partial response.
|
@@ -4391,7 +4444,7 @@ module Google
|
|
4391
4444
|
# resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
4392
4445
|
# resources#listing_fhir_resource_versions).
|
4393
4446
|
# @param [String] name
|
4394
|
-
# The name of the resource to retrieve.
|
4447
|
+
# Required. The name of the resource to retrieve.
|
4395
4448
|
# @param [String] _at
|
4396
4449
|
# Only include resource versions that were current at some point during the time
|
4397
4450
|
# period specified in the date time value. The date parameter format is yyyy-mm-
|
@@ -4459,7 +4512,7 @@ module Google
|
|
4459
4512
|
# resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
4460
4513
|
# patching_a_fhir_resource).
|
4461
4514
|
# @param [String] name
|
4462
|
-
# The name of the resource to update.
|
4515
|
+
# Required. The name of the resource to update.
|
4463
4516
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4464
4517
|
# @param [String] fields
|
4465
4518
|
# Selector specifying which fields to include in a partial response.
|
@@ -4507,7 +4560,7 @@ module Google
|
|
4507
4560
|
# Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
4508
4561
|
# resources#getting_a_fhir_resource).
|
4509
4562
|
# @param [String] name
|
4510
|
-
# The name of the resource to retrieve.
|
4563
|
+
# Required. The name of the resource to retrieve.
|
4511
4564
|
# @param [String] fields
|
4512
4565
|
# Selector specifying which fields to include in a partial response.
|
4513
4566
|
# @param [String] quota_user
|
@@ -4598,7 +4651,7 @@ module Google
|
|
4598
4651
|
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
4599
4652
|
# healthcare/docs/how-tos/fhir-advanced-search).
|
4600
4653
|
# @param [String] parent
|
4601
|
-
# Name of the FHIR store to retrieve resources from.
|
4654
|
+
# Required. Name of the FHIR store to retrieve resources from.
|
4602
4655
|
# @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
|
4603
4656
|
# @param [String] fields
|
4604
4657
|
# Selector specifying which fields to include in a partial response.
|
@@ -4692,13 +4745,13 @@ module Google
|
|
4692
4745
|
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
4693
4746
|
# healthcare/docs/how-tos/fhir-advanced-search).
|
4694
4747
|
# @param [String] parent
|
4695
|
-
# Name of the FHIR store to retrieve resources from.
|
4748
|
+
# Required. Name of the FHIR store to retrieve resources from.
|
4696
4749
|
# @param [String] resource_type
|
4697
|
-
# The FHIR resource type to search, such as Patient or Observation.
|
4698
|
-
# complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/
|
4699
|
-
# standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/
|
4700
|
-
# standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/
|
4701
|
-
# standards/fhir/R4/resourcelist.html)).
|
4750
|
+
# Required. The FHIR resource type to search, such as Patient or Observation.
|
4751
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/
|
4752
|
+
# implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/
|
4753
|
+
# implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/
|
4754
|
+
# implement/standards/fhir/R4/resourcelist.html)).
|
4702
4755
|
# @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
|
4703
4756
|
# @param [String] fields
|
4704
4757
|
# Selector specifying which fields to include in a partial response.
|
@@ -4752,7 +4805,7 @@ module Google
|
|
4752
4805
|
# resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
4753
4806
|
# updating_a_fhir_resource).
|
4754
4807
|
# @param [String] name
|
4755
|
-
# The name of the resource to update.
|
4808
|
+
# Required. The name of the resource to update.
|
4756
4809
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4757
4810
|
# @param [String] fields
|
4758
4811
|
# Selector specifying which fields to include in a partial response.
|
@@ -4796,7 +4849,7 @@ module Google
|
|
4796
4849
|
# google.com/healthcare/docs/how-tos/fhir-resources#
|
4797
4850
|
# retrieving_a_fhir_resource_version).
|
4798
4851
|
# @param [String] name
|
4799
|
-
# The name of the resource version to retrieve.
|
4852
|
+
# Required. The name of the resource version to retrieve.
|
4800
4853
|
# @param [String] fields
|
4801
4854
|
# Selector specifying which fields to include in a partial response.
|
4802
4855
|
# @param [String] quota_user
|