google-apis-healthcare_v1 0.45.0 → 0.47.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: e248445cb6bfd9748b4df566be9d0b3e750c21c9db304256cd99f020e8f6240f
4
- data.tar.gz: f64fd449be6209293b6a8a7eb696e983cc11801381ce071507bc6c4dfcd6c256
3
+ metadata.gz: bcc70b2d8901b01234de644c47f8f050295620a04c2899bb5dedf1e2211c3875
4
+ data.tar.gz: a071ca91f74049154d8db1ac7fe498591a7ebcb879472a012d796fd82d983aea
5
5
  SHA512:
6
- metadata.gz: ab430c113e6b8d3abaede637d13af29a23d517868821056638e82fb6e2bc68817f1d79e2e5b88a8c946dd67435fff68af69b12e7973e74ebeae624ab880a7fcf
7
- data.tar.gz: fd493494d204d5ae3c68daa455dbeb3e10628f668e6003d006ffb5d156beb374a135d4b60eac6877ab8881c9f13deb8fca0df7928786e1da6970d4cdacac3c53
6
+ metadata.gz: 36f4ad1997a25a4a0a76827e881690293521739191c60878cc40a8e7420d622f2abd4cc386473b0595c4e6528bceccd96ffab694b5716bc0f26505e727f4d989
7
+ data.tar.gz: f0484716610e773c69e0a573128ac0c1657e71ece3e46c9abbfcf0759dae918f5378b7ba3175782b5445a93de2227585636842733602bbd977743ff401dc9d13
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-healthcare_v1
2
2
 
3
+ ### v0.47.0 (2023-08-13)
4
+
5
+ * Regenerated from discovery document revision 20230728
6
+
7
+ ### v0.46.0 (2023-08-03)
8
+
9
+ * Regenerated from discovery document revision 20230720
10
+
3
11
  ### v0.45.0 (2023-07-09)
4
12
 
5
13
  * Regenerated from discovery document revision 20230627
@@ -65,6 +65,12 @@ module Google
65
65
  class AnalyzeEntitiesRequest
66
66
  include Google::Apis::Core::Hashable
67
67
 
68
+ # Optional. Alternative output format to be generated based on the results of
69
+ # analysis.
70
+ # Corresponds to the JSON property `alternativeOutputFormat`
71
+ # @return [String]
72
+ attr_accessor :alternative_output_format
73
+
68
74
  # document_content is a document to be annotated.
69
75
  # Corresponds to the JSON property `documentContent`
70
76
  # @return [String]
@@ -82,6 +88,7 @@ module Google
82
88
 
83
89
  # Update properties of this object
84
90
  def update!(**args)
91
+ @alternative_output_format = args[:alternative_output_format] if args.key?(:alternative_output_format)
85
92
  @document_content = args[:document_content] if args.key?(:document_content)
86
93
  @licensed_vocabularies = args[:licensed_vocabularies] if args.key?(:licensed_vocabularies)
87
94
  end
@@ -103,6 +110,12 @@ module Google
103
110
  # @return [Array<Google::Apis::HealthcareV1::EntityMention>]
104
111
  attr_accessor :entity_mentions
105
112
 
113
+ # The FHIR bundle ([`R4`](http://hl7.org/fhir/R4/bundle.html)) that includes all
114
+ # the entities, the entity mentions, and the relationships in JSON format.
115
+ # Corresponds to the JSON property `fhirBundle`
116
+ # @return [String]
117
+ attr_accessor :fhir_bundle
118
+
106
119
  # relationships contains all the binary relationships that were identified
107
120
  # between entity mentions within the provided document.
108
121
  # Corresponds to the JSON property `relationships`
@@ -117,6 +130,7 @@ module Google
117
130
  def update!(**args)
118
131
  @entities = args[:entities] if args.key?(:entities)
119
132
  @entity_mentions = args[:entity_mentions] if args.key?(:entity_mentions)
133
+ @fhir_bundle = args[:fhir_bundle] if args.key?(:fhir_bundle)
120
134
  @relationships = args[:relationships] if args.key?(:relationships)
121
135
  end
122
136
  end
@@ -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.45.0"
19
+ GEM_VERSION = "0.47.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230627"
25
+ REVISION = "20230728"
26
26
  end
27
27
  end
28
28
  end
@@ -868,6 +868,7 @@ module Google
868
868
  class AnalyzeEntitiesRequest
869
869
  # @private
870
870
  class Representation < Google::Apis::Core::JsonRepresentation
