google-apis-healthcare_v1 0.75.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 +5 -0
- data/lib/google/apis/healthcare_v1/classes.rb +3 -2
- data/lib/google/apis/healthcare_v1/gem_version.rb +3 -3
- data/lib/google/apis/healthcare_v1/service.rb +312 -288
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ec9ed5a38129160d59e70ab53ae15edb912bf1d2c57087bc1b312ae4e779c1f6
|
|
4
|
+
data.tar.gz: 4770252f061da7c8b08a2b28d003d17949d5d46cfc86b7e5895edcada1d0904d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 85a98f571eb14854d8a2f4bbfa5c9399c34f226a441312a0edac8d86f6c1a5dcab7209a9b342331115108179387ccde783cea7903f70a06de9c78c715a624d97
|
|
7
|
+
data.tar.gz: 5976b5cefbb9c7e962a7f97754bcbdf6cd8fce04524d8b05ff29507cd24620f5863fa398bd488be8a989841601d9b38424aadbc9bd77df12dd7e914625fed0b9
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# Release history for google-apis-healthcare_v1
|
|
2
2
|
|
|
3
|
+
### v0.76.0 (2025-06-08)
|
|
4
|
+
|
|
5
|
+
* Regenerated from discovery document revision 20250526
|
|
6
|
+
* Regenerated using generator version 0.18.0
|
|
7
|
+
|
|
3
8
|
### v0.75.0 (2025-05-18)
|
|
4
9
|
|
|
5
10
|
* Regenerated from discovery document revision 20250430
|
|
@@ -2589,7 +2589,7 @@ module Google
|
|
|
2589
2589
|
# references in complex data types will not be parsed. New stores will have this
|
|
2590
2590
|
# value set to ENABLED after a notification period. Warning: turning on this
|
|
2591
2591
|
# flag causes processing existing resources to fail if they contain references
|
|
2592
|
-
# to non-existent resources.
|
|
2592
|
+
# to non-existent resources. Cannot be disabled in R5.
|
|
2593
2593
|
# Corresponds to the JSON property `complexDataTypeReferenceParsing`
|
|
2594
2594
|
# @return [String]
|
|
2595
2595
|
attr_accessor :complex_data_type_reference_parsing
|
|
@@ -5406,7 +5406,8 @@ module Google
|
|
|
5406
5406
|
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
|
5407
5407
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
5408
5408
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
5409
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)).
|
|
5409
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)), [R5](https://hl7.org/fhir/R5/
|
|
5410
|
+
# resourcelist.html)).
|
|
5410
5411
|
# Corresponds to the JSON property `resourceType`
|
|
5411
5412
|
# @return [String]
|
|
5412
5413
|
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.76.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 = "20250526"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
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.
|
|
@@ -3574,7 +3575,7 @@ module Google
|
|
|
3574
3575
|
# instead of an Operation. No resources will be reindexed and the `
|
|
3575
3576
|
# consent_config.enforced_admin_consents` field will be unchanged. To enforce a
|
|
3576
3577
|
# consent check for data access, `consent_config.access_enforced` must be set to
|
|
3577
|
-
# true for the FhirStore.
|
|
3578
|
+
# true for the FhirStore. FHIR Consent is not supported in DSTU2 or R5.
|
|
3578
3579
|
# @param [String] name
|
|
3579
3580
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
|
3580
3581
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
|
@@ -3620,7 +3621,7 @@ module Google
|
|
|
3620
3621
|
# was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in
|
|
3621
3622
|
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To
|
|
3622
3623
|
# enforce consent check for data access, `consent_config.access_enforced` must
|
|
3623
|
-
# be set to true for the FhirStore.
|
|
3624
|
+
# be set to true for the FhirStore. FHIR Consent is not supported in DSTU2 or R5.
|
|
3624
3625
|
# @param [String] name
|
|
3625
3626
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
|
3626
3627
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
|
@@ -3788,7 +3789,8 @@ module Google
|
|
|
3788
3789
|
# how-tos/logging)).
|
|
3789
3790
|
# @param [String] source_store
|
|
3790
3791
|
# Required. Source FHIR store resource name. For example, `projects/`project_id`/
|
|
3791
|
-
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
|
|
3792
|
+
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. R5
|
|
3793
|
+
# stores are not supported.
|
|
3792
3794
|
# @param [Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object
|
|
3793
3795
|
# @param [String] fields
|
|
3794
3796
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -3850,7 +3852,7 @@ module Google
|
|
|
3850
3852
|
end
|
|
3851
3853
|
|
|
3852
3854
|
# Explains all the permitted/denied actor, purpose and environment for a given
|
|
3853
|
-
# resource.
|
|
3855
|
+
# resource. FHIR Consent is not supported in DSTU2 or R5.
|
|
3854
3856
|
# @param [String] name
|
|
3855
3857
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
|
3856
3858
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
|
@@ -4349,24 +4351,24 @@ module Google
|
|
|
4349
4351
|
# zip archives, pdf files, documents). When a non-FHIR content type is used in
|
|
4350
4352
|
# the request, a Binary resource will be generated, and the uploaded data will
|
|
4351
4353
|
# 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.
|
|
4354
|
+
# R4` and `R5`). The Binary resource's `contentType` will be filled in using the
|
|
4355
|
+
# value of the `Content-Type` header, and the `securityContext` field (not
|
|
4356
|
+
# present in `DSTU2`) will be populated from the `X-Security-Context` header if
|
|
4357
|
+
# it exists. At this time `securityContext` has no special behavior in the Cloud
|
|
4358
|
+
# Healthcare API. Note: the limit on data ingested through this method is 1 GB.
|
|
4359
|
+
# For best performance, use a non-FHIR data type instead of wrapping the data in
|
|
4360
|
+
# a Binary resource. Some of the Healthcare API features, such as [exporting to
|
|
4361
|
+
# BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-
|
|
4362
|
+
# bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/
|
|
4363
|
+
# docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high)
|
|
4364
|
+
# with full resource content, do not support Binary resources that are larger
|
|
4365
|
+
# than 10 MB. In these cases the resource's `data` field will be omitted.
|
|
4366
|
+
# Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
|
|
4367
|
+
# extension will be present to indicate that including the data is `unsupported`.
|
|
4368
|
+
# On success, an empty `201 Created` response is returned. The newly created
|
|
4369
|
+
# resource's ID and version are returned in the Location header. Using `Prefer:
|
|
4370
|
+
# representation=resource` is not allowed for this method. The definition of the
|
|
4371
|
+
# Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
|
|
4370
4372
|
# @param [String] parent
|
|
4371
4373
|
# Required. The name of the FHIR store this resource belongs to.
|
|
4372
4374
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
|
@@ -4450,16 +4452,16 @@ module Google
|
|
|
4450
4452
|
# the same way as non-FHIR data. When a non-FHIR content type is used in the
|
|
4451
4453
|
# request, a Binary resource will be generated using the ID from the resource
|
|
4452
4454
|
# 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#
|
|
4455
|
+
# `STU3`), or the `data` field (`R4` and `R5`). The Binary resource's `
|
|
4456
|
+
# contentType` will be filled in using the value of the `Content-Type` header,
|
|
4457
|
+
# and the `securityContext` field (not present in `DSTU2`) will be populated
|
|
4458
|
+
# from the `X-Security-Context` header if it exists. At this time `
|
|
4459
|
+
# securityContext` has no special behavior in the Cloud Healthcare API. Note:
|
|
4460
|
+
# the limit on data ingested through this method is 2 GB. For best performance,
|
|
4461
|
+
# use a non-FHIR data type instead of wrapping the data in a Binary resource.
|
|
4462
|
+
# Some of the Healthcare API features, such as [exporting to BigQuery](https://
|
|
4463
|
+
# cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub
|
|
4464
|
+
# notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#
|
|
4463
4465
|
# behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full
|
|
4464
4466
|
# resource content, do not support Binary resources that are larger than 10 MB.
|
|
4465
4467
|
# In these cases the resource's `data` field will be omitted. Instead, the "http:
|
|
@@ -4627,18 +4629,20 @@ module Google
|
|
|
4627
4629
|
# the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/
|
|
4628
4630
|
# DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/
|
|
4629
4631
|
# 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/
|
|
4632
|
+
# operation-everything.html), [R5](https://hl7.org/fhir/R5/patient-operation-
|
|
4633
|
+
# everything.html)). On success, the response body contains a JSON-encoded
|
|
4634
|
+
# representation of a `Bundle` resource of type `searchset`, containing the
|
|
4635
|
+
# results of the operation. Errors generated by the FHIR store contain a JSON-
|
|
4636
|
+
# encoded `OperationOutcome` resource describing the reason for the error. If
|
|
4637
|
+
# the request cannot be mapped to a valid API method on a FHIR store, a generic
|
|
4638
|
+
# GCP error might be returned instead. The resources in scope for the response
|
|
4639
|
+
# are: * The patient resource itself. * All the resources directly referenced by
|
|
4640
|
+
# the patient resource. * Resources directly referencing the patient resource
|
|
4641
|
+
# that meet the inclusion criteria. The inclusion criteria are based on the
|
|
4642
|
+
# membership rules in the patient compartment definition ([DSTU2](http://hl7.org/
|
|
4643
|
+
# fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/
|
|
4644
|
+
# compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/
|
|
4645
|
+
# compartmentdefinition-patient.html), [R5](http://hl7.org/fhir/R5/
|
|
4642
4646
|
# compartmentdefinition-patient.html)), which details the eligible resource
|
|
4643
4647
|
# types and referencing search parameters. For samples that show how to call `
|
|
4644
4648
|
# Patient-everything`, see [Getting all patient compartment resources](https://
|
|
@@ -4746,26 +4750,26 @@ module Google
|
|
|
4746
4750
|
# Validates an input FHIR resource's conformance to its profiles and the
|
|
4747
4751
|
# profiles configured on the FHIR store. Implements the FHIR extended operation $
|
|
4748
4752
|
# 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.
|
|
4753
|
+
# , [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), [R4](
|
|
4754
|
+
# https://hl7.org/fhir/R4/resource-operation-validate.html). or [R5](https://hl7.
|
|
4755
|
+
# org/fhir/R5/resource-operation-validate.html)). The request body must contain
|
|
4756
|
+
# a JSON-encoded FHIR resource, and the request headers must contain `Content-
|
|
4757
|
+
# Type: application/fhir+json`. The `Parameters` input syntax is not supported.
|
|
4758
|
+
# The `profile` query parameter can be used to request that the resource only be
|
|
4759
|
+
# validated against a specific profile. If a profile with the given URL cannot
|
|
4760
|
+
# be found in the FHIR store then an error is returned. Errors generated by
|
|
4761
|
+
# validation contain a JSON-encoded `OperationOutcome` resource describing the
|
|
4762
|
+
# reason for the error. If the request cannot be mapped to a valid API method on
|
|
4763
|
+
# a FHIR store, a generic GCP error might be returned instead.
|
|
4760
4764
|
# @param [String] parent
|
|
4761
4765
|
# Required. The name of the FHIR store that holds the profiles being used for
|
|
4762
4766
|
# validation.
|
|
4763
4767
|
# @param [String] type
|
|
4764
4768
|
# Required. The FHIR resource type of the resource being validated. For a
|
|
4765
4769
|
# 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.
|
|
4770
|
+
# resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](
|
|
4771
|
+
# https://hl7.org/fhir/R4/resourcelist.html), or [R5](https://hl7.org/fhir/R5/
|
|
4772
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
|
4769
4773
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
|
4770
4774
|
# @param [String] profile
|
|
4771
4775
|
# Optional. The canonical URL of a profile that this resource should be
|
|
@@ -4876,14 +4880,15 @@ module Google
|
|
|
4876
4880
|
|
|
4877
4881
|
# Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/
|
|
4878
4882
|
# capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.
|
|
4879
|
-
# html)
|
|
4880
|
-
# html) in the
|
|
4881
|
-
#
|
|
4882
|
-
# capabilities interaction
|
|
4883
|
-
#
|
|
4884
|
-
#
|
|
4885
|
-
#
|
|
4886
|
-
#
|
|
4883
|
+
# html), [R5](https://hl7.org/fhir/R5/capabilitystatement.html)), or the [
|
|
4884
|
+
# conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the
|
|
4885
|
+
# DSTU2 case for the store, which contains a description of functionality
|
|
4886
|
+
# supported by the server. Implements the FHIR standard capabilities interaction
|
|
4887
|
+
# ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.
|
|
4888
|
+
# org/fhir/R4/http.html#capabilities), [R5](https://hl7.org/fhir/R5/http.html#
|
|
4889
|
+
# capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/
|
|
4890
|
+
# http.html#conformance) in the DSTU2 case. On success, the response body
|
|
4891
|
+
# contains a JSON-encoded representation of a `CapabilityStatement` resource.
|
|
4887
4892
|
# @param [String] name
|
|
4888
4893
|
# Required. Name of the FHIR store to retrieve the capabilities for.
|
|
4889
4894
|
# @param [String] fields
|
|
@@ -4931,7 +4936,8 @@ module Google
|
|
|
4931
4936
|
# Required. The FHIR resource type to delete, such as Patient or Observation.
|
|
4932
4937
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
4933
4938
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
4934
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
|
4939
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
4940
|
+
# resourcelist.html)).
|
|
4935
4941
|
# @param [String] fields
|
|
4936
4942
|
# Selector specifying which fields to include in a partial response.
|
|
4937
4943
|
# @param [String] quota_user
|
|
@@ -4985,7 +4991,8 @@ module Google
|
|
|
4985
4991
|
# Required. The FHIR resource type to update, such as Patient or Observation.
|
|
4986
4992
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
4987
4993
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
4988
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
|
4994
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
4995
|
+
# resourcelist.html)).
|
|
4989
4996
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
|
4990
4997
|
# @param [String] fields
|
|
4991
4998
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -5049,8 +5056,8 @@ module Google
|
|
|
5049
5056
|
# Required. The FHIR resource type to update, such as Patient or Observation.
|
|
5050
5057
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
5051
5058
|
# 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.
|
|
5059
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
5060
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
|
5054
5061
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
|
5055
5062
|
# @param [String] fields
|
|
5056
5063
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -5084,34 +5091,36 @@ module Google
|
|
|
5084
5091
|
|
|
5085
5092
|
# Creates a FHIR resource. Implements the FHIR standard create interaction ([
|
|
5086
5093
|
# 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
|
-
#
|
|
5094
|
+
# fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create), [
|
|
5095
|
+
# R5](https://hl7.org/fhir/R5/http.html#create)), which creates a new resource
|
|
5096
|
+
# with a server-assigned resource ID. Also supports the FHIR standard
|
|
5097
|
+
# conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#
|
|
5098
|
+
# ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://
|
|
5099
|
+
# hl7.org/fhir/R4/http.html#ccreate), [R5](https://hl7.org/fhir/R5/http.html#
|
|
5100
|
+
# ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR
|
|
5101
|
+
# search query, limited to searching by resource identifier. If no resources
|
|
5102
|
+
# match this search query, the server processes the create operation as normal.
|
|
5103
|
+
# When using conditional create, the search term for identifier should be in the
|
|
5104
|
+
# pattern `identifier=system|value` or `identifier=value` - similar to the `
|
|
5105
|
+
# search` method on resources with a specific identifier. The request body must
|
|
5106
|
+
# contain a JSON-encoded FHIR resource, and the request headers must contain `
|
|
5107
|
+
# Content-Type: application/fhir+json`. On success, the response body contains a
|
|
5108
|
+
# JSON-encoded representation of the resource as it was created on the server,
|
|
5109
|
+
# including the server-assigned resource ID and version ID. Errors generated by
|
|
5110
|
+
# the FHIR store contain a JSON-encoded `OperationOutcome` resource describing
|
|
5111
|
+
# the reason for the error. If the request cannot be mapped to a valid API
|
|
5112
|
+
# method on a FHIR store, a generic GCP error might be returned instead. For
|
|
5113
|
+
# samples that show how to call `create`, see [Creating a FHIR resource](https://
|
|
5114
|
+
# cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
|
5115
|
+
# creating_a_fhir_resource).
|
|
5107
5116
|
# @param [String] parent
|
|
5108
5117
|
# Required. The name of the FHIR store this resource belongs to.
|
|
5109
5118
|
# @param [String] type
|
|
5110
5119
|
# Required. The FHIR resource type to create, such as Patient or Observation.
|
|
5111
5120
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
5112
5121
|
# 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.
|
|
5122
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
5123
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
|
5115
5124
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
|
5116
5125
|
# @param [String] fields
|
|
5117
5126
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -5145,13 +5154,14 @@ module Google
|
|
|
5145
5154
|
|
|
5146
5155
|
# Deletes a FHIR resource. Implements the FHIR standard delete interaction ([
|
|
5147
5156
|
# 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/
|
|
5157
|
+
# fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete), [
|
|
5158
|
+
# R5](https://hl7.org/fhir/R5/http.html#delete)). Note: Unless resource
|
|
5159
|
+
# versioning is disabled by setting the disable_resource_versioning flag on the
|
|
5160
|
+
# FHIR store, the deleted resources will be moved to a history repository that
|
|
5161
|
+
# can still be retrieved through vread and related methods, unless they are
|
|
5162
|
+
# removed by the purge method. For samples that show how to call `delete`, see [
|
|
5163
|
+
# Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
|
5164
|
+
# fhir-resources#deleting_a_fhir_resource).
|
|
5155
5165
|
# @param [String] name
|
|
5156
5166
|
# Required. The name of the resource to delete.
|
|
5157
5167
|
# @param [String] fields
|
|
@@ -5184,30 +5194,32 @@ module Google
|
|
|
5184
5194
|
# Executes all the requests in the given Bundle. Implements the FHIR standard
|
|
5185
5195
|
# batch/transaction interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#
|
|
5186
5196
|
# 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
|
|
5197
|
+
# https://hl7.org/fhir/R4/http.html#transaction), [R5](https://hl7.org/fhir/R5/
|
|
5198
|
+
# http.html#transaction)). Supports all interactions within a bundle, except
|
|
5199
|
+
# search. This method accepts Bundles of type `batch` and `transaction`,
|
|
5200
|
+
# processing them according to the batch processing rules ([DSTU2](https://hl7.
|
|
5201
|
+
# org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.
|
|
5202
|
+
# html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules), [R5](https:/
|
|
5203
|
+
# /hl7.org/fhir/R5/http.html#brules)) and transaction processing rules ([DSTU2](
|
|
5204
|
+
# https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/
|
|
5205
|
+
# STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules), [
|
|
5206
|
+
# R5](https://hl7.org/fhir/R5/http.html#trules)). The request body must contain
|
|
5207
|
+
# a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `
|
|
5208
|
+
# Content-Type: application/fhir+json`. For a batch bundle or a successful
|
|
5209
|
+
# transaction, the response body contains a JSON-encoded representation of a `
|
|
5210
|
+
# Bundle` resource of type `batch-response` or `transaction-response` containing
|
|
5211
|
+
# one entry for each entry in the request, with the outcome of processing the
|
|
5212
|
+
# entry. In the case of an error for a transaction bundle, the response body
|
|
5213
|
+
# contains a JSON-encoded `OperationOutcome` resource describing the reason for
|
|
5214
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
|
5215
|
+
# store, a generic GCP error might be returned instead. This method checks
|
|
5216
|
+
# permissions for each request in the bundle. The `executeBundle` permission is
|
|
5217
|
+
# required to call this method, but you must also grant sufficient permissions
|
|
5218
|
+
# to execute the individual requests in the bundle. For example, if the bundle
|
|
5219
|
+
# contains a request to create a FHIR resource, the caller must also have been
|
|
5220
|
+
# granted the `healthcare.fhirResources.create` permission. You can use audit
|
|
5221
|
+
# logs to view the permissions for `executeBundle` and each request in the
|
|
5222
|
+
# bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.
|
|
5211
5223
|
# google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show
|
|
5212
5224
|
# how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](
|
|
5213
5225
|
# https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).
|
|
@@ -5247,12 +5259,13 @@ module Google
|
|
|
5247
5259
|
# deleted versions) from the FHIR store. Implements the per-resource form of the
|
|
5248
5260
|
# FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.
|
|
5249
5261
|
# 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
|
-
#
|
|
5262
|
+
# //hl7.org/fhir/R4/http.html#history), [R5](https://hl7.org/fhir/R5/http.html#
|
|
5263
|
+
# history)). On success, the response body contains a JSON-encoded
|
|
5264
|
+
# representation of a `Bundle` resource of type `history`, containing the
|
|
5265
|
+
# version history sorted from most recent to oldest versions. Errors generated
|
|
5266
|
+
# by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
5267
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
5268
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
5256
5269
|
# instead. For samples that show how to call `history`, see [Listing FHIR
|
|
5257
5270
|
# resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
5258
5271
|
# resources#listing_fhir_resource_versions).
|
|
@@ -5312,17 +5325,18 @@ module Google
|
|
|
5312
5325
|
# Updates part of an existing resource by applying the operations specified in a
|
|
5313
5326
|
# [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard
|
|
5314
5327
|
# 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/
|
|
5328
|
+
# https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.
|
|
5329
|
+
# html#patch)). DSTU2 doesn't define a patch method, but the server supports it
|
|
5330
|
+
# in the same way it supports STU3. The request body must contain a JSON Patch
|
|
5331
|
+
# document, and the request headers must contain `Content-Type: application/json-
|
|
5332
|
+
# patch+json`. On success, the response body contains a JSON-encoded
|
|
5333
|
+
# representation of the updated resource, including the server-assigned version
|
|
5334
|
+
# ID. Errors generated by the FHIR store contain a JSON-encoded `
|
|
5335
|
+
# OperationOutcome` resource describing the reason for the error. If the request
|
|
5336
|
+
# cannot be mapped to a valid API method on a FHIR store, a generic GCP error
|
|
5337
|
+
# might be returned instead. For samples that show how to call `patch`, see [
|
|
5338
|
+
# Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
|
5339
|
+
# fhir-resources#patching_a_fhir_resource).
|
|
5326
5340
|
# @param [String] name
|
|
5327
5341
|
# Required. The name of the resource to update.
|
|
5328
5342
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
|
@@ -5358,17 +5372,19 @@ module Google
|
|
|
5358
5372
|
# Gets the contents of a FHIR resource. Implements the FHIR standard read
|
|
5359
5373
|
# interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https:/
|
|
5360
5374
|
# /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
|
-
#
|
|
5375
|
+
# read), [R5](https://hl7.org/fhir/R5/http.html#read)). Also supports the FHIR
|
|
5376
|
+
# standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.
|
|
5377
|
+
# html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://
|
|
5378
|
+
# hl7.org/fhir/R4/http.html#cread), [R5](https://hl7.org/fhir/R5/http.html#cread)
|
|
5379
|
+
# ) specified by supplying an `If-Modified-Since` header with a date/time value
|
|
5380
|
+
# or an `If-None-Match` header with an ETag value. On success, the response body
|
|
5381
|
+
# contains a JSON-encoded representation of the resource. Errors generated by
|
|
5382
|
+
# the FHIR store contain a JSON-encoded `OperationOutcome` resource describing
|
|
5383
|
+
# the reason for the error. If the request cannot be mapped to a valid API
|
|
5384
|
+
# method on a FHIR store, a generic GCP error might be returned instead. For
|
|
5385
|
+
# samples that show how to call `read`, see [Getting a FHIR resource](https://
|
|
5386
|
+
# cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
|
5387
|
+
# getting_a_fhir_resource).
|
|
5372
5388
|
# @param [String] name
|
|
5373
5389
|
# Required. The name of the resource to retrieve.
|
|
5374
5390
|
# @param [String] fields
|
|
@@ -5401,63 +5417,65 @@ module Google
|
|
|
5401
5417
|
# Searches for resources in the given FHIR store according to criteria specified
|
|
5402
5418
|
# as query parameters. Implements the FHIR standard search interaction ([DSTU2](
|
|
5403
5419
|
# 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
|
-
#
|
|
5420
|
+
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https:/
|
|
5421
|
+
# /hl7.org/fhir/R5/http.html#search)) using the search semantics described in
|
|
5422
|
+
# the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html),
|
|
5423
|
+
# [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/
|
|
5424
|
+
# search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four
|
|
5425
|
+
# methods of search defined by the specification: * `GET [base]?[parameters]` to
|
|
5426
|
+
# search across all resources. * `GET [base]/[type]?[parameters]` to search
|
|
5427
|
+
# resources of a specified type. * `POST [base]/_search?[parameters]` as an
|
|
5428
|
+
# alternate form having the same semantics as the `GET` method across all
|
|
5429
|
+
# resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form
|
|
5430
|
+
# having the same semantics as the `GET` method for the specified type. The `GET`
|
|
5431
|
+
# and `POST` methods do not support compartment searches. The `POST` method
|
|
5432
|
+
# does not support `application/x-www-form-urlencoded` search parameters. On
|
|
5433
|
+
# success, the response body contains a JSON-encoded representation of a `Bundle`
|
|
5434
|
+
# resource of type `searchset`, containing the results of the search. Errors
|
|
5435
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
5436
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
5437
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
5438
|
+
# instead. The server's capability statement, retrieved through capabilities,
|
|
5439
|
+
# indicates what search parameters are supported on each FHIR resource. A list
|
|
5440
|
+
# of all search parameters defined by the specification can be found in the FHIR
|
|
5441
|
+
# Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-
|
|
5442
|
+
# registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [
|
|
5443
|
+
# R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search
|
|
5444
|
+
# parameters for DSTU2 can be found on each resource's definition page.
|
|
5427
5445
|
# Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
|
|
5428
5446
|
# `: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).
|
|
5447
|
+
# STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `
|
|
5448
|
+
# _count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `
|
|
5449
|
+
# _elements`. The maximum number of search results returned defaults to 100,
|
|
5450
|
+
# which can be overridden by the `_count` parameter up to a maximum limit of
|
|
5451
|
+
# 1000. The server might return fewer resources than requested to prevent
|
|
5452
|
+
# excessively large responses. If there are additional results, the returned `
|
|
5453
|
+
# Bundle` contains a link of `relation` "next", which has a `_page_token`
|
|
5454
|
+
# parameter for an opaque pagination token that can be used to retrieve the next
|
|
5455
|
+
# page. Resources with a total size larger than 5MB or a field count larger than
|
|
5456
|
+
# 50,000 might not be fully searchable as the server might trim its generated
|
|
5457
|
+
# search index in those cases. Note: FHIR resources are indexed asynchronously,
|
|
5458
|
+
# so there might be a slight delay between the time a resource is created or
|
|
5459
|
+
# changed, and the time when the change reflects in search results. The only
|
|
5460
|
+
# exception is resource identifier data, which is indexed synchronously as a
|
|
5461
|
+
# special index. As a result, searching using resource identifier is not subject
|
|
5462
|
+
# to indexing delay. To use the special synchronous index, the search term for
|
|
5463
|
+
# identifier should be in the pattern `identifier=[system]|[value]` or `
|
|
5464
|
+
# identifier=[value]`, and any of the following search result parameters can be
|
|
5465
|
+
# used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If
|
|
5466
|
+
# your query contains any other search parameters, the standard asynchronous
|
|
5467
|
+
# index will be used instead. Note that searching against the special index is
|
|
5468
|
+
# optimized for resolving a small number of matches. The search isn't optimized
|
|
5469
|
+
# if your identifier search criteria matches a large number (i.e. more than 2,
|
|
5470
|
+
# 000) of resources. For a search query that will match a large number of
|
|
5471
|
+
# resources, you can avoiding using the special synchronous index by including
|
|
5472
|
+
# an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if
|
|
5473
|
+
# you want to keep the default sorting order. Note: The special synchronous
|
|
5474
|
+
# identifier index are currently disabled for DocumentReference and
|
|
5475
|
+
# DocumentManifest searches. For samples and detailed information, see [
|
|
5476
|
+
# Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/
|
|
5477
|
+
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
|
5478
|
+
# healthcare/docs/how-tos/fhir-advanced-search).
|
|
5461
5479
|
# @param [String] parent
|
|
5462
5480
|
# Required. Name of the FHIR store to retrieve resources from.
|
|
5463
5481
|
# @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
|
|
@@ -5493,70 +5511,73 @@ module Google
|
|
|
5493
5511
|
# Searches for resources in the given FHIR store according to criteria specified
|
|
5494
5512
|
# as query parameters. Implements the FHIR standard search interaction ([DSTU2](
|
|
5495
5513
|
# 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
|
-
#
|
|
5514
|
+
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https:/
|
|
5515
|
+
# /hl7.org/fhir/R5/http.html#search)) using the search semantics described in
|
|
5516
|
+
# the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html),
|
|
5517
|
+
# [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/
|
|
5518
|
+
# search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four
|
|
5519
|
+
# methods of search defined by the specification: * `GET [base]?[parameters]` to
|
|
5520
|
+
# search across all resources. * `GET [base]/[type]?[parameters]` to search
|
|
5521
|
+
# resources of a specified type. * `POST [base]/_search?[parameters]` as an
|
|
5522
|
+
# alternate form having the same semantics as the `GET` method across all
|
|
5523
|
+
# resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form
|
|
5524
|
+
# having the same semantics as the `GET` method for the specified type. The `GET`
|
|
5525
|
+
# and `POST` methods do not support compartment searches. The `POST` method
|
|
5526
|
+
# does not support `application/x-www-form-urlencoded` search parameters. On
|
|
5527
|
+
# success, the response body contains a JSON-encoded representation of a `Bundle`
|
|
5528
|
+
# resource of type `searchset`, containing the results of the search. Errors
|
|
5529
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
5530
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
5531
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
5532
|
+
# instead. The server's capability statement, retrieved through capabilities,
|
|
5533
|
+
# indicates what search parameters are supported on each FHIR resource. A list
|
|
5534
|
+
# of all search parameters defined by the specification can be found in the FHIR
|
|
5535
|
+
# Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-
|
|
5536
|
+
# registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [
|
|
5537
|
+
# R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search
|
|
5538
|
+
# parameters for DSTU2 can be found on each resource's definition page.
|
|
5519
5539
|
# Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
|
|
5520
5540
|
# `: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).
|
|
5541
|
+
# STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `
|
|
5542
|
+
# _count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `
|
|
5543
|
+
# _elements`. The maximum number of search results returned defaults to 100,
|
|
5544
|
+
# which can be overridden by the `_count` parameter up to a maximum limit of
|
|
5545
|
+
# 1000. The server might return fewer resources than requested to prevent
|
|
5546
|
+
# excessively large responses. If there are additional results, the returned `
|
|
5547
|
+
# Bundle` contains a link of `relation` "next", which has a `_page_token`
|
|
5548
|
+
# parameter for an opaque pagination token that can be used to retrieve the next
|
|
5549
|
+
# page. Resources with a total size larger than 5MB or a field count larger than
|
|
5550
|
+
# 50,000 might not be fully searchable as the server might trim its generated
|
|
5551
|
+
# search index in those cases. Note: FHIR resources are indexed asynchronously,
|
|
5552
|
+
# so there might be a slight delay between the time a resource is created or
|
|
5553
|
+
# changed, and the time when the change reflects in search results. The only
|
|
5554
|
+
# exception is resource identifier data, which is indexed synchronously as a
|
|
5555
|
+
# special index. As a result, searching using resource identifier is not subject
|
|
5556
|
+
# to indexing delay. To use the special synchronous index, the search term for
|
|
5557
|
+
# identifier should be in the pattern `identifier=[system]|[value]` or `
|
|
5558
|
+
# identifier=[value]`, and any of the following search result parameters can be
|
|
5559
|
+
# used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If
|
|
5560
|
+
# your query contains any other search parameters, the standard asynchronous
|
|
5561
|
+
# index will be used instead. Note that searching against the special index is
|
|
5562
|
+
# optimized for resolving a small number of matches. The search isn't optimized
|
|
5563
|
+
# if your identifier search criteria matches a large number (i.e. more than 2,
|
|
5564
|
+
# 000) of resources. For a search query that will match a large number of
|
|
5565
|
+
# resources, you can avoiding using the special synchronous index by including
|
|
5566
|
+
# an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if
|
|
5567
|
+
# you want to keep the default sorting order. Note: The special synchronous
|
|
5568
|
+
# identifier index are currently disabled for DocumentReference and
|
|
5569
|
+
# DocumentManifest searches. For samples and detailed information, see [
|
|
5570
|
+
# Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/
|
|
5571
|
+
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
|
5572
|
+
# healthcare/docs/how-tos/fhir-advanced-search).
|
|
5553
5573
|
# @param [String] parent
|
|
5554
5574
|
# Required. Name of the FHIR store to retrieve resources from.
|
|
5555
5575
|
# @param [String] resource_type
|
|
5556
5576
|
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
|
5557
5577
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
5558
5578
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
5559
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)).
|
|
5579
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)), [R5](https://hl7.org/fhir/R5/
|
|
5580
|
+
# resourcelist.html)).
|
|
5560
5581
|
# @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
|
|
5561
5582
|
# @param [String] fields
|
|
5562
5583
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -5591,23 +5612,25 @@ module Google
|
|
|
5591
5612
|
# Updates the entire contents of a resource. Implements the FHIR standard update
|
|
5592
5613
|
# interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](
|
|
5593
5614
|
# 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
|
-
#
|
|
5615
|
+
# html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the
|
|
5616
|
+
# specified resource does not exist and the FHIR store has enable_update_create
|
|
5617
|
+
# set, creates the resource with the client-specified ID. It is strongly advised
|
|
5618
|
+
# not to include or encode any sensitive data such as patient identifiers in
|
|
5619
|
+
# client-specified resource IDs. Those IDs are part of the FHIR resource path
|
|
5620
|
+
# recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
|
|
5621
|
+
# contained in reference fields within other resources. The request body must
|
|
5622
|
+
# contain a JSON-encoded FHIR resource, and the request headers must contain `
|
|
5623
|
+
# Content-Type: application/fhir+json`. The resource must contain an `id`
|
|
5624
|
+
# element having an identical value to the ID in the REST path of the request.
|
|
5625
|
+
# On success, the response body contains a JSON-encoded representation of the
|
|
5626
|
+
# updated resource, including the server-assigned version ID. Errors generated
|
|
5627
|
+
# by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
5628
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
5629
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
5630
|
+
# instead. In R5, the conditional update interaction If-None-Match is supported,
|
|
5631
|
+
# including the wildcard behaviour. For samples that show how to call `update`,
|
|
5632
|
+
# see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-
|
|
5633
|
+
# tos/fhir-resources#updating_a_fhir_resource).
|
|
5611
5634
|
# @param [String] name
|
|
5612
5635
|
# Required. The name of the resource to update.
|
|
5613
5636
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
|
@@ -5643,14 +5666,15 @@ module Google
|
|
|
5643
5666
|
# Gets the contents of a version (current or historical) of a FHIR resource by
|
|
5644
5667
|
# version ID. Implements the FHIR standard vread interaction ([DSTU2](https://
|
|
5645
5668
|
# 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#
|
|
5669
|
+
# html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread), [R5](https://hl7.
|
|
5670
|
+
# org/fhir/R5/http.html#vread)). On success, the response body contains a JSON-
|
|
5671
|
+
# encoded representation of the resource. Errors generated by the FHIR store
|
|
5672
|
+
# contain a JSON-encoded `OperationOutcome` resource describing the reason for
|
|
5673
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
|
5674
|
+
# store, a generic GCP error might be returned instead. For samples that show
|
|
5675
|
+
# how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.
|
|
5676
|
+
# google.com/healthcare/docs/how-tos/fhir-resources#
|
|
5677
|
+
# retrieving_a_fhir_resource_version).
|
|
5654
5678
|
# @param [String] name
|
|
5655
5679
|
# Required. The name of the resource version to retrieve.
|
|
5656
5680
|
# @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.76.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.76.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: []
|