google-apis-healthcare_v1beta1 0.74.0 → 0.76.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 +9 -0
- data/lib/google/apis/healthcare_v1beta1/classes.rb +64 -7
- data/lib/google/apis/healthcare_v1beta1/gem_version.rb +3 -3
- data/lib/google/apis/healthcare_v1beta1/representations.rb +30 -0
- data/lib/google/apis/healthcare_v1beta1/service.rb +247 -4
- metadata +4 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ea43ea7a85405e088c9b6b6769f553e02f8bec775e808b55d4dbd4d98a985830
|
4
|
+
data.tar.gz: b25ff5d767116022c1188f1532f38037b3bf053743183c869bd402bc6ba3344e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 99f7ba9276464a16a818302b57a7e3fcba79f848b0fa4d1b1cf78a27e9355b77aaf12972cce15c650b23a4beacd27e83aabfee645ffad672978ac3471099ebb4
|
7
|
+
data.tar.gz: 33ceeb689ea6fbb4a4fff93ae01119207737fe4fac059b2deb8e73c5e62281254744e4c81dade906071f056e06442d8f0875087872ef6bf8b7409bdc4c6e28ca
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,14 @@
|
|
1
1
|
# Release history for google-apis-healthcare_v1beta1
|
2
2
|
|
3
|
+
### v0.76.0 (2025-02-26)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250218
|
6
|
+
* Regenerated using generator version 0.16.0
|
7
|
+
|
8
|
+
### v0.75.0 (2024-12-15)
|
9
|
+
|
10
|
+
* Regenerated from discovery document revision 20241205
|
11
|
+
|
3
12
|
### v0.74.0 (2024-12-02)
|
4
13
|
|
5
14
|
* Regenerated from discovery document revision 20241115
|
@@ -965,6 +965,29 @@ module Google
|
|
965
965
|
end
|
966
966
|
end
|
967
967
|
|
968
|
+
# The configuration for exporting to Cloud Storage using the bulk export API.
|
969
|
+
class BulkExportGcsDestination
|
970
|
+
include Google::Apis::Core::Hashable
|
971
|
+
|
972
|
+
# Optional. URI for a Cloud Storage directory where the server writes result
|
973
|
+
# files, in the format `gs://`bucket-id`/`path/to/destination/dir``. If there is
|
974
|
+
# no trailing slash, the service appends one when composing the object path. The
|
975
|
+
# user is responsible for creating the Cloud Storage bucket referenced in `
|
976
|
+
# uri_prefix`.
|
977
|
+
# Corresponds to the JSON property `uriPrefix`
|
978
|
+
# @return [String]
|
979
|
+
attr_accessor :uri_prefix
|
980
|
+
|
981
|
+
def initialize(**args)
|
982
|
+
update!(**args)
|
983
|
+
end
|
984
|
+
|
985
|
+
# Update properties of this object
|
986
|
+
def update!(**args)
|
987
|
+
@uri_prefix = args[:uri_prefix] if args.key?(:uri_prefix)
|
988
|
+
end
|
989
|
+
end
|
990
|
+
|
968
991
|
# The request message for Operations.CancelOperation.
|
969
992
|
class CancelOperationRequest
|
970
993
|
include Google::Apis::Core::Hashable
|
@@ -1281,12 +1304,13 @@ module Google
|
|
1281
1304
|
attr_accessor :actor
|
1282
1305
|
|
1283
1306
|
# An abstract identifier that describes the environment or conditions under
|
1284
|
-
# which the accessor is acting.
|
1307
|
+
# which the accessor is acting. If it's not specified, it applies to all
|
1308
|
+
# environments.
|
1285
1309
|
# Corresponds to the JSON property `environment`
|
1286
1310
|
# @return [String]
|
1287
1311
|
attr_accessor :environment
|
1288
1312
|
|
1289
|
-
# The intent of data use.
|
1313
|
+
# The intent of data use. If it's not specified, it applies to all purposes.
|
1290
1314
|
# Corresponds to the JSON property `purpose`
|
1291
1315
|
# @return [String]
|
1292
1316
|
attr_accessor :purpose
|
@@ -1397,11 +1421,11 @@ module Google
|
|
1397
1421
|
# @return [Google::Apis::HealthcareV1beta1::ConsentHeaderHandling]
|
1398
1422
|
attr_accessor :consent_header_handling
|
1399
1423
|
|
1400
|
-
# The versioned names of the enforced admin Consent resource(s), in
|
1424
|
+
# Output only. The versioned names of the enforced admin Consent resource(s), in
|
1425
|
+
# the format `projects/`project_id`/locations/`location`/datasets/`dataset_id`/
|
1426
|
+
# fhirStores/`fhir_store_id`/fhir/Consent/`resource_id`/_history/`version_id``.
|
1427
|
+
# For FHIR stores with `disable_resource_versioning=true`, the format is `
|
1401
1428
|
# projects/`project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
|
1402
|
-
# fhir_store_id`/fhir/Consent/`resource_id`/_history/`version_id``. For FHIR
|
1403
|
-
# stores with `disable_resource_versioning=true`, the format is `projects/`
|
1404
|
-
# project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
|
1405
1429
|
# fhir_store_id`/fhir/Consent/`resource_id``. This field can only be updated
|
1406
1430
|
# using ApplyAdminConsents.
|
1407
1431
|
# Corresponds to the JSON property `enforcedAdminConsents`
|
@@ -3288,6 +3312,11 @@ module Google
|
|
3288
3312
|
class FhirStore
|
3289
3313
|
include Google::Apis::Core::Hashable
|
3290
3314
|
|
3315
|
+
# The configuration for exporting to Cloud Storage using the bulk export API.
|
3316
|
+
# Corresponds to the JSON property `bulkExportGcsDestination`
|
3317
|
+
# @return [Google::Apis::HealthcareV1beta1::BulkExportGcsDestination]
|
3318
|
+
attr_accessor :bulk_export_gcs_destination
|
3319
|
+
|
3291
3320
|
# Enable parsing of references within complex FHIR data types such as Extensions.
|
3292
3321
|
# If this value is set to ENABLED, then features like referential integrity and
|
3293
3322
|
# Bundle reference rewriting apply to all references. If this flag has not been
|
@@ -3430,6 +3459,7 @@ module Google
|
|
3430
3459
|
|
3431
3460
|
# Update properties of this object
|
3432
3461
|
def update!(**args)
|
3462
|
+
@bulk_export_gcs_destination = args[:bulk_export_gcs_destination] if args.key?(:bulk_export_gcs_destination)
|
3433
3463
|
@complex_data_type_reference_parsing = args[:complex_data_type_reference_parsing] if args.key?(:complex_data_type_reference_parsing)
|
3434
3464
|
@consent_config = args[:consent_config] if args.key?(:consent_config)
|
3435
3465
|
@default_search_handling_strict = args[:default_search_handling_strict] if args.key?(:default_search_handling_strict)
|
@@ -4172,6 +4202,11 @@ module Google
|
|
4172
4202
|
class GoogleCloudHealthcareV1beta1FhirBigQueryDestination
|
4173
4203
|
include Google::Apis::Core::Hashable
|
4174
4204
|
|
4205
|
+
# BigQuery Change Data Capture configuration.
|
4206
|
+
# Corresponds to the JSON property `changeDataCaptureConfig`
|
4207
|
+
# @return [Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirChangeDataCaptureConfig]
|
4208
|
+
attr_accessor :change_data_capture_config
|
4209
|
+
|
4175
4210
|
# BigQuery URI to an existing dataset, up to 2000 characters long, in the format
|
4176
4211
|
# `bq://projectId.bqDatasetId`.
|
4177
4212
|
# Corresponds to the JSON property `datasetUri`
|
@@ -4205,6 +4240,7 @@ module Google
|
|
4205
4240
|
|
4206
4241
|
# Update properties of this object
|
4207
4242
|
def update!(**args)
|
4243
|
+
@change_data_capture_config = args[:change_data_capture_config] if args.key?(:change_data_capture_config)
|
4208
4244
|
@dataset_uri = args[:dataset_uri] if args.key?(:dataset_uri)
|
4209
4245
|
@force = args[:force] if args.key?(:force)
|
4210
4246
|
@schema_config = args[:schema_config] if args.key?(:schema_config)
|
@@ -4212,6 +4248,27 @@ module Google
|
|
4212
4248
|
end
|
4213
4249
|
end
|
4214
4250
|
|
4251
|
+
# BigQuery Change Data Capture configuration.
|
4252
|
+
class GoogleCloudHealthcareV1beta1FhirChangeDataCaptureConfig
|
4253
|
+
include Google::Apis::Core::Hashable
|
4254
|
+
|
4255
|
+
# Optional. Configures how historical versions of FHIR resources will be
|
4256
|
+
# reflected in the destination table through updates and deletes. Defaults to `
|
4257
|
+
# HistoryMode.KEEP_LATEST_VERSION` if unspecified.
|
4258
|
+
# Corresponds to the JSON property `historyMode`
|
4259
|
+
# @return [String]
|
4260
|
+
attr_accessor :history_mode
|
4261
|
+
|
4262
|
+
def initialize(**args)
|
4263
|
+
update!(**args)
|
4264
|
+
end
|
4265
|
+
|
4266
|
+
# Update properties of this object
|
4267
|
+
def update!(**args)
|
4268
|
+
@history_mode = args[:history_mode] if args.key?(:history_mode)
|
4269
|
+
end
|
4270
|
+
end
|
4271
|
+
|
4215
4272
|
# Response when all resources export successfully. This structure is included in
|
4216
4273
|
# the response to describe the detailed outcome after the operation finishes
|
4217
4274
|
# successfully.
|
@@ -6877,7 +6934,7 @@ module Google
|
|
6877
6934
|
class SearchResourcesRequest
|
6878
6935
|
include Google::Apis::Core::Hashable
|
6879
6936
|
|
6880
|
-
#
|
6937
|
+
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
6881
6938
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
6882
6939
|
# implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
|
6883
6940
|
# implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
|
@@ -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.76.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.16.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20250218"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -178,6 +178,12 @@ module Google
|
|
178
178
|
include Google::Apis::Core::JsonObjectSupport
|
179
179
|
end
|
180
180
|
|
181
|
+
class BulkExportGcsDestination
|
182
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
|
+
|
184
|
+
include Google::Apis::Core::JsonObjectSupport
|
185
|
+
end
|
186
|
+
|
181
187
|
class CancelOperationRequest
|
182
188
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
189
|
|
@@ -718,6 +724,12 @@ module Google
|
|
718
724
|
include Google::Apis::Core::JsonObjectSupport
|
719
725
|
end
|
720
726
|
|
727
|
+
class GoogleCloudHealthcareV1beta1FhirChangeDataCaptureConfig
|
728
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
729
|
+
|
730
|
+
include Google::Apis::Core::JsonObjectSupport
|
731
|
+
end
|
732
|
+
|
721
733
|
class GoogleCloudHealthcareV1beta1FhirExportResourcesResponse
|
722
734
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
723
735
|
|
@@ -1638,6 +1650,13 @@ module Google
|
|
1638
1650
|
end
|
1639
1651
|
end
|
1640
1652
|
|
1653
|
+
class BulkExportGcsDestination
|
1654
|
+
# @private
|
1655
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1656
|
+
property :uri_prefix, as: 'uriPrefix'
|
1657
|
+
end
|
1658
|
+
end
|
1659
|
+
|
1641
1660
|
class CancelOperationRequest
|
1642
1661
|
# @private
|
1643
1662
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2281,6 +2300,8 @@ module Google
|
|
2281
2300
|
class FhirStore
|
2282
2301
|
# @private
|
2283
2302
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2303
|
+
property :bulk_export_gcs_destination, as: 'bulkExportGcsDestination', class: Google::Apis::HealthcareV1beta1::BulkExportGcsDestination, decorator: Google::Apis::HealthcareV1beta1::BulkExportGcsDestination::Representation
|
2304
|
+
|
2284
2305
|
property :complex_data_type_reference_parsing, as: 'complexDataTypeReferenceParsing'
|
2285
2306
|
property :consent_config, as: 'consentConfig', class: Google::Apis::HealthcareV1beta1::ConsentConfig, decorator: Google::Apis::HealthcareV1beta1::ConsentConfig::Representation
|
2286
2307
|
|
@@ -2498,6 +2519,8 @@ module Google
|
|
2498
2519
|
class GoogleCloudHealthcareV1beta1FhirBigQueryDestination
|
2499
2520
|
# @private
|
2500
2521
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2522
|
+
property :change_data_capture_config, as: 'changeDataCaptureConfig', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirChangeDataCaptureConfig, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirChangeDataCaptureConfig::Representation
|
2523
|
+
|
2501
2524
|
property :dataset_uri, as: 'datasetUri'
|
2502
2525
|
property :force, as: 'force'
|
2503
2526
|
property :schema_config, as: 'schemaConfig', class: Google::Apis::HealthcareV1beta1::SchemaConfig, decorator: Google::Apis::HealthcareV1beta1::SchemaConfig::Representation
|
@@ -2506,6 +2529,13 @@ module Google
|
|
2506
2529
|
end
|
2507
2530
|
end
|
2508
2531
|
|
2532
|
+
class GoogleCloudHealthcareV1beta1FhirChangeDataCaptureConfig
|
2533
|
+
# @private
|
2534
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2535
|
+
property :history_mode, as: 'historyMode'
|
2536
|
+
end
|
2537
|
+
end
|
2538
|
+
|
2509
2539
|
class GoogleCloudHealthcareV1beta1FhirExportResourcesResponse
|
2510
2540
|
# @private
|
2511
2541
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -4095,6 +4095,9 @@ module Google
|
|
4095
4095
|
# Required. The path of the RetrieveRenderedInstance DICOMweb request. For
|
4096
4096
|
# example, `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
|
4097
4097
|
# rendered`.
|
4098
|
+
# @param [String] viewport
|
4099
|
+
# Optional. The viewport setting to use as specified in https://dicom.nema.org/
|
4100
|
+
# medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3
|
4098
4101
|
# @param [String] fields
|
4099
4102
|
# Selector specifying which fields to include in a partial response.
|
4100
4103
|
# @param [String] quota_user
|
@@ -4112,12 +4115,13 @@ module Google
|
|
4112
4115
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4113
4116
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4114
4117
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4115
|
-
def retrieve_project_location_dataset_dicom_store_study_series_instance_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
4118
|
+
def retrieve_project_location_dataset_dicom_store_study_series_instance_rendered(parent, dicom_web_path, viewport: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4116
4119
|
command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
4117
4120
|
command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
|
4118
4121
|
command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
|
4119
4122
|
command.params['parent'] = parent unless parent.nil?
|
4120
4123
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
4124
|
+
command.query['viewport'] = viewport unless viewport.nil?
|
4121
4125
|
command.query['fields'] = fields unless fields.nil?
|
4122
4126
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4123
4127
|
execute_or_queue_command(command, &block)
|
@@ -4228,6 +4232,9 @@ module Google
|
|
4228
4232
|
# Required. The path of the RetrieveRenderedFrames DICOMweb request. For example,
|
4229
4233
|
# `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
|
4230
4234
|
# frame_list`/rendered`.
|
4235
|
+
# @param [String] viewport
|
4236
|
+
# Optional. The viewport setting to use as specified in https://dicom.nema.org/
|
4237
|
+
# medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3
|
4231
4238
|
# @param [String] fields
|
4232
4239
|
# Selector specifying which fields to include in a partial response.
|
4233
4240
|
# @param [String] quota_user
|
@@ -4245,12 +4252,13 @@ module Google
|
|
4245
4252
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4246
4253
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4247
4254
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4248
|
-
def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
4255
|
+
def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_rendered(parent, dicom_web_path, viewport: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4249
4256
|
command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
4250
4257
|
command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
|
4251
4258
|
command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
|
4252
4259
|
command.params['parent'] = parent unless parent.nil?
|
4253
4260
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
4261
|
+
command.query['viewport'] = viewport unless viewport.nil?
|
4254
4262
|
command.query['fields'] = fields unless fields.nil?
|
4255
4263
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4256
4264
|
execute_or_queue_command(command, &block)
|
@@ -4351,6 +4359,94 @@ module Google
|
|
4351
4359
|
execute_or_queue_command(command, &block)
|
4352
4360
|
end
|
4353
4361
|
|
4362
|
+
# Bulk exports a Group resource and resources in the member field, including
|
4363
|
+
# related resources for each Patient member. The export for each Patient is
|
4364
|
+
# identical to a GetPatientEverything request. Implements the FHIR
|
4365
|
+
# implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/
|
4366
|
+
# bulk-data/export.html#endpoint---group-of-patients). The following headers
|
4367
|
+
# must be set in the request: * `Accept`: specifies the format of the `
|
4368
|
+
# OperationOutcome` response. Only `application/fhir+json` is supported. * `
|
4369
|
+
# Prefer`: specifies whether the response is immediate or asynchronous. Must be
|
4370
|
+
# to `respond-async` because only asynchronous responses are supported. Specify
|
4371
|
+
# the destination for the server to write result files by setting the Cloud
|
4372
|
+
# Storage location bulk_export_gcs_destination on the FHIR store. URI of an
|
4373
|
+
# existing Cloud Storage directory where the server writes result files, in the
|
4374
|
+
# format gs://`bucket-id`/`path/to/destination/dir`. If there is no trailing
|
4375
|
+
# slash, the service appends one when composing the object path. The user is
|
4376
|
+
# responsible for creating the Cloud Storage bucket referenced. Supports the
|
4377
|
+
# following query parameters: * `_type`: string of comma-delimited FHIR resource
|
4378
|
+
# types. If provided, only resources of the specified type(s) are exported. * `
|
4379
|
+
# _since`: if provided, only resources updated after the specified time are
|
4380
|
+
# exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON
|
4381
|
+
# format. Exported file names use the format: `export_id`_`resource_type`.ndjson.
|
4382
|
+
# * `organizeOutputBy`: resource type to organize the output by. Required and
|
4383
|
+
# must be set to `Patient`. When specified, output files are organized by
|
4384
|
+
# instances of the specified resource type, including the resource, referenced
|
4385
|
+
# resources, and resources that contain references to that resource. On success,
|
4386
|
+
# the `Content-Location` header of response is set to a URL that you can use to
|
4387
|
+
# query the status of the export. The URL is in the format `projects/`project_id`
|
4388
|
+
# /locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id`/
|
4389
|
+
# operations/`export_id``. See get-fhir-operation-status for more information.
|
4390
|
+
# Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome`
|
4391
|
+
# resource describing the reason for the error.
|
4392
|
+
# @param [String] name
|
4393
|
+
# Required. Name of the `Group` resource that is exported, in format `projects/`
|
4394
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
4395
|
+
# fhir_store_id`/fhir/Group/`group_id``.
|
4396
|
+
# @param [String] _since
|
4397
|
+
# Optional. If provided, only resources updated after this time are exported.
|
4398
|
+
# The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-
|
4399
|
+
# 07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified
|
4400
|
+
# to the second and include a time zone.
|
4401
|
+
# @param [String] _type
|
4402
|
+
# Optional. String of comma-delimited FHIR resource types. If provided, only
|
4403
|
+
# resources of the specified resource type(s) are exported.
|
4404
|
+
# @param [String] organize_output_by
|
4405
|
+
# Optional. Required. The FHIR resource type used to organize exported resources.
|
4406
|
+
# Only supports "Patient". When organized by Patient resource, output files are
|
4407
|
+
# grouped as follows: * Patient file(s) containing the Patient resources. Each
|
4408
|
+
# Patient is sequentially followed by all resources the Patient references, and
|
4409
|
+
# all resources that reference the Patient (equivalent to a GetPatientEverything
|
4410
|
+
# request). * Individual files grouped by resource type for resources in the
|
4411
|
+
# Group's member field and the Group resource itself. Resources may be
|
4412
|
+
# duplicated across multiple Patients. For example, if two Patient resources
|
4413
|
+
# reference the same Organization resource, it will appear twice, once after
|
4414
|
+
# each Patient. The Group resource from the request does not appear in the
|
4415
|
+
# Patient files.
|
4416
|
+
# @param [String] output_format
|
4417
|
+
# Optional. Output format of the export. This field is optional and only `
|
4418
|
+
# application/fhir+ndjson` is supported.
|
4419
|
+
# @param [String] fields
|
4420
|
+
# Selector specifying which fields to include in a partial response.
|
4421
|
+
# @param [String] quota_user
|
4422
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4423
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4424
|
+
# @param [Google::Apis::RequestOptions] options
|
4425
|
+
# Request-specific options
|
4426
|
+
#
|
4427
|
+
# @yield [result, err] Result & error if block supplied
|
4428
|
+
# @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object
|
4429
|
+
# @yieldparam err [StandardError] error object if request failed
|
4430
|
+
#
|
4431
|
+
# @return [Google::Apis::HealthcareV1beta1::HttpBody]
|
4432
|
+
#
|
4433
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4434
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4435
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4436
|
+
def bulk_project_location_dataset_fhir_store_export_group(name, _since: nil, _type: nil, organize_output_by: nil, output_format: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4437
|
+
command = make_simple_command(:get, 'v1beta1/{+name}/$export', options)
|
4438
|
+
command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
|
4439
|
+
command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
|
4440
|
+
command.params['name'] = name unless name.nil?
|
4441
|
+
command.query['_since'] = _since unless _since.nil?
|
4442
|
+
command.query['_type'] = _type unless _type.nil?
|
4443
|
+
command.query['organizeOutputBy'] = organize_output_by unless organize_output_by.nil?
|
4444
|
+
command.query['outputFormat'] = output_format unless output_format.nil?
|
4445
|
+
command.query['fields'] = fields unless fields.nil?
|
4446
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4447
|
+
execute_or_queue_command(command, &block)
|
4448
|
+
end
|
4449
|
+
|
4354
4450
|
# Configure the search parameters for the FHIR store and reindex resources in
|
4355
4451
|
# the FHIR store according to the defined search parameters. The search
|
4356
4452
|
# parameters provided in this request will replace any previous search
|
@@ -5810,7 +5906,7 @@ module Google
|
|
5810
5906
|
# provided content.
|
5811
5907
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
5812
5908
|
# @param [String] profile
|
5813
|
-
#
|
5909
|
+
# Optional. The canonical URL of a profile that this resource should be
|
5814
5910
|
# validated against. For example, to validate a Patient resource against the US
|
5815
5911
|
# Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/
|
5816
5912
|
# StructureDefinition/us-core-patient`. A StructureDefinition with this
|
@@ -5846,6 +5942,76 @@ module Google
|
|
5846
5942
|
execute_or_queue_command(command, &block)
|
5847
5943
|
end
|
5848
5944
|
|
5945
|
+
# Bulk exports all resources from the FHIR store to the specified destination.
|
5946
|
+
# Implements the FHIR implementation guide [system level $export](https://build.
|
5947
|
+
# fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The
|
5948
|
+
# following headers must be set in the request: * `Accept`: specifies the format
|
5949
|
+
# of the `OperationOutcome` response. Only `application/fhir+json` is supported.
|
5950
|
+
# * `Prefer`: specifies whether the response is immediate or asynchronous. Must
|
5951
|
+
# be to `respond-async` because only asynchronous responses are supported.
|
5952
|
+
# Specify the destination for the server to write result files by setting the
|
5953
|
+
# Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of
|
5954
|
+
# an existing Cloud Storage directory where the server writes result files, in
|
5955
|
+
# the format gs://`bucket-id`/`path/to/destination/dir`. If there is no trailing
|
5956
|
+
# slash, the service appends one when composing the object path. The user is
|
5957
|
+
# responsible for creating the Cloud Storage bucket referenced. Supports the
|
5958
|
+
# following query parameters: * `_type`: string of comma-delimited FHIR resource
|
5959
|
+
# types. If provided, only the resources of the specified type(s) are exported. *
|
5960
|
+
# `_since`: if provided, only the resources that are updated after the
|
5961
|
+
# specified time are exported. * `_outputFormat`: optional, specify ndjson to
|
5962
|
+
# export data in NDJSON format. Exported file names use the format: `export_id`_`
|
5963
|
+
# resource_type`.ndjson. On success, the `Content-Location` header of the
|
5964
|
+
# response is set to a URL that the user can use to query the status of the
|
5965
|
+
# export. The URL is in the format: `projects/`project_id`/locations/`
|
5966
|
+
# location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id`/operations/`
|
5967
|
+
# export_id``. See get-fhir-operation-status for more information. Errors
|
5968
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
5969
|
+
# describing the reason for the error.
|
5970
|
+
# @param [String] name
|
5971
|
+
# Required. The name of the FHIR store to export resources from, in the format `
|
5972
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
|
5973
|
+
# `fhir_store_id``.
|
5974
|
+
# @param [String] _since
|
5975
|
+
# Optional. If provided, only resources updated after this time are exported.
|
5976
|
+
# The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-
|
5977
|
+
# 07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified
|
5978
|
+
# to the second and include a time zone.
|
5979
|
+
# @param [String] _type
|
5980
|
+
# Optional. String of comma-delimited FHIR resource types. If provided, only
|
5981
|
+
# resources of the specified resource type(s) are exported.
|
5982
|
+
# @param [String] output_format
|
5983
|
+
# Optional. Output format of the export. This field is optional and only `
|
5984
|
+
# application/fhir+ndjson` is supported.
|
5985
|
+
# @param [String] fields
|
5986
|
+
# Selector specifying which fields to include in a partial response.
|
5987
|
+
# @param [String] quota_user
|
5988
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5989
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5990
|
+
# @param [Google::Apis::RequestOptions] options
|
5991
|
+
# Request-specific options
|
5992
|
+
#
|
5993
|
+
# @yield [result, err] Result & error if block supplied
|
5994
|
+
# @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object
|
5995
|
+
# @yieldparam err [StandardError] error object if request failed
|
5996
|
+
#
|
5997
|
+
# @return [Google::Apis::HealthcareV1beta1::HttpBody]
|
5998
|
+
#
|
5999
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6000
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6001
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6002
|
+
def bulk_project_location_dataset_fhir_store_fhir_export(name, _since: nil, _type: nil, output_format: nil, fields: nil, quota_user: nil, options: nil, &block)
|
6003
|
+
command = make_simple_command(:get, 'v1beta1/{+name}/fhir/$export', options)
|
6004
|
+
command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
|
6005
|
+
command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
|
6006
|
+
command.params['name'] = name unless name.nil?
|
6007
|
+
command.query['_since'] = _since unless _since.nil?
|
6008
|
+
command.query['_type'] = _type unless _type.nil?
|
6009
|
+
command.query['outputFormat'] = output_format unless output_format.nil?
|
6010
|
+
command.query['fields'] = fields unless fields.nil?
|
6011
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6012
|
+
execute_or_queue_command(command, &block)
|
6013
|
+
end
|
6014
|
+
|
5849
6015
|
# Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/
|
5850
6016
|
# fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/
|
5851
6017
|
# fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.
|
@@ -6556,7 +6722,7 @@ module Google
|
|
6556
6722
|
# @param [String] parent
|
6557
6723
|
# Required. Name of the FHIR store to retrieve resources from.
|
6558
6724
|
# @param [String] resource_type
|
6559
|
-
#
|
6725
|
+
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
6560
6726
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
6561
6727
|
# implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
|
6562
6728
|
# implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
|
@@ -6686,6 +6852,83 @@ module Google
|
|
6686
6852
|
execute_or_queue_command(command, &block)
|
6687
6853
|
end
|
6688
6854
|
|
6855
|
+
# Deletes operations as defined in the FHIR specification. Implements the FHIR
|
6856
|
+
# implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/
|
6857
|
+
# bulk-data/export.html#bulk-data-delete-request). Returns success if the
|
6858
|
+
# operation was successfully cancelled. If the operation is complete, or has
|
6859
|
+
# already been cancelled, returns an error response.
|
6860
|
+
# @param [String] name
|
6861
|
+
# Required. Name of the operation to be deleted, in the format `projects/`
|
6862
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
6863
|
+
# fhir_store_id`/operations/`operation_id``.
|
6864
|
+
# @param [String] fields
|
6865
|
+
# Selector specifying which fields to include in a partial response.
|
6866
|
+
# @param [String] quota_user
|
6867
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6868
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6869
|
+
# @param [Google::Apis::RequestOptions] options
|
6870
|
+
# Request-specific options
|
6871
|
+
#
|
6872
|
+
# @yield [result, err] Result & error if block supplied
|
6873
|
+
# @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object
|
6874
|
+
# @yieldparam err [StandardError] error object if request failed
|
6875
|
+
#
|
6876
|
+
# @return [Google::Apis::HealthcareV1beta1::HttpBody]
|
6877
|
+
#
|
6878
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6879
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6880
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6881
|
+
def delete_project_location_dataset_fhir_store_operation_fhir_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
6882
|
+
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
6883
|
+
command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
|
6884
|
+
command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
|
6885
|
+
command.params['name'] = name unless name.nil?
|
6886
|
+
command.query['fields'] = fields unless fields.nil?
|
6887
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6888
|
+
execute_or_queue_command(command, &block)
|
6889
|
+
end
|
6890
|
+
|
6891
|
+
# Gets the status of operations as defined in the FHIR specification. Implements
|
6892
|
+
# the FHIR implementation guide [bulk data status request](https://build.fhir.
|
6893
|
+
# org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can
|
6894
|
+
# have one of these states: * in-progress: response status code is `202` and `X-
|
6895
|
+
# Progress` header is set to `in progress`. * complete: response status code is `
|
6896
|
+
# 200` and the body is a JSON-encoded operation response as defined by the spec.
|
6897
|
+
# For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/
|
6898
|
+
# bulk-data/export.html#response---complete-status. * error: response status
|
6899
|
+
# code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource
|
6900
|
+
# describing the reason for the error.
|
6901
|
+
# @param [String] name
|
6902
|
+
# Required. Name of the operation to query, in the format `projects/`project_id`/
|
6903
|
+
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id`/
|
6904
|
+
# operations/`operation_id``.
|
6905
|
+
# @param [String] fields
|
6906
|
+
# Selector specifying which fields to include in a partial response.
|
6907
|
+
# @param [String] quota_user
|
6908
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6909
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6910
|
+
# @param [Google::Apis::RequestOptions] options
|
6911
|
+
# Request-specific options
|
6912
|
+
#
|
6913
|
+
# @yield [result, err] Result & error if block supplied
|
6914
|
+
# @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object
|
6915
|
+
# @yieldparam err [StandardError] error object if request failed
|
6916
|
+
#
|
6917
|
+
# @return [Google::Apis::HealthcareV1beta1::HttpBody]
|
6918
|
+
#
|
6919
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6920
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6921
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6922
|
+
def get_project_location_dataset_fhir_store_operation_fhir_operation_status(name, fields: nil, quota_user: nil, options: nil, &block)
|
6923
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
6924
|
+
command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
|
6925
|
+
command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
|
6926
|
+
command.params['name'] = name unless name.nil?
|
6927
|
+
command.query['fields'] = fields unless fields.nil?
|
6928
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6929
|
+
execute_or_queue_command(command, &block)
|
6930
|
+
end
|
6931
|
+
|
6689
6932
|
# Creates a new HL7v2 store within the parent dataset.
|
6690
6933
|
# @param [String] parent
|
6691
6934
|
# Required. The name of the dataset this HL7v2 store belongs to.
|
metadata
CHANGED
@@ -1,14 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-healthcare_v1beta1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.76.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
|
-
autorequire:
|
9
8
|
bindir: bin
|
10
9
|
cert_chain: []
|
11
|
-
date:
|
10
|
+
date: 2025-03-02 00:00:00.000000000 Z
|
12
11
|
dependencies:
|
13
12
|
- !ruby/object:Gem::Dependency
|
14
13
|
name: google-apis-core
|
@@ -58,9 +57,8 @@ licenses:
|
|
58
57
|
metadata:
|
59
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1beta1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.76.0
|
62
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1beta1
|
63
|
-
post_install_message:
|
64
62
|
rdoc_options: []
|
65
63
|
require_paths:
|
66
64
|
- lib
|
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
73
|
- !ruby/object:Gem::Version
|
76
74
|
version: '0'
|
77
75
|
requirements: []
|
78
|
-
rubygems_version: 3.5
|
79
|
-
signing_key:
|
76
|
+
rubygems_version: 3.6.5
|
80
77
|
specification_version: 4
|
81
78
|
summary: Simple REST client for Cloud Healthcare API V1beta1
|
82
79
|
test_files: []
|