google-apis-healthcare_v1beta1 0.80.0 → 0.81.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: 17adb36629cd41cf5e68a66ae63186ca899adfb2686cb501715e0727e9a1d7ec
|
|
4
|
+
data.tar.gz: d384b1e6af49bc1816114d71d385b91c0b8fe50d91d5cec323c658be84959db4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a9f84eda5543c5afe034f3bcf0fc2e49222f4d70496c59c12a895496b9b4e4330eb172e0d604c194b810d1a272f5b5d79d20a2df0eaf409c6069e9453bd9c90a
|
|
7
|
+
data.tar.gz: 37ce2f2a4c689ab21f4580987d94b619fd999076f82f9f9a232c392853e86e88db35e134a75e3be6595fa95ca43f85869d52bd8db88fa820691b2d5a5235b68b
|
data/CHANGELOG.md
CHANGED
|
@@ -6968,10 +6968,9 @@ module Google
|
|
|
6968
6968
|
include Google::Apis::Core::Hashable
|
|
6969
6969
|
|
|
6970
6970
|
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
|
6971
|
-
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
|
6972
|
-
#
|
|
6973
|
-
#
|
|
6974
|
-
# implement/standards/fhir/R4/resourcelist.html)).
|
|
6971
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6972
|
+
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6973
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)).
|
|
6975
6974
|
# Corresponds to the JSON property `resourceType`
|
|
6976
6975
|
# @return [String]
|
|
6977
6976
|
attr_accessor :resource_type
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module HealthcareV1beta1
|
|
18
18
|
# Version of the google-apis-healthcare_v1beta1 gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.81.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.17.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20250430"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -5525,23 +5525,22 @@ module Google
|
|
|
5525
5525
|
end
|
|
5526
5526
|
|
|
5527
5527
|
# Retrieves an Encounter resource and resources related to that Encounter.
|
|
5528
|
-
# Implements the FHIR extended operation Encounter-everything ([DSTU2](
|
|
5529
|
-
# hl7.org/
|
|
5530
|
-
#
|
|
5531
|
-
#
|
|
5532
|
-
#
|
|
5533
|
-
#
|
|
5534
|
-
#
|
|
5535
|
-
#
|
|
5536
|
-
#
|
|
5537
|
-
#
|
|
5538
|
-
#
|
|
5539
|
-
#
|
|
5540
|
-
#
|
|
5541
|
-
#
|
|
5542
|
-
#
|
|
5543
|
-
#
|
|
5544
|
-
# compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/
|
|
5528
|
+
# Implements the FHIR extended operation Encounter-everything ([DSTU2](https://
|
|
5529
|
+
# hl7.org/fhir/DSTU2/encounter-operations.html#everything), [STU3](https://hl7.
|
|
5530
|
+
# org/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/
|
|
5531
|
+
# fhir/R4/encounter-operation-everything.html). On success, the response body
|
|
5532
|
+
# contains a JSON-encoded representation of a `Bundle` resource of type `
|
|
5533
|
+
# searchset`, containing the results of the operation. Errors generated by the
|
|
5534
|
+
# FHIR store contain a JSON-encoded `OperationOutcome` resource describing the
|
|
5535
|
+
# reason for the error. If the request cannot be mapped to a valid API method on
|
|
5536
|
+
# a FHIR store, a generic GCP error might be returned instead. The resources in
|
|
5537
|
+
# scope for the response are: * The Encounter resource itself. * All the
|
|
5538
|
+
# resources directly referenced by the Encounter resource, including attachments
|
|
5539
|
+
# and binaries. * Resources directly referencing the Encounter resource that
|
|
5540
|
+
# meet the inclusion criteria. The inclusion criteria are based on the
|
|
5541
|
+
# membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.
|
|
5542
|
+
# org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/
|
|
5543
|
+
# stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/
|
|
5545
5544
|
# compartmentdefinition-encounter.html)), which details the eligible resource
|
|
5546
5545
|
# types and referencing search parameters. * Resources referencing to the
|
|
5547
5546
|
# Encounter resource through the "http://hl7.org/fhir/StructureDefinition/
|
|
@@ -5602,26 +5601,25 @@ module Google
|
|
|
5602
5601
|
# Retrieves the N most recent `Observation` resources for a subject matching
|
|
5603
5602
|
# search criteria specified as query parameters, grouped by `Observation.code`,
|
|
5604
5603
|
# sorted from most recent to oldest. Implements the FHIR extended operation
|
|
5605
|
-
# Observation-lastn ([STU3](https://hl7.org/
|
|
5606
|
-
#
|
|
5607
|
-
#
|
|
5608
|
-
#
|
|
5609
|
-
#
|
|
5610
|
-
#
|
|
5611
|
-
#
|
|
5612
|
-
#
|
|
5613
|
-
#
|
|
5614
|
-
#
|
|
5615
|
-
#
|
|
5616
|
-
#
|
|
5617
|
-
#
|
|
5618
|
-
#
|
|
5619
|
-
#
|
|
5620
|
-
#
|
|
5621
|
-
#
|
|
5622
|
-
#
|
|
5623
|
-
#
|
|
5624
|
-
# GCP error might be returned instead.
|
|
5604
|
+
# Observation-lastn ([STU3](https://hl7.org/fhir/STU3/observation-operations.
|
|
5605
|
+
# html#lastn), [R4](https://hl7.org/fhir/R4/observation-operation-lastn.html)).
|
|
5606
|
+
# DSTU2 doesn't define the Observation-lastn method, but the server supports it
|
|
5607
|
+
# the same way it supports STU3. Search terms are provided as query parameters
|
|
5608
|
+
# following the same pattern as the search method. The following search
|
|
5609
|
+
# parameters must be provided: - `subject` or `patient` to specify a subject for
|
|
5610
|
+
# the Observation. - `code`, `category` or any of the composite parameters that
|
|
5611
|
+
# include `code`. Any other valid Observation search parameters can also be
|
|
5612
|
+
# provided. This operation accepts an additional query parameter `max`, which
|
|
5613
|
+
# specifies N, the maximum number of Observations to return from each group,
|
|
5614
|
+
# with a default of 1. Searches with over 1000 results are rejected. Results are
|
|
5615
|
+
# counted before grouping and limiting the results with `max`. To stay within
|
|
5616
|
+
# the limit, constrain these searches using Observation search parameters such
|
|
5617
|
+
# as `_lastUpdated` or `date`. On success, the response body contains a JSON-
|
|
5618
|
+
# encoded representation of a `Bundle` resource of type `searchset`, containing
|
|
5619
|
+
# the results of the operation. Errors generated by the FHIR store contain a
|
|
5620
|
+
# JSON-encoded `OperationOutcome` resource describing the reason for the error.
|
|
5621
|
+
# If the request cannot be mapped to a valid API method on a FHIR store, a
|
|
5622
|
+
# generic GCP error might be returned instead.
|
|
5625
5623
|
# @param [String] parent
|
|
5626
5624
|
# Required. Name of the FHIR store to retrieve resources from.
|
|
5627
5625
|
# @param [String] fields
|
|
@@ -5700,11 +5698,10 @@ module Google
|
|
|
5700
5698
|
end
|
|
5701
5699
|
|
|
5702
5700
|
# Retrieves a Patient resource and resources related to that patient. Implements
|
|
5703
|
-
# the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/
|
|
5704
|
-
#
|
|
5705
|
-
# https://hl7.org/
|
|
5706
|
-
# everything),
|
|
5707
|
-
# operations.html#everything)). On success, the response body contains a JSON-
|
|
5701
|
+
# the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/
|
|
5702
|
+
# DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/
|
|
5703
|
+
# patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-
|
|
5704
|
+
# operation-everything.html)). On success, the response body contains a JSON-
|
|
5708
5705
|
# encoded representation of a `Bundle` resource of type `searchset`, containing
|
|
5709
5706
|
# the results of the operation. Errors generated by the FHIR store contain a
|
|
5710
5707
|
# JSON-encoded `OperationOutcome` resource describing the reason for the error.
|
|
@@ -5886,28 +5883,27 @@ module Google
|
|
|
5886
5883
|
|
|
5887
5884
|
# Validates an input FHIR resource's conformance to its profiles and the
|
|
5888
5885
|
# profiles configured on the FHIR store. Implements the FHIR extended operation $
|
|
5889
|
-
# validate ([DSTU2](
|
|
5890
|
-
#
|
|
5891
|
-
# resource-
|
|
5892
|
-
#
|
|
5893
|
-
#
|
|
5894
|
-
#
|
|
5895
|
-
#
|
|
5896
|
-
#
|
|
5897
|
-
#
|
|
5898
|
-
#
|
|
5899
|
-
#
|
|
5900
|
-
#
|
|
5886
|
+
# validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate)
|
|
5887
|
+
# , [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), or [R4](
|
|
5888
|
+
# https://hl7.org/fhir/R4/resource-operation-validate.html)). The request body
|
|
5889
|
+
# must contain a JSON-encoded FHIR resource, and the request headers must
|
|
5890
|
+
# contain `Content-Type: application/fhir+json`. The `Parameters` input syntax
|
|
5891
|
+
# is not supported. The `profile` query parameter can be used to request that
|
|
5892
|
+
# the resource only be validated against a specific profile. If a profile with
|
|
5893
|
+
# the given URL cannot be found in the FHIR store then an error is returned.
|
|
5894
|
+
# Errors generated by validation contain a JSON-encoded `OperationOutcome`
|
|
5895
|
+
# resource describing the reason for the error. If the request cannot be mapped
|
|
5896
|
+
# to a valid API method on a FHIR store, a generic GCP error might be returned
|
|
5897
|
+
# instead.
|
|
5901
5898
|
# @param [String] parent
|
|
5902
5899
|
# Required. The name of the FHIR store that holds the profiles being used for
|
|
5903
5900
|
# validation.
|
|
5904
5901
|
# @param [String] type
|
|
5905
5902
|
# Required. The FHIR resource type of the resource being validated. For a
|
|
5906
|
-
# complete list, see the FHIR Resource Index ([DSTU2](
|
|
5907
|
-
#
|
|
5908
|
-
#
|
|
5909
|
-
#
|
|
5910
|
-
# provided content.
|
|
5903
|
+
# complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/
|
|
5904
|
+
# resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), or [
|
|
5905
|
+
# R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type
|
|
5906
|
+
# in the provided content.
|
|
5911
5907
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
5912
5908
|
# @param [String] profile
|
|
5913
5909
|
# Optional. The canonical URL of a profile that this resource should be
|
|
@@ -6016,17 +6012,16 @@ module Google
|
|
|
6016
6012
|
execute_or_queue_command(command, &block)
|
|
6017
6013
|
end
|
|
6018
6014
|
|
|
6019
|
-
# Gets the FHIR capability statement ([STU3](https://hl7.org/
|
|
6020
|
-
#
|
|
6021
|
-
#
|
|
6022
|
-
#
|
|
6023
|
-
#
|
|
6024
|
-
#
|
|
6025
|
-
#
|
|
6026
|
-
#
|
|
6027
|
-
#
|
|
6028
|
-
#
|
|
6029
|
-
# encoded representation of a `CapabilityStatement` resource.
|
|
6015
|
+
# Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/
|
|
6016
|
+
# capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.
|
|
6017
|
+
# html)), or the [conformance statement](https://hl7.org/fhir/DSTU2/conformance.
|
|
6018
|
+
# html) in the DSTU2 case for the store, which contains a description of
|
|
6019
|
+
# functionality supported by the server. Implements the FHIR standard
|
|
6020
|
+
# capabilities interaction ([STU3](https://hl7.org/fhir/STU3/http.html#
|
|
6021
|
+
# capabilities), [R4](https://hl7.org/fhir/R4/http.html#capabilities)), or the [
|
|
6022
|
+
# conformance interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in
|
|
6023
|
+
# the DSTU2 case. On success, the response body contains a JSON-encoded
|
|
6024
|
+
# representation of a `CapabilityStatement` resource.
|
|
6030
6025
|
# @param [String] name
|
|
6031
6026
|
# Required. Name of the FHIR store to retrieve the capabilities for.
|
|
6032
6027
|
# @param [String] fields
|
|
@@ -6057,18 +6052,17 @@ module Google
|
|
|
6057
6052
|
end
|
|
6058
6053
|
|
|
6059
6054
|
# Deletes FHIR resources that match a search query. Implements the FHIR standard
|
|
6060
|
-
# conditional delete interaction ([DSTU2](https://hl7.org/
|
|
6061
|
-
#
|
|
6062
|
-
# fhir/
|
|
6063
|
-
#
|
|
6064
|
-
#
|
|
6065
|
-
# the
|
|
6066
|
-
#
|
|
6067
|
-
#
|
|
6068
|
-
#
|
|
6069
|
-
#
|
|
6070
|
-
#
|
|
6071
|
-
# Unless resource versioning is disabled by setting the
|
|
6055
|
+
# conditional delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.
|
|
6056
|
+
# 1.0.12.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.13.1), [R4](https:
|
|
6057
|
+
# //hl7.org/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all
|
|
6058
|
+
# matching resources are deleted. Search terms are provided as query parameters
|
|
6059
|
+
# following the same pattern as the search method. Not all FHIR resources that
|
|
6060
|
+
# match the search query might be deleted because, by default, a maximum of 100
|
|
6061
|
+
# FHIR resources can be deleted. The number of FHIR resources that can be
|
|
6062
|
+
# deleted depends on the page size of the returned resources, which you can
|
|
6063
|
+
# control using the `_count` query parameter. Even when using `_count`, you can
|
|
6064
|
+
# delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`.
|
|
6065
|
+
# Note: Unless resource versioning is disabled by setting the
|
|
6072
6066
|
# disable_resource_versioning flag on the FHIR store, the deleted resources are
|
|
6073
6067
|
# moved to a history repository that can still be retrieved through vread and
|
|
6074
6068
|
# related methods, unless they are removed by the purge method. This method
|
|
@@ -6081,10 +6075,9 @@ module Google
|
|
|
6081
6075
|
# Required. The name of the FHIR store this resource belongs to.
|
|
6082
6076
|
# @param [String] type
|
|
6083
6077
|
# Required. The FHIR resource type to delete, such as Patient or Observation.
|
|
6084
|
-
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
|
6085
|
-
#
|
|
6086
|
-
#
|
|
6087
|
-
# implement/standards/fhir/R4/resourcelist.html)).
|
|
6078
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6079
|
+
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6080
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)).
|
|
6088
6081
|
# @param [String] fields
|
|
6089
6082
|
# Selector specifying which fields to include in a partial response.
|
|
6090
6083
|
# @param [String] quota_user
|
|
@@ -6116,33 +6109,31 @@ module Google
|
|
|
6116
6109
|
# If a resource is found based on the search criteria specified in the query
|
|
6117
6110
|
# parameters, updates part of that resource by applying the operations specified
|
|
6118
6111
|
# in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR
|
|
6119
|
-
# standard conditional patch interaction ([STU3](https://hl7.org/
|
|
6120
|
-
#
|
|
6121
|
-
#
|
|
6122
|
-
#
|
|
6123
|
-
#
|
|
6124
|
-
#
|
|
6125
|
-
#
|
|
6126
|
-
#
|
|
6127
|
-
#
|
|
6128
|
-
#
|
|
6129
|
-
#
|
|
6130
|
-
#
|
|
6131
|
-
#
|
|
6132
|
-
#
|
|
6133
|
-
#
|
|
6134
|
-
#
|
|
6135
|
-
#
|
|
6136
|
-
#
|
|
6137
|
-
# resources#conditionally_patching_a_fhir_resource).
|
|
6112
|
+
# standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.
|
|
6113
|
+
# html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't
|
|
6114
|
+
# define a conditional patch method, but the server supports it in the same way
|
|
6115
|
+
# it supports STU3. Search terms are provided as query parameters following the
|
|
6116
|
+
# same pattern as the search method. If the search criteria identify more than
|
|
6117
|
+
# one match, the request returns a `412 Precondition Failed` error. The request
|
|
6118
|
+
# body must contain a JSON Patch document, and the request headers must contain `
|
|
6119
|
+
# Content-Type: application/json-patch+json`. On success, the response body
|
|
6120
|
+
# contains a JSON-encoded representation of the updated resource, including the
|
|
6121
|
+
# server-assigned version ID. Errors generated by the FHIR store contain a JSON-
|
|
6122
|
+
# encoded `OperationOutcome` resource describing the reason for the error. If
|
|
6123
|
+
# the request cannot be mapped to a valid API method on a FHIR store, a generic
|
|
6124
|
+
# GCP error might be returned instead. This method requires the`healthcare.
|
|
6125
|
+
# fhirStores.searchResources` permission on the parent FHIR store and the `
|
|
6126
|
+
# healthcare.fhirResources.patch` permission on the requested FHIR store
|
|
6127
|
+
# resource. For samples that show how to call `conditionalPatch`, see [
|
|
6128
|
+
# Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/
|
|
6129
|
+
# docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).
|
|
6138
6130
|
# @param [String] parent
|
|
6139
6131
|
# Required. The name of the FHIR store this resource belongs to.
|
|
6140
6132
|
# @param [String] type
|
|
6141
6133
|
# Required. The FHIR resource type to update, such as Patient or Observation.
|
|
6142
|
-
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
|
6143
|
-
#
|
|
6144
|
-
#
|
|
6145
|
-
# implement/standards/fhir/R4/resourcelist.html)).
|
|
6134
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6135
|
+
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6136
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)).
|
|
6146
6137
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
6147
6138
|
# @param [String] fields
|
|
6148
6139
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -6176,41 +6167,39 @@ module Google
|
|
|
6176
6167
|
|
|
6177
6168
|
# If a resource is found based on the search criteria specified in the query
|
|
6178
6169
|
# parameters, updates the entire contents of that resource. Implements the FHIR
|
|
6179
|
-
# standard conditional update interaction ([DSTU2](https://hl7.org/
|
|
6180
|
-
#
|
|
6181
|
-
#
|
|
6182
|
-
#
|
|
6183
|
-
#
|
|
6184
|
-
#
|
|
6185
|
-
#
|
|
6186
|
-
#
|
|
6187
|
-
#
|
|
6188
|
-
#
|
|
6189
|
-
#
|
|
6190
|
-
#
|
|
6191
|
-
#
|
|
6192
|
-
#
|
|
6193
|
-
# the
|
|
6194
|
-
#
|
|
6195
|
-
#
|
|
6196
|
-
#
|
|
6197
|
-
#
|
|
6198
|
-
#
|
|
6199
|
-
#
|
|
6200
|
-
#
|
|
6201
|
-
# healthcare.
|
|
6202
|
-
#
|
|
6203
|
-
#
|
|
6204
|
-
#
|
|
6205
|
-
# conditionally_updating_a_fhir_resource).
|
|
6170
|
+
# standard conditional update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/
|
|
6171
|
+
# http.html#2.1.0.10.2), [STU3](https://hl7.org/fhir/STU3/http.html#cond-update),
|
|
6172
|
+
# [R4](https://hl7.org/fhir/R4/http.html#cond-update)). Search terms are
|
|
6173
|
+
# provided as query parameters following the same pattern as the search method.
|
|
6174
|
+
# If the search criteria identify more than one match, the request returns a `
|
|
6175
|
+
# 412 Precondition Failed` error. If the search criteria identify zero matches,
|
|
6176
|
+
# and the supplied resource body contains an `id`, and the FHIR store has
|
|
6177
|
+
# enable_update_create set, creates the resource with the client-specified ID.
|
|
6178
|
+
# It is strongly advised not to include or encode any sensitive data such as
|
|
6179
|
+
# patient identifiers in client-specified resource IDs. Those IDs are part of
|
|
6180
|
+
# the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications.
|
|
6181
|
+
# Those IDs can also be contained in reference fields within other resources. If
|
|
6182
|
+
# the search criteria identify zero matches, and the supplied resource body does
|
|
6183
|
+
# not contain an `id`, the resource is created with a server-assigned ID as per
|
|
6184
|
+
# the create method. The request body must contain a JSON-encoded FHIR resource,
|
|
6185
|
+
# and the request headers must contain `Content-Type: application/fhir+json`. On
|
|
6186
|
+
# success, the response body contains a JSON-encoded representation of the
|
|
6187
|
+
# updated resource, including the server-assigned version ID. Errors generated
|
|
6188
|
+
# by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
6189
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
6190
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
6191
|
+
# instead. This method requires the`healthcare.fhirStores.searchResources` and `
|
|
6192
|
+
# healthcare.fhirResources.update` permissions on the parent FHIR store. For
|
|
6193
|
+
# samples that show how to call `conditionalUpdate`, see [Conditionally updating
|
|
6194
|
+
# a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
6195
|
+
# resources#conditionally_updating_a_fhir_resource).
|
|
6206
6196
|
# @param [String] parent
|
|
6207
6197
|
# Required. The name of the FHIR store this resource belongs to.
|
|
6208
6198
|
# @param [String] type
|
|
6209
6199
|
# Required. The FHIR resource type to update, such as Patient or Observation.
|
|
6210
|
-
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
|
6211
|
-
#
|
|
6212
|
-
#
|
|
6213
|
-
# implement/standards/fhir/R4/resourcelist.html)). Must match the resource type
|
|
6200
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6201
|
+
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6202
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type
|
|
6214
6203
|
# in the provided content.
|
|
6215
6204
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
6216
6205
|
# @param [String] fields
|
|
@@ -6244,33 +6233,31 @@ module Google
|
|
|
6244
6233
|
end
|
|
6245
6234
|
|
|
6246
6235
|
# Creates a FHIR resource. Implements the FHIR standard create interaction ([
|
|
6247
|
-
# DSTU2](https://hl7.org/
|
|
6248
|
-
#
|
|
6249
|
-
#
|
|
6250
|
-
#
|
|
6251
|
-
#
|
|
6252
|
-
# fhir/
|
|
6253
|
-
#
|
|
6254
|
-
#
|
|
6255
|
-
#
|
|
6256
|
-
#
|
|
6257
|
-
# encoded
|
|
6258
|
-
#
|
|
6259
|
-
#
|
|
6260
|
-
#
|
|
6261
|
-
#
|
|
6262
|
-
#
|
|
6263
|
-
#
|
|
6264
|
-
#
|
|
6265
|
-
# healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).
|
|
6236
|
+
# DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/
|
|
6237
|
+
# fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)),
|
|
6238
|
+
# which creates a new resource with a server-assigned resource ID. Also supports
|
|
6239
|
+
# the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/fhir/
|
|
6240
|
+
# DSTU2/http.html#ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate),
|
|
6241
|
+
# [R4](https://hl7.org/fhir/R4/http.html#ccreate)), specified by supplying an `
|
|
6242
|
+
# If-None-Exist` header containing a FHIR search query. If no resources match
|
|
6243
|
+
# this search query, the server processes the create operation as normal. The
|
|
6244
|
+
# request body must contain a JSON-encoded FHIR resource, and the request
|
|
6245
|
+
# headers must contain `Content-Type: application/fhir+json`. On success, the
|
|
6246
|
+
# response body contains a JSON-encoded representation of the resource as it was
|
|
6247
|
+
# created on the server, including the server-assigned resource ID and version
|
|
6248
|
+
# ID. Errors generated by the FHIR store contain a JSON-encoded `
|
|
6249
|
+
# OperationOutcome` resource describing the reason for the error. If the request
|
|
6250
|
+
# cannot be mapped to a valid API method on a FHIR store, a generic GCP error
|
|
6251
|
+
# might be returned instead. For samples that show how to call `create`, see [
|
|
6252
|
+
# Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
|
6253
|
+
# fhir-resources#creating_a_fhir_resource).
|
|
6266
6254
|
# @param [String] parent
|
|
6267
6255
|
# Required. The name of the FHIR store this resource belongs to.
|
|
6268
6256
|
# @param [String] type
|
|
6269
6257
|
# Required. The FHIR resource type to create, such as Patient or Observation.
|
|
6270
|
-
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
|
6271
|
-
#
|
|
6272
|
-
#
|
|
6273
|
-
# implement/standards/fhir/R4/resourcelist.html)). Must match the resource type
|
|
6258
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6259
|
+
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6260
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type
|
|
6274
6261
|
# in the provided content.
|
|
6275
6262
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
6276
6263
|
# @param [String] fields
|
|
@@ -6304,15 +6291,14 @@ module Google
|
|
|
6304
6291
|
end
|
|
6305
6292
|
|
|
6306
6293
|
# Deletes a FHIR resource. Implements the FHIR standard delete interaction ([
|
|
6307
|
-
# DSTU2](https://hl7.org/
|
|
6308
|
-
#
|
|
6309
|
-
#
|
|
6310
|
-
#
|
|
6311
|
-
#
|
|
6312
|
-
#
|
|
6313
|
-
#
|
|
6314
|
-
#
|
|
6315
|
-
# resources#deleting_a_fhir_resource).
|
|
6294
|
+
# DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/
|
|
6295
|
+
# fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete)).
|
|
6296
|
+
# Note: Unless resource versioning is disabled by setting the
|
|
6297
|
+
# disable_resource_versioning flag on the FHIR store, the deleted resources are
|
|
6298
|
+
# moved to a history repository that can still be retrieved through vread and
|
|
6299
|
+
# related methods, unless they are removed by the purge method. For samples that
|
|
6300
|
+
# show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.
|
|
6301
|
+
# com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).
|
|
6316
6302
|
# @param [String] name
|
|
6317
6303
|
# Required. The name of the resource to delete.
|
|
6318
6304
|
# @param [String] fields
|
|
@@ -6344,38 +6330,36 @@ module Google
|
|
|
6344
6330
|
|
|
6345
6331
|
# Executes all the requests in the given Bundle. Implements the FHIR standard
|
|
6346
6332
|
# batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/
|
|
6347
|
-
#
|
|
6348
|
-
#
|
|
6349
|
-
#
|
|
6350
|
-
#
|
|
6351
|
-
# transaction`
|
|
6352
|
-
#
|
|
6353
|
-
#
|
|
6354
|
-
#
|
|
6355
|
-
#
|
|
6356
|
-
#
|
|
6357
|
-
#
|
|
6358
|
-
#
|
|
6359
|
-
# body
|
|
6360
|
-
#
|
|
6361
|
-
#
|
|
6362
|
-
#
|
|
6363
|
-
#
|
|
6364
|
-
#
|
|
6365
|
-
#
|
|
6366
|
-
#
|
|
6367
|
-
# to
|
|
6368
|
-
#
|
|
6369
|
-
#
|
|
6370
|
-
#
|
|
6371
|
-
#
|
|
6372
|
-
#
|
|
6373
|
-
#
|
|
6374
|
-
# audit
|
|
6375
|
-
#
|
|
6376
|
-
# google.com/healthcare
|
|
6377
|
-
# how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](
|
|
6378
|
-
# https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).
|
|
6333
|
+
# fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/fhir/STU3/http.html#
|
|
6334
|
+
# transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction)). Supports
|
|
6335
|
+
# all interactions within a bundle, except search. This method accepts Bundles
|
|
6336
|
+
# of type `batch`, `transaction` and `history`, processing `batch` and `
|
|
6337
|
+
# transaction` bundles according to the batch processing rules ([DSTU2](https://
|
|
6338
|
+
# hl7.org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/
|
|
6339
|
+
# http.html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules)) and
|
|
6340
|
+
# transaction processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.
|
|
6341
|
+
# 0.16.2), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.2), [R4](https://
|
|
6342
|
+
# hl7.org/fhir/R4/http.html#trules)). The request body must contain a JSON-
|
|
6343
|
+
# encoded FHIR `Bundle` resource, and the request headers must contain `Content-
|
|
6344
|
+
# Type: application/fhir+json`. For a batch bundle or a successful transaction,
|
|
6345
|
+
# the response body contains a JSON-encoded representation of a `Bundle`
|
|
6346
|
+
# resource of type `batch-response` or `transaction-response` containing one
|
|
6347
|
+
# entry for each entry in the request, with the outcome of processing the entry.
|
|
6348
|
+
# In the case of an error for a `transaction` or `history` bundle, the response
|
|
6349
|
+
# body contains a JSON-encoded `OperationOutcome` resource describing the reason
|
|
6350
|
+
# for the error. If the request cannot be mapped to a valid API method on a FHIR
|
|
6351
|
+
# store, a generic GCP error might be returned instead. This method checks
|
|
6352
|
+
# permissions for each request in the bundle. The `executeBundle` permission is
|
|
6353
|
+
# required to call this method, but you must also grant sufficient permissions
|
|
6354
|
+
# to execute the individual requests in the bundle. For example, if the bundle
|
|
6355
|
+
# contains a request to create a FHIR resource, the caller must also have been
|
|
6356
|
+
# granted the `healthcare.fhirResources.create` permission. `history` bundles
|
|
6357
|
+
# also check the `import` permission. You can use audit logs to view the
|
|
6358
|
+
# permissions for `executeBundle` and each request in the bundle. For more
|
|
6359
|
+
# information, see [Viewing Cloud Audit logs](https://cloud.google.com/
|
|
6360
|
+
# healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `
|
|
6361
|
+
# executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.
|
|
6362
|
+
# google.com/healthcare/docs/how-tos/fhir-bundles).
|
|
6379
6363
|
# @param [String] parent
|
|
6380
6364
|
# Required. Name of the FHIR store in which this bundle will be executed.
|
|
6381
6365
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
@@ -6410,15 +6394,14 @@ module Google
|
|
|
6410
6394
|
|
|
6411
6395
|
# Lists all the versions of a resource (including the current version and
|
|
6412
6396
|
# deleted versions) from the FHIR store. Implements the per-resource form of the
|
|
6413
|
-
# FHIR standard history interaction ([DSTU2](https://hl7.org/
|
|
6414
|
-
#
|
|
6415
|
-
#
|
|
6416
|
-
#
|
|
6417
|
-
#
|
|
6418
|
-
#
|
|
6419
|
-
#
|
|
6420
|
-
#
|
|
6421
|
-
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
6397
|
+
# FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.
|
|
6398
|
+
# html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https:
|
|
6399
|
+
# //hl7.org/fhir/R4/http.html#history)). On success, the response body contains
|
|
6400
|
+
# a JSON-encoded representation of a `Bundle` resource of type `history`,
|
|
6401
|
+
# containing the version history sorted from most recent to oldest versions.
|
|
6402
|
+
# Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome`
|
|
6403
|
+
# resource describing the reason for the error. If the request cannot be mapped
|
|
6404
|
+
# to a valid API method on a FHIR store, a generic GCP error might be returned
|
|
6422
6405
|
# instead. For samples that show how to call `history`, see [Listing FHIR
|
|
6423
6406
|
# resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
6424
6407
|
# resources#listing_fhir_resource_versions).
|
|
@@ -6477,19 +6460,18 @@ module Google
|
|
|
6477
6460
|
|
|
6478
6461
|
# Updates part of an existing resource by applying the operations specified in a
|
|
6479
6462
|
# [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard
|
|
6480
|
-
# patch interaction ([STU3](https://hl7.org/
|
|
6481
|
-
#
|
|
6482
|
-
#
|
|
6483
|
-
#
|
|
6484
|
-
#
|
|
6485
|
-
#
|
|
6486
|
-
#
|
|
6487
|
-
#
|
|
6488
|
-
#
|
|
6489
|
-
#
|
|
6490
|
-
#
|
|
6491
|
-
#
|
|
6492
|
-
# patching_a_fhir_resource).
|
|
6463
|
+
# patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](
|
|
6464
|
+
# https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method,
|
|
6465
|
+
# but the server supports it in the same way it supports STU3. The request body
|
|
6466
|
+
# must contain a JSON Patch document, and the request headers must contain `
|
|
6467
|
+
# Content-Type: application/json-patch+json`. On success, the response body
|
|
6468
|
+
# contains a JSON-encoded representation of the updated resource, including the
|
|
6469
|
+
# server-assigned version ID. Errors generated by the FHIR store contain a JSON-
|
|
6470
|
+
# encoded `OperationOutcome` resource describing the reason for the error. If
|
|
6471
|
+
# the request cannot be mapped to a valid API method on a FHIR store, a generic
|
|
6472
|
+
# GCP error might be returned instead. For samples that show how to call `patch`,
|
|
6473
|
+
# see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-
|
|
6474
|
+
# tos/fhir-resources#patching_a_fhir_resource).
|
|
6493
6475
|
# @param [String] name
|
|
6494
6476
|
# Required. The name of the resource to update.
|
|
6495
6477
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
@@ -6523,21 +6505,19 @@ module Google
|
|
|
6523
6505
|
end
|
|
6524
6506
|
|
|
6525
6507
|
# Gets the contents of a FHIR resource. Implements the FHIR standard read
|
|
6526
|
-
# interaction ([DSTU2](https://hl7.org/
|
|
6527
|
-
# read), [
|
|
6528
|
-
#
|
|
6529
|
-
#
|
|
6530
|
-
#
|
|
6531
|
-
#
|
|
6532
|
-
#
|
|
6533
|
-
#
|
|
6534
|
-
#
|
|
6535
|
-
# the
|
|
6536
|
-
#
|
|
6537
|
-
#
|
|
6538
|
-
#
|
|
6539
|
-
# Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
6540
|
-
# resources#getting_a_fhir_resource).
|
|
6508
|
+
# interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https:/
|
|
6509
|
+
# /hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#
|
|
6510
|
+
# read)). Also supports the FHIR standard conditional read interaction ([DSTU2](
|
|
6511
|
+
# https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/
|
|
6512
|
+
# http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)) specified by
|
|
6513
|
+
# supplying an `If-Modified-Since` header with a date/time value or an `If-None-
|
|
6514
|
+
# Match` header with an ETag value. On success, the response body contains a
|
|
6515
|
+
# JSON-encoded representation of the resource. Errors generated by the FHIR
|
|
6516
|
+
# store contain a JSON-encoded `OperationOutcome` resource describing the reason
|
|
6517
|
+
# for the error. If the request cannot be mapped to a valid API method on a FHIR
|
|
6518
|
+
# store, a generic GCP error might be returned instead. For samples that show
|
|
6519
|
+
# how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/
|
|
6520
|
+
# healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).
|
|
6541
6521
|
# @param [String] name
|
|
6542
6522
|
# Required. The name of the resource to retrieve.
|
|
6543
6523
|
# @param [String] fields
|
|
@@ -6569,66 +6549,64 @@ module Google
|
|
|
6569
6549
|
|
|
6570
6550
|
# Searches for resources in the given FHIR store according to criteria specified
|
|
6571
6551
|
# as query parameters. Implements the FHIR standard search interaction ([DSTU2](
|
|
6572
|
-
# https://hl7.org/
|
|
6573
|
-
#
|
|
6574
|
-
#
|
|
6575
|
-
#
|
|
6576
|
-
#
|
|
6577
|
-
#
|
|
6578
|
-
#
|
|
6579
|
-
# `
|
|
6580
|
-
#
|
|
6581
|
-
# parameters]` as an alternate form having the same
|
|
6582
|
-
# method
|
|
6583
|
-
#
|
|
6584
|
-
#
|
|
6585
|
-
#
|
|
6586
|
-
#
|
|
6587
|
-
#
|
|
6588
|
-
#
|
|
6589
|
-
#
|
|
6590
|
-
#
|
|
6591
|
-
#
|
|
6592
|
-
#
|
|
6593
|
-
#
|
|
6594
|
-
#
|
|
6595
|
-
#
|
|
6596
|
-
#
|
|
6597
|
-
#
|
|
6598
|
-
#
|
|
6599
|
-
#
|
|
6600
|
-
#
|
|
6601
|
-
#
|
|
6602
|
-
#
|
|
6603
|
-
#
|
|
6604
|
-
#
|
|
6605
|
-
#
|
|
6606
|
-
#
|
|
6607
|
-
#
|
|
6608
|
-
#
|
|
6609
|
-
#
|
|
6610
|
-
#
|
|
6611
|
-
#
|
|
6612
|
-
#
|
|
6613
|
-
#
|
|
6614
|
-
#
|
|
6615
|
-
#
|
|
6616
|
-
#
|
|
6617
|
-
#
|
|
6618
|
-
#
|
|
6619
|
-
#
|
|
6620
|
-
#
|
|
6621
|
-
#
|
|
6622
|
-
#
|
|
6623
|
-
#
|
|
6624
|
-
#
|
|
6625
|
-
#
|
|
6626
|
-
#
|
|
6627
|
-
#
|
|
6628
|
-
#
|
|
6629
|
-
#
|
|
6630
|
-
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
|
6631
|
-
# healthcare/docs/how-tos/fhir-advanced-search).
|
|
6552
|
+
# https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/
|
|
6553
|
+
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the
|
|
6554
|
+
# search semantics described in the FHIR Search specification ([DSTU2](https://
|
|
6555
|
+
# hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html),
|
|
6556
|
+
# [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search
|
|
6557
|
+
# defined by the specification: * `GET [base]?[parameters]` to search across all
|
|
6558
|
+
# resources. * `GET [base]/[type]?[parameters]` to search resources of a
|
|
6559
|
+
# specified type. * `POST [base]/_search?[parameters]` as an alternate form
|
|
6560
|
+
# having the same semantics as the `GET` method across all resources. * `POST [
|
|
6561
|
+
# base]/[type]/_search?[parameters]` as an alternate form having the same
|
|
6562
|
+
# semantics as the `GET` method for the specified type. The `GET` and `POST`
|
|
6563
|
+
# methods do not support compartment searches. The `POST` method does not
|
|
6564
|
+
# support `application/x-www-form-urlencoded` search parameters. On success, the
|
|
6565
|
+
# response body contains a JSON-encoded representation of a `Bundle` resource of
|
|
6566
|
+
# type `searchset`, containing the results of the search. Errors generated by
|
|
6567
|
+
# the FHIR store contain a JSON-encoded `OperationOutcome` resource describing
|
|
6568
|
+
# the reason for the error. If the request cannot be mapped to a valid API
|
|
6569
|
+
# method on a FHIR store, a generic GCP error might be returned instead. The
|
|
6570
|
+
# server's capability statement, retrieved through capabilities, indicates what
|
|
6571
|
+
# search parameters are supported on each FHIR resource. A list of all search
|
|
6572
|
+
# parameters defined by the specification can be found in the FHIR Search
|
|
6573
|
+
# Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.
|
|
6574
|
+
# html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR
|
|
6575
|
+
# search parameters for DSTU2 can be found on each resource's definition page.
|
|
6576
|
+
# Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
|
|
6577
|
+
# `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and
|
|
6578
|
+
# STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`
|
|
6579
|
+
# , `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`.
|
|
6580
|
+
# The maximum number of search results returned defaults to 100, which can be
|
|
6581
|
+
# overridden by the `_count` parameter up to a maximum limit of 1000. The server
|
|
6582
|
+
# might return fewer resources than requested to prevent excessively large
|
|
6583
|
+
# responses. If there are additional results, the returned `Bundle` contains a
|
|
6584
|
+
# link of `relation` "next", which has a `_page_token` parameter for an opaque
|
|
6585
|
+
# pagination token that can be used to retrieve the next page. Resources with a
|
|
6586
|
+
# total size larger than 5MB or a field count larger than 50,000 might not be
|
|
6587
|
+
# fully searchable as the server might trim its generated search index in those
|
|
6588
|
+
# cases. Note: FHIR resources are indexed asynchronously, so there might be a
|
|
6589
|
+
# slight delay between the time a resource is created or changed, and the time
|
|
6590
|
+
# when the change reflects in search results. The only exception is resource
|
|
6591
|
+
# identifier data, which is indexed synchronously as a special index. As a
|
|
6592
|
+
# result, searching using resource identifier is not subject to indexing delay.
|
|
6593
|
+
# To use the special synchronous index, the search term for identifier should be
|
|
6594
|
+
# in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any
|
|
6595
|
+
# of the following search result parameters can be used: * `_count` * `_include`
|
|
6596
|
+
# * `_revinclude` * `_summary` * `_elements` If your query contains any other
|
|
6597
|
+
# search parameters, the standard asynchronous index will be used instead. Note
|
|
6598
|
+
# that searching against the special index is optimized for resolving a small
|
|
6599
|
+
# number of matches. The search isn't optimized if your identifier search
|
|
6600
|
+
# criteria matches a large number (i.e. more than 2,000) of resources. For a
|
|
6601
|
+
# search query that will match a large number of resources, you can avoiding
|
|
6602
|
+
# using the special synchronous index by including an additional `_sort`
|
|
6603
|
+
# parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the
|
|
6604
|
+
# default sorting order. Note: The special synchronous identifier index are
|
|
6605
|
+
# currently disabled for DocumentReference and DocumentManifest searches. For
|
|
6606
|
+
# samples and detailed information, see [Searching for FHIR resources](https://
|
|
6607
|
+
# cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR
|
|
6608
|
+
# search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
6609
|
+
# advanced-search).
|
|
6632
6610
|
# @param [String] parent
|
|
6633
6611
|
# Required. Name of the FHIR store to retrieve resources from.
|
|
6634
6612
|
# @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object
|
|
@@ -6663,74 +6641,71 @@ module Google
|
|
|
6663
6641
|
|
|
6664
6642
|
# Searches for resources in the given FHIR store according to criteria specified
|
|
6665
6643
|
# as query parameters. Implements the FHIR standard search interaction ([DSTU2](
|
|
6666
|
-
# https://hl7.org/
|
|
6667
|
-
#
|
|
6668
|
-
#
|
|
6669
|
-
#
|
|
6670
|
-
#
|
|
6671
|
-
#
|
|
6672
|
-
#
|
|
6673
|
-
# `
|
|
6674
|
-
#
|
|
6675
|
-
# parameters]` as an alternate form having the same
|
|
6676
|
-
# method
|
|
6677
|
-
#
|
|
6678
|
-
#
|
|
6679
|
-
#
|
|
6680
|
-
#
|
|
6681
|
-
#
|
|
6682
|
-
#
|
|
6683
|
-
#
|
|
6684
|
-
#
|
|
6685
|
-
#
|
|
6686
|
-
#
|
|
6687
|
-
#
|
|
6688
|
-
#
|
|
6689
|
-
#
|
|
6690
|
-
#
|
|
6691
|
-
#
|
|
6692
|
-
#
|
|
6693
|
-
#
|
|
6694
|
-
#
|
|
6695
|
-
#
|
|
6696
|
-
#
|
|
6697
|
-
#
|
|
6698
|
-
#
|
|
6699
|
-
#
|
|
6700
|
-
#
|
|
6701
|
-
#
|
|
6702
|
-
#
|
|
6703
|
-
#
|
|
6704
|
-
#
|
|
6705
|
-
#
|
|
6706
|
-
#
|
|
6707
|
-
#
|
|
6708
|
-
#
|
|
6709
|
-
#
|
|
6710
|
-
#
|
|
6711
|
-
#
|
|
6712
|
-
#
|
|
6713
|
-
#
|
|
6714
|
-
#
|
|
6715
|
-
#
|
|
6716
|
-
#
|
|
6717
|
-
#
|
|
6718
|
-
#
|
|
6719
|
-
#
|
|
6720
|
-
#
|
|
6721
|
-
#
|
|
6722
|
-
#
|
|
6723
|
-
#
|
|
6724
|
-
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
|
6725
|
-
# healthcare/docs/how-tos/fhir-advanced-search).
|
|
6644
|
+
# https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/
|
|
6645
|
+
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the
|
|
6646
|
+
# search semantics described in the FHIR Search specification ([DSTU2](https://
|
|
6647
|
+
# hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html),
|
|
6648
|
+
# [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search
|
|
6649
|
+
# defined by the specification: * `GET [base]?[parameters]` to search across all
|
|
6650
|
+
# resources. * `GET [base]/[type]?[parameters]` to search resources of a
|
|
6651
|
+
# specified type. * `POST [base]/_search?[parameters]` as an alternate form
|
|
6652
|
+
# having the same semantics as the `GET` method across all resources. * `POST [
|
|
6653
|
+
# base]/[type]/_search?[parameters]` as an alternate form having the same
|
|
6654
|
+
# semantics as the `GET` method for the specified type. The `GET` and `POST`
|
|
6655
|
+
# methods do not support compartment searches. The `POST` method does not
|
|
6656
|
+
# support `application/x-www-form-urlencoded` search parameters. On success, the
|
|
6657
|
+
# response body contains a JSON-encoded representation of a `Bundle` resource of
|
|
6658
|
+
# type `searchset`, containing the results of the search. Errors generated by
|
|
6659
|
+
# the FHIR store contain a JSON-encoded `OperationOutcome` resource describing
|
|
6660
|
+
# the reason for the error. If the request cannot be mapped to a valid API
|
|
6661
|
+
# method on a FHIR store, a generic GCP error might be returned instead. The
|
|
6662
|
+
# server's capability statement, retrieved through capabilities, indicates what
|
|
6663
|
+
# search parameters are supported on each FHIR resource. A list of all search
|
|
6664
|
+
# parameters defined by the specification can be found in the FHIR Search
|
|
6665
|
+
# Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.
|
|
6666
|
+
# html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR
|
|
6667
|
+
# search parameters for DSTU2 can be found on each resource's definition page.
|
|
6668
|
+
# Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
|
|
6669
|
+
# `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and
|
|
6670
|
+
# STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`
|
|
6671
|
+
# , `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`.
|
|
6672
|
+
# The maximum number of search results returned defaults to 100, which can be
|
|
6673
|
+
# overridden by the `_count` parameter up to a maximum limit of 1000. The server
|
|
6674
|
+
# might return fewer resources than requested to prevent excessively large
|
|
6675
|
+
# responses. If there are additional results, the returned `Bundle` contains a
|
|
6676
|
+
# link of `relation` "next", which has a `_page_token` parameter for an opaque
|
|
6677
|
+
# pagination token that can be used to retrieve the next page. Resources with a
|
|
6678
|
+
# total size larger than 5MB or a field count larger than 50,000 might not be
|
|
6679
|
+
# fully searchable as the server might trim its generated search index in those
|
|
6680
|
+
# cases. Note: FHIR resources are indexed asynchronously, so there might be a
|
|
6681
|
+
# slight delay between the time a resource is created or changed, and the time
|
|
6682
|
+
# when the change reflects in search results. The only exception is resource
|
|
6683
|
+
# identifier data, which is indexed synchronously as a special index. As a
|
|
6684
|
+
# result, searching using resource identifier is not subject to indexing delay.
|
|
6685
|
+
# To use the special synchronous index, the search term for identifier should be
|
|
6686
|
+
# in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any
|
|
6687
|
+
# of the following search result parameters can be used: * `_count` * `_include`
|
|
6688
|
+
# * `_revinclude` * `_summary` * `_elements` If your query contains any other
|
|
6689
|
+
# search parameters, the standard asynchronous index will be used instead. Note
|
|
6690
|
+
# that searching against the special index is optimized for resolving a small
|
|
6691
|
+
# number of matches. The search isn't optimized if your identifier search
|
|
6692
|
+
# criteria matches a large number (i.e. more than 2,000) of resources. For a
|
|
6693
|
+
# search query that will match a large number of resources, you can avoiding
|
|
6694
|
+
# using the special synchronous index by including an additional `_sort`
|
|
6695
|
+
# parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the
|
|
6696
|
+
# default sorting order. Note: The special synchronous identifier index are
|
|
6697
|
+
# currently disabled for DocumentReference and DocumentManifest searches. For
|
|
6698
|
+
# samples and detailed information, see [Searching for FHIR resources](https://
|
|
6699
|
+
# cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR
|
|
6700
|
+
# search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
6701
|
+
# advanced-search).
|
|
6726
6702
|
# @param [String] parent
|
|
6727
6703
|
# Required. Name of the FHIR store to retrieve resources from.
|
|
6728
6704
|
# @param [String] resource_type
|
|
6729
6705
|
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
|
6730
|
-
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
|
|
6731
|
-
#
|
|
6732
|
-
#
|
|
6733
|
-
# implement/standards/fhir/R4/resourcelist.html)).
|
|
6706
|
+
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6707
|
+
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6708
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html)).
|
|
6734
6709
|
# @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object
|
|
6735
6710
|
# @param [String] fields
|
|
6736
6711
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -6763,26 +6738,25 @@ module Google
|
|
|
6763
6738
|
end
|
|
6764
6739
|
|
|
6765
6740
|
# Updates the entire contents of a resource. Implements the FHIR standard update
|
|
6766
|
-
# interaction ([DSTU2](https://hl7.org/
|
|
6767
|
-
# update), [
|
|
6768
|
-
#
|
|
6769
|
-
#
|
|
6770
|
-
#
|
|
6771
|
-
#
|
|
6772
|
-
#
|
|
6773
|
-
#
|
|
6774
|
-
#
|
|
6775
|
-
# contain
|
|
6776
|
-
#
|
|
6777
|
-
#
|
|
6778
|
-
#
|
|
6779
|
-
#
|
|
6780
|
-
#
|
|
6781
|
-
#
|
|
6782
|
-
#
|
|
6783
|
-
#
|
|
6784
|
-
#
|
|
6785
|
-
# updating_a_fhir_resource).
|
|
6741
|
+
# interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](
|
|
6742
|
+
# https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.
|
|
6743
|
+
# html#update)). If the specified resource does not exist and the FHIR store has
|
|
6744
|
+
# enable_update_create set, creates the resource with the client-specified ID.
|
|
6745
|
+
# It is strongly advised not to include or encode any sensitive data such as
|
|
6746
|
+
# patient identifiers in client-specified resource IDs. Those IDs are part of
|
|
6747
|
+
# the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications.
|
|
6748
|
+
# Those IDs can also be contained in reference fields within other resources.
|
|
6749
|
+
# The request body must contain a JSON-encoded FHIR resource, and the request
|
|
6750
|
+
# headers must contain `Content-Type: application/fhir+json`. The resource must
|
|
6751
|
+
# contain an `id` element having an identical value to the ID in the REST path
|
|
6752
|
+
# of the request. On success, the response body contains a JSON-encoded
|
|
6753
|
+
# representation of the updated resource, including the server-assigned version
|
|
6754
|
+
# ID. Errors generated by the FHIR store contain a JSON-encoded `
|
|
6755
|
+
# OperationOutcome` resource describing the reason for the error. If the request
|
|
6756
|
+
# cannot be mapped to a valid API method on a FHIR store, a generic GCP error
|
|
6757
|
+
# might be returned instead. For samples that show how to call `update`, see [
|
|
6758
|
+
# Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
|
6759
|
+
# fhir-resources#updating_a_fhir_resource).
|
|
6786
6760
|
# @param [String] name
|
|
6787
6761
|
# Required. The name of the resource to update.
|
|
6788
6762
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
@@ -6817,16 +6791,15 @@ module Google
|
|
|
6817
6791
|
|
|
6818
6792
|
# Gets the contents of a version (current or historical) of a FHIR resource by
|
|
6819
6793
|
# version ID. Implements the FHIR standard vread interaction ([DSTU2](https://
|
|
6820
|
-
# hl7.org/
|
|
6821
|
-
#
|
|
6822
|
-
#
|
|
6823
|
-
#
|
|
6824
|
-
# the
|
|
6825
|
-
#
|
|
6826
|
-
#
|
|
6827
|
-
#
|
|
6828
|
-
#
|
|
6829
|
-
# retrieving_a_fhir_resource_version).
|
|
6794
|
+
# hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.
|
|
6795
|
+
# html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread)). On success, the
|
|
6796
|
+
# response body contains a JSON-encoded representation of the resource. Errors
|
|
6797
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
6798
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
6799
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
6800
|
+
# instead. For samples that show how to call `vread`, see [Retrieving a FHIR
|
|
6801
|
+
# resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
6802
|
+
# resources#retrieving_a_fhir_resource_version).
|
|
6830
6803
|
# @param [String] name
|
|
6831
6804
|
# Required. The name of the resource version to retrieve.
|
|
6832
6805
|
# @param [String] fields
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-healthcare_v1beta1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.81.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_v1beta1/CHANGELOG.md
|
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.
|
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.81.0
|
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1beta1
|
|
62
62
|
rdoc_options: []
|
|
63
63
|
require_paths:
|