google-apis-healthcare_v1 0.75.0 → 0.77.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
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3bd20dfe2824ea547cc7236fae21ed0a346c8a57ea1d5b4d5e3f6ab826660701
|
4
|
+
data.tar.gz: 3fb06aa819a9df21135909c3fb81dbcf7ce47e83e7a6a420b84e08dd8e635251
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: da22b71f279d69145e988a0bd08a8d81960b2170935b973b4d4fea587d0d19e9180f699593b8cfe1eb2de553a2c08498f522c458cd6a6120372d7055b06b97e9
|
7
|
+
data.tar.gz: 9db8c747d018377409d5c34602ff48b45e210bee83b0163ad57b45733e71b24b2d05f15775dad099a05deb4044fdd43beb9f14a5f8162a9b0e8a1c6b91ef340c
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,14 @@
|
|
1
1
|
# Release history for google-apis-healthcare_v1
|
2
2
|
|
3
|
+
### v0.77.0 (2025-07-27)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250625
|
6
|
+
|
7
|
+
### v0.76.0 (2025-06-08)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20250526
|
10
|
+
* Regenerated using generator version 0.18.0
|
11
|
+
|
3
12
|
### v0.75.0 (2025-05-18)
|
4
13
|
|
5
14
|
* Regenerated from discovery document revision 20250430
|
@@ -1683,6 +1683,56 @@ module Google
|
|
1683
1683
|
end
|
1684
1684
|
end
|
1685
1685
|
|
1686
|
+
# Contains the configuration for DICOM notifications.
|
1687
|
+
class DicomNotificationConfig
|
1688
|
+
include Google::Apis::Core::Hashable
|
1689
|
+
|
1690
|
+
# Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that
|
1691
|
+
# notifications of changes are published on. Supplied by the client. The
|
1692
|
+
# notification is a `PubsubMessage` with the following fields: * `PubsubMessage.
|
1693
|
+
# Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of
|
1694
|
+
# this notification. It is guaranteed to be unique within the topic. * `
|
1695
|
+
# PubsubMessage.PublishTime` is the time when the message was published. * `
|
1696
|
+
# PubsubMessage.Attributes` contains the following attributes: * `action`: The
|
1697
|
+
# name of the endpoint that generated the notification. Possible values are `
|
1698
|
+
# StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`
|
1699
|
+
# : The latest timestamp when the DICOM instance was updated. * `storeName`: The
|
1700
|
+
# resource name of the DICOM store, of the form `projects/`project_id`/locations/
|
1701
|
+
# `location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``. * `
|
1702
|
+
# studyInstanceUID`: The study UID of the DICOM instance that was changed. * `
|
1703
|
+
# seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `
|
1704
|
+
# sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `
|
1705
|
+
# versionId`: The version ID of the DICOM instance that was changed. * `modality`
|
1706
|
+
# : The modality tag of the DICOM instance that was changed. * `
|
1707
|
+
# previousStorageClass`: The storage class where the DICOM instance was
|
1708
|
+
# previously stored if the storage class was changed. * `storageClass`: The
|
1709
|
+
# storage class where the DICOM instance is currently stored. Note that
|
1710
|
+
# notifications are only sent if the topic is non-empty. [Topic names](https://
|
1711
|
+
# cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The
|
1712
|
+
# Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.
|
1713
|
+
# gserviceaccount.com, must have the `pubsub.topics.publish` permission (which
|
1714
|
+
# is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub
|
1715
|
+
# topic. Not having adequate permissions causes the calls that send
|
1716
|
+
# notifications to fail (https://cloud.google.com/healthcare-api/docs/
|
1717
|
+
# permissions-healthcare-api-gcp-products#
|
1718
|
+
# dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't
|
1719
|
+
# be published to Pub/Sub, errors are logged to Cloud Logging. For more
|
1720
|
+
# information, see [Viewing error logs in Cloud Logging](https://cloud.google.
|
1721
|
+
# com/healthcare-api/docs/how-tos/logging).
|
1722
|
+
# Corresponds to the JSON property `pubsubTopic`
|
1723
|
+
# @return [String]
|
1724
|
+
attr_accessor :pubsub_topic
|
1725
|
+
|
1726
|
+
def initialize(**args)
|
1727
|
+
update!(**args)
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# Update properties of this object
|
1731
|
+
def update!(**args)
|
1732
|
+
@pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
|
1733
|
+
end
|
1734
|
+
end
|
1735
|
+
|
1686
1736
|
# Represents a DICOM store.
|
1687
1737
|
class DicomStore
|
1688
1738
|
include Google::Apis::Core::Hashable
|
@@ -1710,6 +1760,12 @@ module Google
|
|
1710
1760
|
# @return [Google::Apis::HealthcareV1::NotificationConfig]
|
1711
1761
|
attr_accessor :notification_config
|
1712
1762
|
|
1763
|
+
# Optional. Specifies where and whether to send notifications upon changes to a
|
1764
|
+
# DICOM store.
|
1765
|
+
# Corresponds to the JSON property `notificationConfigs`
|
1766
|
+
# @return [Array<Google::Apis::HealthcareV1::DicomNotificationConfig>]
|
1767
|
+
attr_accessor :notification_configs
|
1768
|
+
|
1713
1769
|
# Optional. A list of streaming configs used to configure the destination of
|
1714
1770
|
# streaming exports for every DICOM instance insertion in this DICOM store.
|
1715
1771
|
# After a new config is added to `stream_configs`, DICOM instance insertions are
|
@@ -1729,6 +1785,7 @@ module Google
|
|
1729
1785
|
@labels = args[:labels] if args.key?(:labels)
|
1730
1786
|
@name = args[:name] if args.key?(:name)
|
1731
1787
|
@notification_config = args[:notification_config] if args.key?(:notification_config)
|
1788
|
+
@notification_configs = args[:notification_configs] if args.key?(:notification_configs)
|
1732
1789
|
@stream_configs = args[:stream_configs] if args.key?(:stream_configs)
|
1733
1790
|
end
|
1734
1791
|
end
|
@@ -2589,7 +2646,7 @@ module Google
|
|
2589
2646
|
# references in complex data types will not be parsed. New stores will have this
|
2590
2647
|
# value set to ENABLED after a notification period. Warning: turning on this
|
2591
2648
|
# flag causes processing existing resources to fail if they contain references
|
2592
|
-
# to non-existent resources.
|
2649
|
+
# to non-existent resources. Cannot be disabled in R5.
|
2593
2650
|
# Corresponds to the JSON property `complexDataTypeReferenceParsing`
|
2594
2651
|
# @return [String]
|
2595
2652
|
attr_accessor :complex_data_type_reference_parsing
|
@@ -5406,7 +5463,8 @@ module Google
|
|
5406
5463
|
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
5407
5464
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
5408
5465
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
5409
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)).
|
5466
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)), [R5](https://hl7.org/fhir/R5/
|
5467
|
+
# resourcelist.html)).
|
5410
5468
|
# Corresponds to the JSON property `resourceType`
|
5411
5469
|
# @return [String]
|
5412
5470
|
attr_accessor :resource_type
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module HealthcareV1
|
18
18
|
# Version of the google-apis-healthcare_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.77.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.18.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20250625"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -292,6 +292,12 @@ module Google
|
|
292
292
|
include Google::Apis::Core::JsonObjectSupport
|
293
293
|
end
|
294
294
|
|
295
|
+
class DicomNotificationConfig
|
296
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
297
|
+
|
298
|
+
include Google::Apis::Core::JsonObjectSupport
|
299
|
+
end
|
300
|
+
|
295
301
|
class DicomStore
|
296
302
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
297
303
|
|
@@ -1493,6 +1499,13 @@ module Google
|
|
1493
1499
|
end
|
1494
1500
|
end
|
1495
1501
|
|
1502
|
+
class DicomNotificationConfig
|
1503
|
+
# @private
|
1504
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1505
|
+
property :pubsub_topic, as: 'pubsubTopic'
|
1506
|
+
end
|
1507
|
+
end
|
1508
|
+
|
1496
1509
|
class DicomStore
|
1497
1510
|
# @private
|
1498
1511
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1500,6 +1513,8 @@ module Google
|
|
1500
1513
|
property :name, as: 'name'
|
1501
1514
|
property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1::NotificationConfig, decorator: Google::Apis::HealthcareV1::NotificationConfig::Representation
|
1502
1515
|
|
1516
|
+
collection :notification_configs, as: 'notificationConfigs', class: Google::Apis::HealthcareV1::DicomNotificationConfig, decorator: Google::Apis::HealthcareV1::DicomNotificationConfig::Representation
|
1517
|
+
|
1503
1518
|
collection :stream_configs, as: 'streamConfigs', class: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomStreamConfig, decorator: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomStreamConfig::Representation
|
1504
1519
|
|
1505
1520
|
end
|
@@ -179,7 +179,8 @@ module Google
|
|
179
179
|
# logging).
|
180
180
|
# @param [String] source_dataset
|
181
181
|
# Required. Source dataset resource name. For example, `projects/`project_id`/
|
182
|
-
# locations/`location_id`/datasets/`dataset_id``.
|
182
|
+
# locations/`location_id`/datasets/`dataset_id``. R5 FHIR stores are not
|
183
|
+
# supported and will be skipped.
|
183
184
|
# @param [Google::Apis::HealthcareV1::DeidentifyDatasetRequest] deidentify_dataset_request_object
|
184
185
|
# @param [String] fields
|
185
186
|
# Selector specifying which fields to include in a partial response.
|
@@ -3467,6 +3468,50 @@ module Google
|
|
3467
3468
|
execute_or_queue_command(command, &block)
|
3468
3469
|
end
|
3469
3470
|
|
3471
|
+
# Returns uncompressed, unencoded bytes representing the referenced bulkdata tag
|
3472
|
+
# from an instance. See [Retrieve Transaction] (http://dicom.nema.org/medical/
|
3473
|
+
# dicom/current/output/html/part18.html#sect_10.4)`: .external`. For details on
|
3474
|
+
# the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.
|
3475
|
+
# google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare
|
3476
|
+
# API conformance statement. For samples that show how to call RetrieveBulkdata,
|
3477
|
+
# see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/
|
3478
|
+
# dicomweb#retrieve-bulkdata).
|
3479
|
+
# @param [String] parent
|
3480
|
+
# Required. The name of the DICOM store that is being accessed. For example, `
|
3481
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
3482
|
+
# dicomStores/`dicom_store_id``.
|
3483
|
+
# @param [String] dicom_web_path
|
3484
|
+
# Required. The path for the `RetrieveBulkdata` DICOMweb request. For example, `
|
3485
|
+
# studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/bukdata/`
|
3486
|
+
# bulkdata_uri``.
|
3487
|
+
# @param [String] fields
|
3488
|
+
# Selector specifying which fields to include in a partial response.
|
3489
|
+
# @param [String] quota_user
|
3490
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3491
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3492
|
+
# @param [Google::Apis::RequestOptions] options
|
3493
|
+
# Request-specific options
|
3494
|
+
#
|
3495
|
+
# @yield [result, err] Result & error if block supplied
|
3496
|
+
# @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
|
3497
|
+
# @yieldparam err [StandardError] error object if request failed
|
3498
|
+
#
|
3499
|
+
# @return [Google::Apis::HealthcareV1::HttpBody]
|
3500
|
+
#
|
3501
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3502
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3503
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3504
|
+
def retrieve_project_location_dataset_dicom_store_study_series_instance_bulkdatum_bulkdata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
3505
|
+
command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
3506
|
+
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
3507
|
+
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
3508
|
+
command.params['parent'] = parent unless parent.nil?
|
3509
|
+
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
3510
|
+
command.query['fields'] = fields unless fields.nil?
|
3511
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3512
|
+
execute_or_queue_command(command, &block)
|
3513
|
+
end
|
3514
|
+
|
3470
3515
|
# RetrieveFrames returns instances associated with the given study, series, SOP
|
3471
3516
|
# Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.
|
3472
3517
|
# org/medical/dicom/current/output/html/part18.html#sect_10.4`. For details on
|
@@ -3574,7 +3619,7 @@ module Google
|
|
3574
3619
|
# instead of an Operation. No resources will be reindexed and the `
|
3575
3620
|
# consent_config.enforced_admin_consents` field will be unchanged. To enforce a
|
3576
3621
|
# consent check for data access, `consent_config.access_enforced` must be set to
|
3577
|
-
# true for the FhirStore.
|
3622
|
+
# true for the FhirStore. FHIR Consent is not supported in DSTU2 or R5.
|
3578
3623
|
# @param [String] name
|
3579
3624
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
3580
3625
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
@@ -3620,7 +3665,7 @@ module Google
|
|
3620
3665
|
# was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in
|
3621
3666
|
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To
|
3622
3667
|
# enforce consent check for data access, `consent_config.access_enforced` must
|
3623
|
-
# be set to true for the FhirStore.
|
3668
|
+
# be set to true for the FhirStore. FHIR Consent is not supported in DSTU2 or R5.
|
3624
3669
|
# @param [String] name
|
3625
3670
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
3626
3671
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
@@ -3788,7 +3833,8 @@ module Google
|
|
3788
3833
|
# how-tos/logging)).
|
3789
3834
|
# @param [String] source_store
|
3790
3835
|
# Required. Source FHIR store resource name. For example, `projects/`project_id`/
|
3791
|
-
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
|
3836
|
+
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. R5
|
3837
|
+
# stores are not supported.
|
3792
3838
|
# @param [Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object
|
3793
3839
|
# @param [String] fields
|
3794
3840
|
# Selector specifying which fields to include in a partial response.
|
@@ -3850,7 +3896,7 @@ module Google
|
|
3850
3896
|
end
|
3851
3897
|
|
3852
3898
|
# Explains all the permitted/denied actor, purpose and environment for a given
|
3853
|
-
# resource.
|
3899
|
+
# resource. FHIR Consent is not supported in DSTU2 or R5.
|
3854
3900
|
# @param [String] name
|
3855
3901
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
3856
3902
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
@@ -4349,24 +4395,24 @@ module Google
|
|
4349
4395
|
# zip archives, pdf files, documents). When a non-FHIR content type is used in
|
4350
4396
|
# the request, a Binary resource will be generated, and the uploaded data will
|
4351
4397
|
# be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`
|
4352
|
-
# R4`). The Binary resource's `contentType` will be filled in using the
|
4353
|
-
# the `Content-Type` header, and the `securityContext` field (not
|
4354
|
-
# DSTU2`) will be populated from the `X-Security-Context` header if
|
4355
|
-
# At this time `securityContext` has no special behavior in the Cloud
|
4356
|
-
# API. Note: the limit on data ingested through this method is 1 GB.
|
4357
|
-
# performance, use a non-FHIR data type instead of wrapping the data in
|
4358
|
-
# resource. Some of the Healthcare API features, such as [exporting to
|
4359
|
-
# https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-
|
4360
|
-
# Pub/Sub notifications](https://cloud.google.com/healthcare-api/
|
4361
|
-
# pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high)
|
4362
|
-
# full resource content, do not support Binary resources that are larger
|
4363
|
-
# MB. In these cases the resource's `data` field will be omitted.
|
4364
|
-
# http://hl7.org/fhir/StructureDefinition/data-absent-reason"
|
4365
|
-
# present to indicate that including the data is `unsupported`.
|
4366
|
-
# empty `201 Created` response is returned. The newly created
|
4367
|
-
# version are returned in the Location header. Using `Prefer:
|
4368
|
-
# resource` is not allowed for this method. The definition of the
|
4369
|
-
# API can be found at https://hl7.org/fhir/binary.html#rest.
|
4398
|
+
# R4` and `R5`). The Binary resource's `contentType` will be filled in using the
|
4399
|
+
# value of the `Content-Type` header, and the `securityContext` field (not
|
4400
|
+
# present in `DSTU2`) will be populated from the `X-Security-Context` header if
|
4401
|
+
# it exists. At this time `securityContext` has no special behavior in the Cloud
|
4402
|
+
# Healthcare API. Note: the limit on data ingested through this method is 1 GB.
|
4403
|
+
# For best performance, use a non-FHIR data type instead of wrapping the data in
|
4404
|
+
# a Binary resource. Some of the Healthcare API features, such as [exporting to
|
4405
|
+
# BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-
|
4406
|
+
# bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/
|
4407
|
+
# docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high)
|
4408
|
+
# with full resource content, do not support Binary resources that are larger
|
4409
|
+
# than 10 MB. In these cases the resource's `data` field will be omitted.
|
4410
|
+
# Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
|
4411
|
+
# extension will be present to indicate that including the data is `unsupported`.
|
4412
|
+
# On success, an empty `201 Created` response is returned. The newly created
|
4413
|
+
# resource's ID and version are returned in the Location header. Using `Prefer:
|
4414
|
+
# representation=resource` is not allowed for this method. The definition of the
|
4415
|
+
# Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
|
4370
4416
|
# @param [String] parent
|
4371
4417
|
# Required. The name of the FHIR store this resource belongs to.
|
4372
4418
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
@@ -4450,16 +4496,16 @@ module Google
|
|
4450
4496
|
# the same way as non-FHIR data. When a non-FHIR content type is used in the
|
4451
4497
|
# request, a Binary resource will be generated using the ID from the resource
|
4452
4498
|
# path, and the uploaded data will be stored in the `content` field (`DSTU2` and
|
4453
|
-
# `STU3`), or the `data` field (`R4`). The Binary resource's `
|
4454
|
-
# be filled in using the value of the `Content-Type` header,
|
4455
|
-
# securityContext` field (not present in `DSTU2`) will be populated
|
4456
|
-
# Security-Context` header if it exists. At this time `
|
4457
|
-
# special behavior in the Cloud Healthcare API. Note:
|
4458
|
-
# through this method is 2 GB. For best performance,
|
4459
|
-
# instead of wrapping the data in a Binary resource.
|
4460
|
-
# features, such as [exporting to BigQuery](https://
|
4461
|
-
# api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub
|
4462
|
-
# cloud.google.com/healthcare-api/docs/fhir-pubsub#
|
4499
|
+
# `STU3`), or the `data` field (`R4` and `R5`). The Binary resource's `
|
4500
|
+
# contentType` will be filled in using the value of the `Content-Type` header,
|
4501
|
+
# and the `securityContext` field (not present in `DSTU2`) will be populated
|
4502
|
+
# from the `X-Security-Context` header if it exists. At this time `
|
4503
|
+
# securityContext` has no special behavior in the Cloud Healthcare API. Note:
|
4504
|
+
# the limit on data ingested through this method is 2 GB. For best performance,
|
4505
|
+
# use a non-FHIR data type instead of wrapping the data in a Binary resource.
|
4506
|
+
# Some of the Healthcare API features, such as [exporting to BigQuery](https://
|
4507
|
+
# cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub
|
4508
|
+
# notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#
|
4463
4509
|
# behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full
|
4464
4510
|
# resource content, do not support Binary resources that are larger than 10 MB.
|
4465
4511
|
# In these cases the resource's `data` field will be omitted. Instead, the "http:
|
@@ -4627,18 +4673,20 @@ module Google
|
|
4627
4673
|
# the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/
|
4628
4674
|
# DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/
|
4629
4675
|
# patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-
|
4630
|
-
# operation-everything.html)
|
4631
|
-
#
|
4632
|
-
#
|
4633
|
-
#
|
4634
|
-
#
|
4635
|
-
#
|
4636
|
-
#
|
4637
|
-
#
|
4638
|
-
# patient resource
|
4639
|
-
#
|
4640
|
-
#
|
4641
|
-
# fhir/
|
4676
|
+
# operation-everything.html), [R5](https://hl7.org/fhir/R5/patient-operation-
|
4677
|
+
# everything.html)). On success, the response body contains a JSON-encoded
|
4678
|
+
# representation of a `Bundle` resource of type `searchset`, containing the
|
4679
|
+
# results of the operation. Errors generated by the FHIR store contain a JSON-
|
4680
|
+
# encoded `OperationOutcome` resource describing the reason for the error. If
|
4681
|
+
# the request cannot be mapped to a valid API method on a FHIR store, a generic
|
4682
|
+
# GCP error might be returned instead. The resources in scope for the response
|
4683
|
+
# are: * The patient resource itself. * All the resources directly referenced by
|
4684
|
+
# the patient resource. * Resources directly referencing the patient resource
|
4685
|
+
# that meet the inclusion criteria. The inclusion criteria are based on the
|
4686
|
+
# membership rules in the patient compartment definition ([DSTU2](http://hl7.org/
|
4687
|
+
# fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/
|
4688
|
+
# compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/
|
4689
|
+
# compartmentdefinition-patient.html), [R5](http://hl7.org/fhir/R5/
|
4642
4690
|
# compartmentdefinition-patient.html)), which details the eligible resource
|
4643
4691
|
# types and referencing search parameters. For samples that show how to call `
|
4644
4692
|
# Patient-everything`, see [Getting all patient compartment resources](https://
|
@@ -4746,26 +4794,26 @@ module Google
|
|
4746
4794
|
# Validates an input FHIR resource's conformance to its profiles and the
|
4747
4795
|
# profiles configured on the FHIR store. Implements the FHIR extended operation $
|
4748
4796
|
# validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate)
|
4749
|
-
# , [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate),
|
4750
|
-
# https://hl7.org/fhir/R4/resource-operation-validate.html)
|
4751
|
-
#
|
4752
|
-
#
|
4753
|
-
#
|
4754
|
-
#
|
4755
|
-
#
|
4756
|
-
#
|
4757
|
-
#
|
4758
|
-
#
|
4759
|
-
# instead.
|
4797
|
+
# , [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), [R4](
|
4798
|
+
# https://hl7.org/fhir/R4/resource-operation-validate.html). or [R5](https://hl7.
|
4799
|
+
# org/fhir/R5/resource-operation-validate.html)). The request body must contain
|
4800
|
+
# a JSON-encoded FHIR resource, and the request headers must contain `Content-
|
4801
|
+
# Type: application/fhir+json`. The `Parameters` input syntax is not supported.
|
4802
|
+
# The `profile` query parameter can be used to request that the resource only be
|
4803
|
+
# validated against a specific profile. If a profile with the given URL cannot
|
4804
|
+
# be found in the FHIR store then an error is returned. Errors generated by
|
4805
|
+
# validation contain a JSON-encoded `OperationOutcome` resource describing the
|
4806
|
+
# reason for the error. If the request cannot be mapped to a valid API method on
|
4807
|
+
# a FHIR store, a generic GCP error might be returned instead.
|
4760
4808
|
# @param [String] parent
|
4761
4809
|
# Required. The name of the FHIR store that holds the profiles being used for
|
4762
4810
|
# validation.
|
4763
4811
|
# @param [String] type
|
4764
4812
|
# Required. The FHIR resource type of the resource being validated. For a
|
4765
4813
|
# complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/
|
4766
|
-
# resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
4767
|
-
#
|
4768
|
-
# in the provided content.
|
4814
|
+
# resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](
|
4815
|
+
# https://hl7.org/fhir/R4/resourcelist.html), or [R5](https://hl7.org/fhir/R5/
|
4816
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
4769
4817
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4770
4818
|
# @param [String] profile
|
4771
4819
|
# Optional. The canonical URL of a profile that this resource should be
|
@@ -4876,14 +4924,15 @@ module Google
|
|
4876
4924
|
|
4877
4925
|
# Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/
|
4878
4926
|
# capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.
|
4879
|
-
# html)
|
4880
|
-
# html) in the
|
4881
|
-
#
|
4882
|
-
# capabilities interaction
|
4883
|
-
#
|
4884
|
-
#
|
4885
|
-
#
|
4886
|
-
#
|
4927
|
+
# html), [R5](https://hl7.org/fhir/R5/capabilitystatement.html)), or the [
|
4928
|
+
# conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the
|
4929
|
+
# DSTU2 case for the store, which contains a description of functionality
|
4930
|
+
# supported by the server. Implements the FHIR standard capabilities interaction
|
4931
|
+
# ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.
|
4932
|
+
# org/fhir/R4/http.html#capabilities), [R5](https://hl7.org/fhir/R5/http.html#
|
4933
|
+
# capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/
|
4934
|
+
# http.html#conformance) in the DSTU2 case. On success, the response body
|
4935
|
+
# contains a JSON-encoded representation of a `CapabilityStatement` resource.
|
4887
4936
|
# @param [String] name
|
4888
4937
|
# Required. Name of the FHIR store to retrieve the capabilities for.
|
4889
4938
|
# @param [String] fields
|
@@ -4931,7 +4980,8 @@ module Google
|
|
4931
4980
|
# Required. The FHIR resource type to delete, such as Patient or Observation.
|
4932
4981
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
4933
4982
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
4934
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
4983
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
4984
|
+
# resourcelist.html)).
|
4935
4985
|
# @param [String] fields
|
4936
4986
|
# Selector specifying which fields to include in a partial response.
|
4937
4987
|
# @param [String] quota_user
|
@@ -4985,7 +5035,8 @@ module Google
|
|
4985
5035
|
# Required. The FHIR resource type to update, such as Patient or Observation.
|
4986
5036
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
4987
5037
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
4988
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
5038
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
5039
|
+
# resourcelist.html)).
|
4989
5040
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4990
5041
|
# @param [String] fields
|
4991
5042
|
# Selector specifying which fields to include in a partial response.
|
@@ -5049,8 +5100,8 @@ module Google
|
|
5049
5100
|
# Required. The FHIR resource type to update, such as Patient or Observation.
|
5050
5101
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
5051
5102
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
5052
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
5053
|
-
# in the provided content.
|
5103
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
5104
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
5054
5105
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
5055
5106
|
# @param [String] fields
|
5056
5107
|
# Selector specifying which fields to include in a partial response.
|
@@ -5084,34 +5135,36 @@ module Google
|
|
5084
5135
|
|
5085
5136
|
# Creates a FHIR resource. Implements the FHIR standard create interaction ([
|
5086
5137
|
# DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/
|
5087
|
-
# fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)
|
5088
|
-
# which creates a new resource
|
5089
|
-
#
|
5090
|
-
#
|
5091
|
-
# [
|
5092
|
-
#
|
5093
|
-
#
|
5094
|
-
#
|
5095
|
-
#
|
5096
|
-
#
|
5097
|
-
#
|
5098
|
-
#
|
5099
|
-
#
|
5100
|
-
#
|
5101
|
-
#
|
5102
|
-
#
|
5103
|
-
# the
|
5104
|
-
#
|
5105
|
-
#
|
5106
|
-
#
|
5138
|
+
# fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create), [
|
5139
|
+
# R5](https://hl7.org/fhir/R5/http.html#create)), which creates a new resource
|
5140
|
+
# with a server-assigned resource ID. Also supports the FHIR standard
|
5141
|
+
# conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#
|
5142
|
+
# ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://
|
5143
|
+
# hl7.org/fhir/R4/http.html#ccreate), [R5](https://hl7.org/fhir/R5/http.html#
|
5144
|
+
# ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR
|
5145
|
+
# search query, limited to searching by resource identifier. If no resources
|
5146
|
+
# match this search query, the server processes the create operation as normal.
|
5147
|
+
# When using conditional create, the search term for identifier should be in the
|
5148
|
+
# pattern `identifier=system|value` or `identifier=value` - similar to the `
|
5149
|
+
# search` method on resources with a specific identifier. The request body must
|
5150
|
+
# contain a JSON-encoded FHIR resource, and the request headers must contain `
|
5151
|
+
# Content-Type: application/fhir+json`. On success, the response body contains a
|
5152
|
+
# JSON-encoded representation of the resource as it was created on the server,
|
5153
|
+
# including the server-assigned resource ID and version ID. Errors generated by
|
5154
|
+
# the FHIR store contain a JSON-encoded `OperationOutcome` resource describing
|
5155
|
+
# the reason for the error. If the request cannot be mapped to a valid API
|
5156
|
+
# method on a FHIR store, a generic GCP error might be returned instead. For
|
5157
|
+
# samples that show how to call `create`, see [Creating a FHIR resource](https://
|
5158
|
+
# cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
5159
|
+
# creating_a_fhir_resource).
|
5107
5160
|
# @param [String] parent
|
5108
5161
|
# Required. The name of the FHIR store this resource belongs to.
|
5109
5162
|
# @param [String] type
|
5110
5163
|
# Required. The FHIR resource type to create, such as Patient or Observation.
|
5111
5164
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
5112
5165
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
5113
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
5114
|
-
# in the provided content.
|
5166
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
5167
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
5115
5168
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
5116
5169
|
# @param [String] fields
|
5117
5170
|
# Selector specifying which fields to include in a partial response.
|
@@ -5145,13 +5198,14 @@ module Google
|
|
5145
5198
|
|
5146
5199
|
# Deletes a FHIR resource. Implements the FHIR standard delete interaction ([
|
5147
5200
|
# DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/
|
5148
|
-
# fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete)
|
5149
|
-
# Note: Unless resource
|
5150
|
-
#
|
5151
|
-
# be moved to a history repository that
|
5152
|
-
#
|
5153
|
-
# show how to call `delete`, see [
|
5154
|
-
# com/healthcare/docs/how-tos/
|
5201
|
+
# fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete), [
|
5202
|
+
# R5](https://hl7.org/fhir/R5/http.html#delete)). Note: Unless resource
|
5203
|
+
# versioning is disabled by setting the disable_resource_versioning flag on the
|
5204
|
+
# FHIR store, the deleted resources will be moved to a history repository that
|
5205
|
+
# can still be retrieved through vread and related methods, unless they are
|
5206
|
+
# removed by the purge method. For samples that show how to call `delete`, see [
|
5207
|
+
# Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
5208
|
+
# fhir-resources#deleting_a_fhir_resource).
|
5155
5209
|
# @param [String] name
|
5156
5210
|
# Required. The name of the resource to delete.
|
5157
5211
|
# @param [String] fields
|
@@ -5184,30 +5238,32 @@ module Google
|
|
5184
5238
|
# Executes all the requests in the given Bundle. Implements the FHIR standard
|
5185
5239
|
# batch/transaction interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#
|
5186
5240
|
# transaction), [STU3](https://hl7.org/fhir/STU3/http.html#transaction), [R4](
|
5187
|
-
# https://hl7.org/fhir/R4/http.html#transaction)
|
5188
|
-
# within a bundle, except
|
5189
|
-
#
|
5190
|
-
#
|
5191
|
-
# org/fhir/
|
5192
|
-
#
|
5193
|
-
#
|
5194
|
-
#
|
5195
|
-
#
|
5196
|
-
#
|
5197
|
-
#
|
5198
|
-
#
|
5199
|
-
#
|
5200
|
-
#
|
5201
|
-
#
|
5202
|
-
#
|
5203
|
-
#
|
5204
|
-
#
|
5205
|
-
#
|
5206
|
-
# permissions
|
5207
|
-
#
|
5208
|
-
#
|
5209
|
-
#
|
5210
|
-
# the
|
5241
|
+
# https://hl7.org/fhir/R4/http.html#transaction), [R5](https://hl7.org/fhir/R5/
|
5242
|
+
# http.html#transaction)). Supports all interactions within a bundle, except
|
5243
|
+
# search. This method accepts Bundles of type `batch` and `transaction`,
|
5244
|
+
# processing them according to the batch processing rules ([DSTU2](https://hl7.
|
5245
|
+
# org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.
|
5246
|
+
# html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules), [R5](https:/
|
5247
|
+
# /hl7.org/fhir/R5/http.html#brules)) and transaction processing rules ([DSTU2](
|
5248
|
+
# https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/
|
5249
|
+
# STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules), [
|
5250
|
+
# R5](https://hl7.org/fhir/R5/http.html#trules)). The request body must contain
|
5251
|
+
# a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `
|
5252
|
+
# Content-Type: application/fhir+json`. For a batch bundle or a successful
|
5253
|
+
# transaction, the response body contains a JSON-encoded representation of a `
|
5254
|
+
# Bundle` resource of type `batch-response` or `transaction-response` containing
|
5255
|
+
# one entry for each entry in the request, with the outcome of processing the
|
5256
|
+
# entry. In the case of an error for a transaction bundle, the response body
|
5257
|
+
# contains a JSON-encoded `OperationOutcome` resource describing the reason for
|
5258
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
5259
|
+
# store, a generic GCP error might be returned instead. This method checks
|
5260
|
+
# permissions for each request in the bundle. The `executeBundle` permission is
|
5261
|
+
# required to call this method, but you must also grant sufficient permissions
|
5262
|
+
# to execute the individual requests in the bundle. For example, if the bundle
|
5263
|
+
# contains a request to create a FHIR resource, the caller must also have been
|
5264
|
+
# granted the `healthcare.fhirResources.create` permission. You can use audit
|
5265
|
+
# logs to view the permissions for `executeBundle` and each request in the
|
5266
|
+
# bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.
|
5211
5267
|
# google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show
|
5212
5268
|
# how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](
|
5213
5269
|
# https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).
|
@@ -5247,12 +5303,13 @@ module Google
|
|
5247
5303
|
# deleted versions) from the FHIR store. Implements the per-resource form of the
|
5248
5304
|
# FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.
|
5249
5305
|
# html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https:
|
5250
|
-
# //hl7.org/fhir/R4/http.html#history)
|
5251
|
-
#
|
5252
|
-
#
|
5253
|
-
#
|
5254
|
-
#
|
5255
|
-
#
|
5306
|
+
# //hl7.org/fhir/R4/http.html#history), [R5](https://hl7.org/fhir/R5/http.html#
|
5307
|
+
# history)). On success, the response body contains a JSON-encoded
|
5308
|
+
# representation of a `Bundle` resource of type `history`, containing the
|
5309
|
+
# version history sorted from most recent to oldest versions. Errors generated
|
5310
|
+
# by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
5311
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
5312
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
5256
5313
|
# instead. For samples that show how to call `history`, see [Listing FHIR
|
5257
5314
|
# resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
5258
5315
|
# resources#listing_fhir_resource_versions).
|
@@ -5312,17 +5369,18 @@ module Google
|
|
5312
5369
|
# Updates part of an existing resource by applying the operations specified in a
|
5313
5370
|
# [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard
|
5314
5371
|
# patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](
|
5315
|
-
# https://hl7.org/fhir/R4/http.html#patch)
|
5316
|
-
#
|
5317
|
-
#
|
5318
|
-
# Content-Type: application/json-
|
5319
|
-
#
|
5320
|
-
#
|
5321
|
-
#
|
5322
|
-
#
|
5323
|
-
#
|
5324
|
-
#
|
5325
|
-
# tos/
|
5372
|
+
# https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.
|
5373
|
+
# html#patch)). DSTU2 doesn't define a patch method, but the server supports it
|
5374
|
+
# in the same way it supports STU3. The request body must contain a JSON Patch
|
5375
|
+
# document, and the request headers must contain `Content-Type: application/json-
|
5376
|
+
# patch+json`. On success, the response body contains a JSON-encoded
|
5377
|
+
# representation of the updated resource, including the server-assigned version
|
5378
|
+
# ID. Errors generated by the FHIR store contain a JSON-encoded `
|
5379
|
+
# OperationOutcome` resource describing the reason for the error. If the request
|
5380
|
+
# cannot be mapped to a valid API method on a FHIR store, a generic GCP error
|
5381
|
+
# might be returned instead. For samples that show how to call `patch`, see [
|
5382
|
+
# Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
5383
|
+
# fhir-resources#patching_a_fhir_resource).
|
5326
5384
|
# @param [String] name
|
5327
5385
|
# Required. The name of the resource to update.
|
5328
5386
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
@@ -5358,17 +5416,19 @@ module Google
|
|
5358
5416
|
# Gets the contents of a FHIR resource. Implements the FHIR standard read
|
5359
5417
|
# interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https:/
|
5360
5418
|
# /hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#
|
5361
|
-
# read)). Also supports the FHIR
|
5362
|
-
#
|
5363
|
-
#
|
5364
|
-
#
|
5365
|
-
#
|
5366
|
-
#
|
5367
|
-
#
|
5368
|
-
#
|
5369
|
-
#
|
5370
|
-
#
|
5371
|
-
#
|
5419
|
+
# read), [R5](https://hl7.org/fhir/R5/http.html#read)). Also supports the FHIR
|
5420
|
+
# standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.
|
5421
|
+
# html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://
|
5422
|
+
# hl7.org/fhir/R4/http.html#cread), [R5](https://hl7.org/fhir/R5/http.html#cread)
|
5423
|
+
# ) specified by supplying an `If-Modified-Since` header with a date/time value
|
5424
|
+
# or an `If-None-Match` header with an ETag value. On success, the response body
|
5425
|
+
# contains a JSON-encoded representation of the resource. Errors generated by
|
5426
|
+
# the FHIR store contain a JSON-encoded `OperationOutcome` resource describing
|
5427
|
+
# the reason for the error. If the request cannot be mapped to a valid API
|
5428
|
+
# method on a FHIR store, a generic GCP error might be returned instead. For
|
5429
|
+
# samples that show how to call `read`, see [Getting a FHIR resource](https://
|
5430
|
+
# cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
5431
|
+
# getting_a_fhir_resource).
|
5372
5432
|
# @param [String] name
|
5373
5433
|
# Required. The name of the resource to retrieve.
|
5374
5434
|
# @param [String] fields
|
@@ -5401,63 +5461,65 @@ module Google
|
|
5401
5461
|
# Searches for resources in the given FHIR store according to criteria specified
|
5402
5462
|
# as query parameters. Implements the FHIR standard search interaction ([DSTU2](
|
5403
5463
|
# https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/
|
5404
|
-
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)
|
5405
|
-
# search
|
5406
|
-
#
|
5407
|
-
# [
|
5408
|
-
#
|
5409
|
-
#
|
5410
|
-
#
|
5411
|
-
#
|
5412
|
-
#
|
5413
|
-
#
|
5414
|
-
#
|
5415
|
-
#
|
5416
|
-
#
|
5417
|
-
#
|
5418
|
-
#
|
5419
|
-
#
|
5420
|
-
#
|
5421
|
-
#
|
5422
|
-
#
|
5423
|
-
#
|
5424
|
-
#
|
5425
|
-
#
|
5426
|
-
#
|
5464
|
+
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https:/
|
5465
|
+
# /hl7.org/fhir/R5/http.html#search)) using the search semantics described in
|
5466
|
+
# the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html),
|
5467
|
+
# [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/
|
5468
|
+
# search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four
|
5469
|
+
# methods of search defined by the specification: * `GET [base]?[parameters]` to
|
5470
|
+
# search across all resources. * `GET [base]/[type]?[parameters]` to search
|
5471
|
+
# resources of a specified type. * `POST [base]/_search?[parameters]` as an
|
5472
|
+
# alternate form having the same semantics as the `GET` method across all
|
5473
|
+
# resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form
|
5474
|
+
# having the same semantics as the `GET` method for the specified type. The `GET`
|
5475
|
+
# and `POST` methods do not support compartment searches. The `POST` method
|
5476
|
+
# does not support `application/x-www-form-urlencoded` search parameters. On
|
5477
|
+
# success, the response body contains a JSON-encoded representation of a `Bundle`
|
5478
|
+
# resource of type `searchset`, containing the results of the search. Errors
|
5479
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
5480
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
5481
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
5482
|
+
# instead. The server's capability statement, retrieved through capabilities,
|
5483
|
+
# indicates what search parameters are supported on each FHIR resource. A list
|
5484
|
+
# of all search parameters defined by the specification can be found in the FHIR
|
5485
|
+
# Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-
|
5486
|
+
# registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [
|
5487
|
+
# R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search
|
5488
|
+
# parameters for DSTU2 can be found on each resource's definition page.
|
5427
5489
|
# Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
|
5428
5490
|
# `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and
|
5429
|
-
# STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `
|
5430
|
-
#
|
5431
|
-
# The maximum number of search results returned defaults to 100,
|
5432
|
-
# overridden by the `_count` parameter up to a maximum limit of
|
5433
|
-
# might return fewer resources than requested to prevent
|
5434
|
-
# responses. If there are additional results, the returned `
|
5435
|
-
# link of `relation` "next", which has a `_page_token`
|
5436
|
-
# pagination token that can be used to retrieve the next
|
5437
|
-
# total size larger than 5MB or a field count larger than
|
5438
|
-
# fully searchable as the server might trim its generated
|
5439
|
-
# cases. Note: FHIR resources are indexed asynchronously,
|
5440
|
-
# slight delay between the time a resource is created or
|
5441
|
-
# when the change reflects in search results. The only
|
5442
|
-
# identifier data, which is indexed synchronously as a
|
5443
|
-
# result, searching using resource identifier is not subject
|
5444
|
-
# To use the special synchronous index, the search term for
|
5445
|
-
# in the pattern `identifier=[system]|[value]` or `
|
5446
|
-
# of the following search result parameters can be
|
5447
|
-
# * `_revinclude` * `_summary` * `_elements` If
|
5448
|
-
# search parameters, the standard asynchronous
|
5449
|
-
# that searching against the special index is
|
5450
|
-
# number of matches. The search isn't optimized
|
5451
|
-
# criteria matches a large number (i.e. more than 2,
|
5452
|
-
# search query that will match a large number of
|
5453
|
-
# using the special synchronous index by including
|
5454
|
-
# parameter in your query. Use `_sort=-_lastUpdated` if
|
5455
|
-
# default sorting order. Note: The special synchronous
|
5456
|
-
# currently disabled for DocumentReference and
|
5457
|
-
# samples and detailed information, see [
|
5458
|
-
# cloud.google.com/healthcare/docs/how-tos/
|
5459
|
-
# search features](https://cloud.google.com/
|
5460
|
-
# advanced-search).
|
5491
|
+
# STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `
|
5492
|
+
# _count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `
|
5493
|
+
# _elements`. The maximum number of search results returned defaults to 100,
|
5494
|
+
# which can be overridden by the `_count` parameter up to a maximum limit of
|
5495
|
+
# 1000. The server might return fewer resources than requested to prevent
|
5496
|
+
# excessively large responses. If there are additional results, the returned `
|
5497
|
+
# Bundle` contains a link of `relation` "next", which has a `_page_token`
|
5498
|
+
# parameter for an opaque pagination token that can be used to retrieve the next
|
5499
|
+
# page. Resources with a total size larger than 5MB or a field count larger than
|
5500
|
+
# 50,000 might not be fully searchable as the server might trim its generated
|
5501
|
+
# search index in those cases. Note: FHIR resources are indexed asynchronously,
|
5502
|
+
# so there might be a slight delay between the time a resource is created or
|
5503
|
+
# changed, and the time when the change reflects in search results. The only
|
5504
|
+
# exception is resource identifier data, which is indexed synchronously as a
|
5505
|
+
# special index. As a result, searching using resource identifier is not subject
|
5506
|
+
# to indexing delay. To use the special synchronous index, the search term for
|
5507
|
+
# identifier should be in the pattern `identifier=[system]|[value]` or `
|
5508
|
+
# identifier=[value]`, and any of the following search result parameters can be
|
5509
|
+
# used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If
|
5510
|
+
# your query contains any other search parameters, the standard asynchronous
|
5511
|
+
# index will be used instead. Note that searching against the special index is
|
5512
|
+
# optimized for resolving a small number of matches. The search isn't optimized
|
5513
|
+
# if your identifier search criteria matches a large number (i.e. more than 2,
|
5514
|
+
# 000) of resources. For a search query that will match a large number of
|
5515
|
+
# resources, you can avoiding using the special synchronous index by including
|
5516
|
+
# an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if
|
5517
|
+
# you want to keep the default sorting order. Note: The special synchronous
|
5518
|
+
# identifier index are currently disabled for DocumentReference and
|
5519
|
+
# DocumentManifest searches. For samples and detailed information, see [
|
5520
|
+
# Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/
|
5521
|
+
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
5522
|
+
# healthcare/docs/how-tos/fhir-advanced-search).
|
5461
5523
|
# @param [String] parent
|
5462
5524
|
# Required. Name of the FHIR store to retrieve resources from.
|
5463
5525
|
# @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
|
@@ -5493,70 +5555,73 @@ module Google
|
|
5493
5555
|
# Searches for resources in the given FHIR store according to criteria specified
|
5494
5556
|
# as query parameters. Implements the FHIR standard search interaction ([DSTU2](
|
5495
5557
|
# https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/
|
5496
|
-
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)
|
5497
|
-
# search
|
5498
|
-
#
|
5499
|
-
# [
|
5500
|
-
#
|
5501
|
-
#
|
5502
|
-
#
|
5503
|
-
#
|
5504
|
-
#
|
5505
|
-
#
|
5506
|
-
#
|
5507
|
-
#
|
5508
|
-
#
|
5509
|
-
#
|
5510
|
-
#
|
5511
|
-
#
|
5512
|
-
#
|
5513
|
-
#
|
5514
|
-
#
|
5515
|
-
#
|
5516
|
-
#
|
5517
|
-
#
|
5518
|
-
#
|
5558
|
+
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https:/
|
5559
|
+
# /hl7.org/fhir/R5/http.html#search)) using the search semantics described in
|
5560
|
+
# the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html),
|
5561
|
+
# [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/
|
5562
|
+
# search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four
|
5563
|
+
# methods of search defined by the specification: * `GET [base]?[parameters]` to
|
5564
|
+
# search across all resources. * `GET [base]/[type]?[parameters]` to search
|
5565
|
+
# resources of a specified type. * `POST [base]/_search?[parameters]` as an
|
5566
|
+
# alternate form having the same semantics as the `GET` method across all
|
5567
|
+
# resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form
|
5568
|
+
# having the same semantics as the `GET` method for the specified type. The `GET`
|
5569
|
+
# and `POST` methods do not support compartment searches. The `POST` method
|
5570
|
+
# does not support `application/x-www-form-urlencoded` search parameters. On
|
5571
|
+
# success, the response body contains a JSON-encoded representation of a `Bundle`
|
5572
|
+
# resource of type `searchset`, containing the results of the search. Errors
|
5573
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
5574
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
5575
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
5576
|
+
# instead. The server's capability statement, retrieved through capabilities,
|
5577
|
+
# indicates what search parameters are supported on each FHIR resource. A list
|
5578
|
+
# of all search parameters defined by the specification can be found in the FHIR
|
5579
|
+
# Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-
|
5580
|
+
# registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [
|
5581
|
+
# R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search
|
5582
|
+
# parameters for DSTU2 can be found on each resource's definition page.
|
5519
5583
|
# Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
|
5520
5584
|
# `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and
|
5521
|
-
# STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `
|
5522
|
-
#
|
5523
|
-
# The maximum number of search results returned defaults to 100,
|
5524
|
-
# overridden by the `_count` parameter up to a maximum limit of
|
5525
|
-
# might return fewer resources than requested to prevent
|
5526
|
-
# responses. If there are additional results, the returned `
|
5527
|
-
# link of `relation` "next", which has a `_page_token`
|
5528
|
-
# pagination token that can be used to retrieve the next
|
5529
|
-
# total size larger than 5MB or a field count larger than
|
5530
|
-
# fully searchable as the server might trim its generated
|
5531
|
-
# cases. Note: FHIR resources are indexed asynchronously,
|
5532
|
-
# slight delay between the time a resource is created or
|
5533
|
-
# when the change reflects in search results. The only
|
5534
|
-
# identifier data, which is indexed synchronously as a
|
5535
|
-
# result, searching using resource identifier is not subject
|
5536
|
-
# To use the special synchronous index, the search term for
|
5537
|
-
# in the pattern `identifier=[system]|[value]` or `
|
5538
|
-
# of the following search result parameters can be
|
5539
|
-
# * `_revinclude` * `_summary` * `_elements` If
|
5540
|
-
# search parameters, the standard asynchronous
|
5541
|
-
# that searching against the special index is
|
5542
|
-
# number of matches. The search isn't optimized
|
5543
|
-
# criteria matches a large number (i.e. more than 2,
|
5544
|
-
# search query that will match a large number of
|
5545
|
-
# using the special synchronous index by including
|
5546
|
-
# parameter in your query. Use `_sort=-_lastUpdated` if
|
5547
|
-
# default sorting order. Note: The special synchronous
|
5548
|
-
# currently disabled for DocumentReference and
|
5549
|
-
# samples and detailed information, see [
|
5550
|
-
# cloud.google.com/healthcare/docs/how-tos/
|
5551
|
-
# search features](https://cloud.google.com/
|
5552
|
-
# advanced-search).
|
5585
|
+
# STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `
|
5586
|
+
# _count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `
|
5587
|
+
# _elements`. The maximum number of search results returned defaults to 100,
|
5588
|
+
# which can be overridden by the `_count` parameter up to a maximum limit of
|
5589
|
+
# 1000. The server might return fewer resources than requested to prevent
|
5590
|
+
# excessively large responses. If there are additional results, the returned `
|
5591
|
+
# Bundle` contains a link of `relation` "next", which has a `_page_token`
|
5592
|
+
# parameter for an opaque pagination token that can be used to retrieve the next
|
5593
|
+
# page. Resources with a total size larger than 5MB or a field count larger than
|
5594
|
+
# 50,000 might not be fully searchable as the server might trim its generated
|
5595
|
+
# search index in those cases. Note: FHIR resources are indexed asynchronously,
|
5596
|
+
# so there might be a slight delay between the time a resource is created or
|
5597
|
+
# changed, and the time when the change reflects in search results. The only
|
5598
|
+
# exception is resource identifier data, which is indexed synchronously as a
|
5599
|
+
# special index. As a result, searching using resource identifier is not subject
|
5600
|
+
# to indexing delay. To use the special synchronous index, the search term for
|
5601
|
+
# identifier should be in the pattern `identifier=[system]|[value]` or `
|
5602
|
+
# identifier=[value]`, and any of the following search result parameters can be
|
5603
|
+
# used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If
|
5604
|
+
# your query contains any other search parameters, the standard asynchronous
|
5605
|
+
# index will be used instead. Note that searching against the special index is
|
5606
|
+
# optimized for resolving a small number of matches. The search isn't optimized
|
5607
|
+
# if your identifier search criteria matches a large number (i.e. more than 2,
|
5608
|
+
# 000) of resources. For a search query that will match a large number of
|
5609
|
+
# resources, you can avoiding using the special synchronous index by including
|
5610
|
+
# an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if
|
5611
|
+
# you want to keep the default sorting order. Note: The special synchronous
|
5612
|
+
# identifier index are currently disabled for DocumentReference and
|
5613
|
+
# DocumentManifest searches. For samples and detailed information, see [
|
5614
|
+
# Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/
|
5615
|
+
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
5616
|
+
# healthcare/docs/how-tos/fhir-advanced-search).
|
5553
5617
|
# @param [String] parent
|
5554
5618
|
# Required. Name of the FHIR store to retrieve resources from.
|
5555
5619
|
# @param [String] resource_type
|
5556
5620
|
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
5557
5621
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
5558
5622
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
5559
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)).
|
5623
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)), [R5](https://hl7.org/fhir/R5/
|
5624
|
+
# resourcelist.html)).
|
5560
5625
|
# @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
|
5561
5626
|
# @param [String] fields
|
5562
5627
|
# Selector specifying which fields to include in a partial response.
|
@@ -5591,23 +5656,26 @@ module Google
|
|
5591
5656
|
# Updates the entire contents of a resource. Implements the FHIR standard update
|
5592
5657
|
# interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](
|
5593
5658
|
# https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.
|
5594
|
-
# html#update)). If the
|
5595
|
-
#
|
5596
|
-
#
|
5597
|
-
#
|
5598
|
-
#
|
5599
|
-
#
|
5600
|
-
#
|
5601
|
-
#
|
5602
|
-
# contain an `id`
|
5603
|
-
#
|
5604
|
-
#
|
5605
|
-
#
|
5606
|
-
#
|
5607
|
-
#
|
5608
|
-
#
|
5609
|
-
#
|
5610
|
-
#
|
5659
|
+
# html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the
|
5660
|
+
# specified resource does not exist and the FHIR store has enable_update_create
|
5661
|
+
# set, creates the resource with the client-specified ID. It is strongly advised
|
5662
|
+
# not to include or encode any sensitive data such as patient identifiers in
|
5663
|
+
# client-specified resource IDs. Those IDs are part of the FHIR resource path
|
5664
|
+
# recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
|
5665
|
+
# contained in reference fields within other resources. The request body must
|
5666
|
+
# contain a JSON-encoded FHIR resource, and the request headers must contain `
|
5667
|
+
# Content-Type: application/fhir+json`. The resource must contain an `id`
|
5668
|
+
# element having an identical value to the ID in the REST path of the request.
|
5669
|
+
# On success, the response body contains a JSON-encoded representation of the
|
5670
|
+
# updated resource, including the server-assigned version ID. Errors generated
|
5671
|
+
# by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
5672
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
5673
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
5674
|
+
# instead. The conditional update interaction If-None-Match is supported,
|
5675
|
+
# including the wildcard behaviour, as defined by the R5 spec. This
|
5676
|
+
# functionality is supported in R4 and R5. For samples that show how to call `
|
5677
|
+
# update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/
|
5678
|
+
# docs/how-tos/fhir-resources#updating_a_fhir_resource).
|
5611
5679
|
# @param [String] name
|
5612
5680
|
# Required. The name of the resource to update.
|
5613
5681
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
@@ -5643,14 +5711,15 @@ module Google
|
|
5643
5711
|
# Gets the contents of a version (current or historical) of a FHIR resource by
|
5644
5712
|
# version ID. Implements the FHIR standard vread interaction ([DSTU2](https://
|
5645
5713
|
# hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.
|
5646
|
-
# html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread)
|
5647
|
-
# response body contains a JSON-
|
5648
|
-
#
|
5649
|
-
#
|
5650
|
-
#
|
5651
|
-
#
|
5652
|
-
# resource version](https://cloud.
|
5653
|
-
# resources#
|
5714
|
+
# html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread), [R5](https://hl7.
|
5715
|
+
# org/fhir/R5/http.html#vread)). On success, the response body contains a JSON-
|
5716
|
+
# encoded representation of the resource. Errors generated by the FHIR store
|
5717
|
+
# contain a JSON-encoded `OperationOutcome` resource describing the reason for
|
5718
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
5719
|
+
# store, a generic GCP error might be returned instead. For samples that show
|
5720
|
+
# how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.
|
5721
|
+
# google.com/healthcare/docs/how-tos/fhir-resources#
|
5722
|
+
# retrieving_a_fhir_resource_version).
|
5654
5723
|
# @param [String] name
|
5655
5724
|
# Required. The name of the resource version to retrieve.
|
5656
5725
|
# @param [String] fields
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-healthcare_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.77.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
@@ -57,7 +57,7 @@ licenses:
|
|
57
57
|
metadata:
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1/v0.77.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
73
73
|
- !ruby/object:Gem::Version
|
74
74
|
version: '0'
|
75
75
|
requirements: []
|
76
|
-
rubygems_version: 3.6.
|
76
|
+
rubygems_version: 3.6.9
|
77
77
|
specification_version: 4
|
78
78
|
summary: Simple REST client for Cloud Healthcare API V1
|
79
79
|
test_files: []
|