871
+ property :alternative_output_format, as: 'alternativeOutputFormat'
871
872
  property :document_content, as: 'documentContent'
872
873
  collection :licensed_vocabularies, as: 'licensedVocabularies'
873
874
  end
@@ -880,6 +881,7 @@ module Google
880
881
 
881
882
  collection :entity_mentions, as: 'entityMentions', class: Google::Apis::HealthcareV1::EntityMention, decorator: Google::Apis::HealthcareV1::EntityMention::Representation
882
883
 
884
+ property :fhir_bundle, as: 'fhirBundle'
883
885
  collection :relationships, as: 'relationships', class: Google::Apis::HealthcareV1::EntityMentionRelationship, decorator: Google::Apis::HealthcareV1::EntityMentionRelationship::Representation
884
886
 
885
887
  end
@@ -3950,6 +3950,178 @@ module Google
3950
3950
  execute_or_queue_command(command, &block)
3951
3951
  end
3952
3952
 
3953
+ # Deletes a FHIR resource that match an identifier search query. Implements the
3954
+ # FHIR standard conditional delete interaction, limited to searching by resource
3955
+ # identifier. If multiple resources match, 412 Precondition Failed error will be
3956
+ # returned. Search term for identifier should be in the pattern identifier=
3957
+ # system|value or identifier=value - similar to the search method on resources
3958
+ # with a specific identifier. Note: Unless resource versioning is disabled by
3959
+ # setting the disable_resource_versioning flag on the FHIR store, the deleted
3960
+ # resource is moved to a history repository that can still be retrieved through
3961
+ # vread and related methods, unless they are removed by the purge method. For
3962
+ # samples that show how to call `conditionalDelete`, see [Conditionally deleting
3963
+ # a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
3964
+ # resources#conditionally_deleting_a_fhir_resource).
3965
+ # @param [String] parent
3966
+ # The name of the FHIR store this resource belongs to.
3967
+ # @param [String] type
3968
+ # The FHIR resource type to delete, such as Patient or Observation. For a
3969
+ # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
3970
+ # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
3971
+ # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
3972
+ # standards/fhir/R4/resourcelist.html)).
3973
+ # @param [String] fields
3974
+ # Selector specifying which fields to include in a partial response.
3975
+ # @param [String] quota_user
3976
+ # Available to use for quota purposes for server-side applications. Can be any
3977
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3978
+ # @param [Google::Apis::RequestOptions] options
3979
+ # Request-specific options
3980
+ #
3981
+ # @yield [result, err] Result & error if block supplied
3982
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
3983
+ # @yieldparam err [StandardError] error object if request failed
3984
+ #
3985
+ # @return [Google::Apis::HealthcareV1::Empty]
3986
+ #
3987
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3988
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3989
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3990
+ def conditional_project_location_dataset_fhir_store_fhir_delete(parent, type, fields: nil, quota_user: nil, options: nil, &block)
3991
+ command = make_simple_command(:delete, 'v1/{+parent}/fhir/{+type}', options)
3992
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
3993
+ command.response_class = Google::Apis::HealthcareV1::Empty
3994
+ command.params['parent'] = parent unless parent.nil?
3995
+ command.params['type'] = type unless type.nil?
3996
+ command.query['fields'] = fields unless fields.nil?
3997
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3998
+ execute_or_queue_command(command, &block)
3999
+ end
4000
+
4001
+ # If a resource is found with the identifier specified in the query parameters,
4002
+ # updates part of that resource by applying the operations specified in a [JSON
4003
+ # Patch](http://jsonpatch.com/) document. Implements the FHIR standard
4004
+ # conditional patch interaction, limited to searching by resource identifier.
4005
+ # DSTU2 doesn't define a conditional patch method, but the server supports it in
4006
+ # the same way it supports STU3. Search term for identifier should be in the
4007
+ # pattern identifier=system|value or identifier=value - similar to the search
4008
+ # method on resources with a specific identifier. If the search criteria
4009
+ # identify more than one match, the request returns a `412 Precondition Failed`
4010
+ # error. The request body must contain a JSON Patch document, and the request
4011
+ # headers must contain `Content-Type: application/json-patch+json`. On success,
4012
+ # the response body contains a JSON-encoded representation of the updated
4013
+ # resource, including the server-assigned version ID. Errors generated by the
4014
+ # FHIR store contain a JSON-encoded `OperationOutcome` resource describing the
4015
+ # reason for the error. If the request cannot be mapped to a valid API method on
4016
+ # a FHIR store, a generic GCP error might be returned instead. For samples that
4017
+ # show how to call `conditionalPatch`, see [Conditionally patching a FHIR
4018
+ # resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
4019
+ # conditionally_patching_a_fhir_resource).
4020
+ # @param [String] parent
4021
+ # The name of the FHIR store this resource belongs to.
4022
+ # @param [String] type
4023
+ # The FHIR resource type to update, such as Patient or Observation. For a
4024
+ # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
4025
+ # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
4026
+ # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
4027
+ # standards/fhir/R4/resourcelist.html)).
4028
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
4029
+ # @param [String] fields
4030
+ # Selector specifying which fields to include in a partial response.
4031
+ # @param [String] quota_user
4032
+ # Available to use for quota purposes for server-side applications. Can be any
4033
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4034
+ # @param [Google::Apis::RequestOptions] options
4035
+ # Request-specific options
4036
+ #
4037
+ # @yield [result, err] Result & error if block supplied
4038
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
4039
+ # @yieldparam err [StandardError] error object if request failed
4040
+ #
4041
+ # @return [Google::Apis::HealthcareV1::HttpBody]
4042
+ #
4043
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4044
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4045
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4046
+ def conditional_project_location_dataset_fhir_store_fhir_patch(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4047
+ command = make_simple_command(:patch, 'v1/{+parent}/fhir/{+type}', options)
4048
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4049
+ command.request_object = http_body_object
4050
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4051
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
4052
+ command.params['parent'] = parent unless parent.nil?
4053
+ command.params['type'] = type unless type.nil?
4054
+ command.query['fields'] = fields unless fields.nil?
4055
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4056
+ execute_or_queue_command(command, &block)
4057
+ end
4058
+
4059
+ # If a resource is found with the identifier specified in the query parameters,
4060
+ # updates the entire contents of that resource. Implements the FHIR standard
4061
+ # conditional update interaction, limited to searching by resource identifier.
4062
+ # Search term for identifier should be in the pattern identifier=system|value or
4063
+ # identifier=value - similar to the search method on resources with a specific
4064
+ # identifier. If the search criteria identify more than one match, the request
4065
+ # returns a `412 Precondition Failed` error. If the search criteria identify
4066
+ # zero matches, and the supplied resource body contains an `id`, and the FHIR
4067
+ # store has enable_update_create set, creates the resource with the client-
4068
+ # specified ID. It is strongly advised not to include or encode any sensitive
4069
+ # data such as patient identifiers in client-specified resource IDs. Those IDs
4070
+ # are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub
4071
+ # notifications. Those IDs can also be contained in reference fields within
4072
+ # other resources. If the search criteria identify zero matches, and the
4073
+ # supplied resource body does not contain an `id`, the resource is created with
4074
+ # a server-assigned ID as per the create method. The request body must contain a
4075
+ # JSON-encoded FHIR resource, and the request headers must contain `Content-Type:
4076
+ # application/fhir+json`. On success, the response body contains a JSON-encoded
4077
+ # representation of the updated resource, including the server-assigned version
4078
+ # ID. Errors generated by the FHIR store contain a JSON-encoded `
4079
+ # OperationOutcome` resource describing the reason for the error. If the request
4080
+ # cannot be mapped to a valid API method on a FHIR store, a generic GCP error
4081
+ # might be returned instead. For samples that show how to call `
4082
+ # conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.
4083
+ # google.com/healthcare/docs/how-tos/fhir-resources#
4084
+ # conditionally_updating_a_fhir_resource).
4085
+ # @param [String] parent
4086
+ # The name of the FHIR store this resource belongs to.
4087
+ # @param [String] type
4088
+ # The FHIR resource type to update, such as Patient or Observation. For a
4089
+ # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
4090
+ # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
4091
+ # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
4092
+ # standards/fhir/R4/resourcelist.html)). Must match the resource type in the
4093
+ # provided content.
4094
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
4095
+ # @param [String] fields
4096
+ # Selector specifying which fields to include in a partial response.
4097
+ # @param [String] quota_user
4098
+ # Available to use for quota purposes for server-side applications. Can be any
4099
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4100
+ # @param [Google::Apis::RequestOptions] options
4101
+ # Request-specific options
4102
+ #
4103
+ # @yield [result, err] Result & error if block supplied
4104
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
4105
+ # @yieldparam err [StandardError] error object if request failed
4106
+ #
4107
+ # @return [Google::Apis::HealthcareV1::HttpBody]
4108
+ #
4109
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4110
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4111
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4112
+ def conditional_project_location_dataset_fhir_store_fhir_update(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4113
+ command = make_simple_command(:put, 'v1/{+parent}/fhir/{+type}', options)
4114
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4115
+ command.request_object = http_body_object
4116
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4117
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
4118
+ command.params['parent'] = parent unless parent.nil?
4119
+ command.params['type'] = type unless type.nil?
4120
+ command.query['fields'] = fields unless fields.nil?
4121
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4122
+ execute_or_queue_command(command, &block)
4123
+ end
4124
+
3953
4125
  # Creates a FHIR resource. Implements the FHIR standard create interaction ([
3954
4126
  # DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](
3955
4127
  # http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://
@@ -4309,10 +4481,24 @@ module Google
4309
4481
  # 50,000 might not be fully searchable as the server might trim its generated
4310
4482
  # search index in those cases. Note: FHIR resources are indexed asynchronously,
4311
4483
  # so there might be a slight delay between the time a resource is created or
4312
- # changes and when the change is reflected in search results. For samples and
4313
- # detailed information, see [Searching for FHIR resources](https://cloud.google.
4314
- # com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](
4315
- # https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
4484
+ # changed, and the time when the change reflects in search results. The only
4485
+ # exception is resource identifier data, which is indexed synchronously as a
4486
+ # special index. As a result, searching using resource identifier is not subject
4487
+ # to indexing delay. To use the special synchronous index, the search term for
4488
+ # identifier should be in the pattern `identifier=[system]|[value]` or `
4489
+ # identifier=[value]`, and any of the following search result parameters can be
4490
+ # used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If
4491
+ # your query contains any other search parameters, the standard asynchronous
4492
+ # index will be used instead. Note that searching against the special index is
4493
+ # optimized for resolving a small number of matches. The search isn't optimized
4494
+ # if your identifier search criteria matches a large number (i.e. more than 2,
4495
+ # 000) of resources. For a search query that will match a large number of
4496
+ # resources, you can avoiding using the special synchronous index by including
4497
+ # an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if
4498
+ # you want to keep the default sorting order. For samples and detailed
4499
+ # information, see [Searching for FHIR resources](https://cloud.google.com/
4500
+ # healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https:
4501
+ # //cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
4316
4502
  # @param [String] parent
4317
4503
  # Name of the FHIR store to retrieve resources from.
4318
4504
  # @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
@@ -4387,10 +4573,24 @@ module Google
4387
4573
  # 50,000 might not be fully searchable as the server might trim its generated
4388
4574
  # search index in those cases. Note: FHIR resources are indexed asynchronously,
4389
4575
  # so there might be a slight delay between the time a resource is created or
4390
- # changes and when the change is reflected in search results. For samples and
4391
- # detailed information, see [Searching for FHIR resources](https://cloud.google.
4392
- # com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](
4393
- # https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
4576
+ # changed, and the time when the change reflects in search results. The only
4577
+ # exception is resource identifier data, which is indexed synchronously as a
4578
+ # special index. As a result, searching using resource identifier is not subject
4579
+ # to indexing delay. To use the special synchronous index, the search term for
4580
+ # identifier should be in the pattern `identifier=[system]|[value]` or `
4581
+ # identifier=[value]`, and any of the following search result parameters can be
4582
+ # used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If
4583
+ # your query contains any other search parameters, the standard asynchronous
4584
+ # index will be used instead. Note that searching against the special index is
4585
+ # optimized for resolving a small number of matches. The search isn't optimized
4586
+ # if your identifier search criteria matches a large number (i.e. more than 2,
4587
+ # 000) of resources. For a search query that will match a large number of
4588
+ # resources, you can avoiding using the special synchronous index by including
4589
+ # an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if
4590
+ # you want to keep the default sorting order. For samples and detailed
4591
+ # information, see [Searching for FHIR resources](https://cloud.google.com/
4592
+ # healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https:
4593
+ # //cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
4394
4594
  # @param [String] parent
4395
4595
  # Name of the FHIR store to retrieve resources from.
4396
4596
  # @param [String] resource_type
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-healthcare_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.45.0
4
+ version: 0.47.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-07-09 00:00:00.000000000 Z
11
+ date: 2023-08-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1/v0.45.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1/v0.47.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1
63
63
  post_install_message:
64
64
  rdoc_options: []