google-apis-healthcare_v1 0.65.0 → 0.67.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 435f2ca95152367429c8d68de39b113f87bfddeef538ac03041efadf901e0d79
4
- data.tar.gz: 1eb874133c2cd41fcf871da59fb8d5dad7143509aaa9252bbd3b3e3f8a09ad77
3
+ metadata.gz: 56572456c6df1a4eaa8f9eeb27e83c98ee2951c18f070013cb41f64342c0fa21
4
+ data.tar.gz: 0dea004d39e7cffb90e0fcfc8c82479b83fbeb7ade0414aa75f931ebd1fb7f55
5
5
  SHA512:
6
- metadata.gz: 38aeb23b833ab57dd7fa63890e26a84a6a0a359c30ec95bea93b2e770500a062b6208cca40aff843b5525c7752a9732301da4106c0cbc093ca3d8592d63c3623
7
- data.tar.gz: 77c9477131e9bdb8d523503843b9083714135ebf20a69d9fd50a0ee0cfc84c6d32bdaf9c9b743fbdda625548b26367dad4ed933a6462497825276a8a08e194ea
6
+ metadata.gz: b1b358b69af108a7418f9bf61ed39208fb39976b0d24a9fc564ecb99f49ee727c5218550265afb8293a53f4b14f597508f2f846aa69f5064507a42935d6558df
7
+ data.tar.gz: 5a7ee195cfffcbe2c04110d18d8cc187a2bfeb82af417323ba19be3010c6a01ce11f01bd27f34cabec88446b4317bbb79c5d267b66fa425306d0eea8267c7fad
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-healthcare_v1
2
2
 
3
+ ### v0.67.0 (2024-09-22)
4
+
5
+ * Regenerated from discovery document revision 20240910
6
+
7
+ ### v0.66.0 (2024-09-08)
8
+
9
+ * Regenerated from discovery document revision 20240822
10
+
3
11
  ### v0.65.0 (2024-09-01)
4
12
 
5
13
  * Regenerated from discovery document revision 20240819
@@ -1964,18 +1964,19 @@ module Google
1964
1964
  class FhirNotificationConfig
1965
1965
  include Google::Apis::Core::Hashable
1966
1966
 
1967
- # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications
1968
- # of changes are published on. Supplied by the client. The notification is a `
1969
- # PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the
1970
- # resource name. * `PubsubMessage.MessageId` is the ID of this notification. It
1971
- # is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is
1972
- # the time when the message was published. Note that notifications are only sent
1973
- # if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/
1974
- # overview#names) must be scoped to a project. The Cloud Healthcare API service
1975
- # account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have
1976
- # publisher permissions on the given Pub/Sub topic. Not having adequate
1977
- # permissions causes the calls that send notifications to fail (https://cloud.
1978
- # google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#
1967
+ # Optional. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that
1968
+ # notifications of changes are published on. Supplied by the client. The
1969
+ # notification is a `PubsubMessage` with the following fields: * `PubsubMessage.
1970
+ # Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of
1971
+ # this notification. It is guaranteed to be unique within the topic. * `
1972
+ # PubsubMessage.PublishTime` is the time when the message was published. Note
1973
+ # that notifications are only sent if the topic is non-empty. [Topic names](
1974
+ # https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a
1975
+ # project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.
1976
+ # iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub
1977
+ # topic. Not having adequate permissions causes the calls that send
1978
+ # notifications to fail (https://cloud.google.com/healthcare-api/docs/
1979
+ # permissions-healthcare-api-gcp-products#
1979
1980
  # dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't
1980
1981
  # be published to Pub/Sub, errors are logged to Cloud Logging. For more
1981
1982
  # information, see [Viewing error logs in Cloud Logging](https://cloud.google.
@@ -1984,20 +1985,20 @@ module Google
1984
1985
  # @return [String]
1985
1986
  attr_accessor :pubsub_topic
1986
1987
 
1987
- # Whether to send full FHIR resource to this Pub/Sub topic. The default value is
1988
- # false.
1988
+ # Optional. Whether to send full FHIR resource to this Pub/Sub topic. The
1989
+ # default value is false.
1989
1990
  # Corresponds to the JSON property `sendFullResource`
1990
1991
  # @return [Boolean]
1991
1992
  attr_accessor :send_full_resource
1992
1993
  alias_method :send_full_resource?, :send_full_resource
1993
1994
 
1994
- # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR
1995
- # resource. The default value is false. Note that setting this to true does not
1996
- # guarantee that all previous resources will be sent in the format of full FHIR
1997
- # resource. When a resource change is too large or during heavy traffic, only
1998
- # the resource name will be sent. Clients should always check the "payloadType"
1999
- # label from a Pub/Sub message to determine whether it needs to fetch the full
2000
- # previous resource as a separate operation.
1995
+ # Optional. Whether to send full FHIR resource to this Pub/Sub topic for
1996
+ # deleting FHIR resource. The default value is false. Note that setting this to
1997
+ # true does not guarantee that all previous resources will be sent in the format
1998
+ # of full FHIR resource. When a resource change is too large or during heavy
1999
+ # traffic, only the resource name will be sent. Clients should always check the "
2000
+ # payloadType" label from a Pub/Sub message to determine whether it needs to
2001
+ # fetch the full previous resource as a separate operation.
2001
2002
  # Corresponds to the JSON property `sendPreviousResourceOnDelete`
2002
2003
  # @return [Boolean]
2003
2004
  attr_accessor :send_previous_resource_on_delete
@@ -2031,12 +2032,12 @@ module Google
2031
2032
  # @return [String]
2032
2033
  attr_accessor :complex_data_type_reference_parsing
2033
2034
 
2034
- # If true, overrides the default search behavior for this FHIR store to `
2035
- # handling=strict` which returns an error for unrecognized search parameters. If
2036
- # false, uses the FHIR specification default `handling=lenient` which ignores
2037
- # unrecognized search parameters. The handling can always be changed from the
2038
- # default on an individual API call by setting the HTTP header `Prefer: handling=
2039
- # strict` or `Prefer: handling=lenient`. Defaults to false.
2035
+ # Optional. If true, overrides the default search behavior for this FHIR store
2036
+ # to `handling=strict` which returns an error for unrecognized search parameters.
2037
+ # If false, uses the FHIR specification default `handling=lenient` which
2038
+ # ignores unrecognized search parameters. The handling can always be changed
2039
+ # from the default on an individual API call by setting the HTTP header `Prefer:
2040
+ # handling=strict` or `Prefer: handling=lenient`. Defaults to false.
2040
2041
  # Corresponds to the JSON property `defaultSearchHandlingStrict`
2041
2042
  # @return [Boolean]
2042
2043
  attr_accessor :default_search_handling_strict
@@ -2065,16 +2066,16 @@ module Google
2065
2066
  attr_accessor :disable_resource_versioning
2066
2067
  alias_method :disable_resource_versioning?, :disable_resource_versioning
2067
2068
 
2068
- # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/
2069
- # fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.
2070
- # updateCreate). This determines if the client can use an Update operation to
2071
- # create a new resource with a client-specified ID. If false, all IDs are server-
2072
- # assigned through the Create operation and attempts to update a non-existent
2073
- # resource return errors. It is strongly advised not to include or encode any
2074
- # sensitive data such as patient identifiers in client-specified resource IDs.
2075
- # Those IDs are part of the FHIR resource path recorded in Cloud audit logs and
2076
- # Pub/Sub notifications. Those IDs can also be contained in reference fields
2077
- # within other resources. Defaults to false.
2069
+ # Optional. Whether this FHIR store has the [updateCreate capability](https://
2070
+ # www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.
2071
+ # resource.updateCreate). This determines if the client can use an Update
2072
+ # operation to create a new resource with a client-specified ID. If false, all
2073
+ # IDs are server-assigned through the Create operation and attempts to update a
2074
+ # non-existent resource return errors. It is strongly advised not to include or
2075
+ # encode any sensitive data such as patient identifiers in client-specified
2076
+ # resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud
2077
+ # audit logs and Pub/Sub notifications. Those IDs can also be contained in
2078
+ # reference fields within other resources. Defaults to false.
2078
2079
  # Corresponds to the JSON property `enableUpdateCreate`
2079
2080
  # @return [Boolean]
2080
2081
  attr_accessor :enable_update_create
@@ -2103,21 +2104,22 @@ module Google
2103
2104
  # @return [Google::Apis::HealthcareV1::NotificationConfig]
2104
2105
  attr_accessor :notification_config
2105
2106
 
2106
- # Specifies where and whether to send notifications upon changes to a FHIR store.
2107
+ # Optional. Specifies where and whether to send notifications upon changes to a
2108
+ # FHIR store.
2107
2109
  # Corresponds to the JSON property `notificationConfigs`
2108
2110
  # @return [Array<Google::Apis::HealthcareV1::FhirNotificationConfig>]
2109
2111
  attr_accessor :notification_configs
2110
2112
 
2111
- # A list of streaming configs that configure the destinations of streaming
2112
- # export for every resource mutation in this FHIR store. Each store is allowed
2113
- # to have up to 10 streaming configs. After a new config is added, the next
2114
- # resource mutation is streamed to the new location in addition to the existing
2115
- # ones. When a location is removed from the list, the server stops streaming to
2116
- # that location. Before adding a new config, you must add the required [`
2117
- # bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#
2118
- # bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent**
2119
- # [service account](https://cloud.google.com/iam/docs/service-accounts). Some
2120
- # lag (typically on the order of dozens of seconds) is expected before the
2113
+ # Optional. A list of streaming configs that configure the destinations of
2114
+ # streaming export for every resource mutation in this FHIR store. Each store is
2115
+ # allowed to have up to 10 streaming configs. After a new config is added, the
2116
+ # next resource mutation is streamed to the new location in addition to the
2117
+ # existing ones. When a location is removed from the list, the server stops
2118
+ # streaming to that location. Before adding a new config, you must add the
2119
+ # required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-
2120
+ # control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service
2121
+ # Agent** [service account](https://cloud.google.com/iam/docs/service-accounts).
2122
+ # Some lag (typically on the order of dozens of seconds) is expected before the
2121
2123
  # results show up in the streaming destination.
2122
2124
  # Corresponds to the JSON property `streamConfigs`
2123
2125
  # @return [Array<Google::Apis::HealthcareV1::StreamConfig>]
@@ -2587,18 +2589,18 @@ module Google
2587
2589
  class GoogleCloudHealthcareV1FhirBigQueryDestination
2588
2590
  include Google::Apis::Core::Hashable
2589
2591
 
2590
- # BigQuery URI to an existing dataset, up to 2000 characters long, in the format
2591
- # `bq://projectId.bqDatasetId`.
2592
+ # Optional. BigQuery URI to an existing dataset, up to 2000 characters long, in
2593
+ # the format `bq://projectId.bqDatasetId`.
2592
2594
  # Corresponds to the JSON property `datasetUri`
2593
2595
  # @return [String]
2594
2596
  attr_accessor :dataset_uri
2595
2597
 
2596
- # The default value is false. If this flag is `TRUE`, all tables are deleted
2597
- # from the dataset before the new exported tables are written. If the flag is
2598
- # not set and the destination dataset contains tables, the export call returns
2599
- # an error. If `write_disposition` is specified, this parameter is ignored.
2600
- # force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is
2601
- # equivalent to write_disposition=WRITE_TRUNCATE.
2598
+ # Optional. The default value is false. If this flag is `TRUE`, all tables are
2599
+ # deleted from the dataset before the new exported tables are written. If the
2600
+ # flag is not set and the destination dataset contains tables, the export call
2601
+ # returns an error. If `write_disposition` is specified, this parameter is
2602
+ # ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=
2603
+ # true is equivalent to write_disposition=WRITE_TRUNCATE.
2602
2604
  # Corresponds to the JSON property `force`
2603
2605
  # @return [Boolean]
2604
2606
  attr_accessor :force
@@ -2610,9 +2612,9 @@ module Google
2610
2612
  # @return [Google::Apis::HealthcareV1::SchemaConfig]
2611
2613
  attr_accessor :schema_config
2612
2614
 
2613
- # Determines if existing data in the destination dataset is overwritten,
2614
- # appended to, or not written if the tables contain data. If a write_disposition
2615
- # is specified, the `force` parameter is ignored.
2615
+ # Optional. Determines if existing data in the destination dataset is
2616
+ # overwritten, appended to, or not written if the tables contain data. If a
2617
+ # write_disposition is specified, the `force` parameter is ignored.
2616
2618
  # Corresponds to the JSON property `writeDisposition`
2617
2619
  # @return [String]
2618
2620
  attr_accessor :write_disposition
@@ -2766,29 +2768,29 @@ module Google
2766
2768
  class Hl7V2NotificationConfig
2767
2769
  include Google::Apis::Core::Hashable
2768
2770
 
2769
- # Restricts notifications sent for messages matching a filter. If this is empty,
2770
- # all messages are matched. The following syntax is available: * A string field
2771
- # value can be written as text inside quotation marks, for example `"query text"`
2772
- # . The only valid relational operation for text fields is equality (`=`), where
2773
- # text is searched within the field, rather than having the field be equal to
2774
- # the text. For example, `"Comment = great"` returns messages with `great` in
2775
- # the comment field. * A number field value can be written as an integer, a
2776
- # decimal, or an exponential. The valid relational operators for number fields
2777
- # are the equality operator (`=`), along with the less than/greater than
2778
- # operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
2771
+ # Optional. Restricts notifications sent for messages matching a filter. If this
2772
+ # is empty, all messages are matched. The following syntax is available: * A
2773
+ # string field value can be written as text inside quotation marks, for example `
2774
+ # "query text"`. The only valid relational operation for text fields is equality
2775
+ # (`=`), where text is searched within the field, rather than having the field
2776
+ # be equal to the text. For example, `"Comment = great"` returns messages with `
2777
+ # great` in the comment field. * A number field value can be written as an
2778
+ # integer, a decimal, or an exponential. The valid relational operators for
2779
+ # number fields are the equality operator (`=`), along with the less than/
2780
+ # greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
2781
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
2782
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
2783
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
2784
+ # required for one-digit months and days. The valid relational operators for
2785
+ # date fields are the equality operator (`=`) , along with the less than/greater
2786
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
2779
2787
  # operator. You can prepend the `NOT` operator to an expression to negate it. *
2780
- # A date field value must be written in `yyyy-mm-dd` form. Fields with date and
2781
- # time use the RFC3339 time format. Leading zeros are required for one-digit
2782
- # months and days. The valid relational operators for date fields are the
2783
- # equality operator (`=`) , along with the less than/greater than operators (`<`,
2784
- # `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can
2785
- # prepend the `NOT` operator to an expression to negate it. * Multiple field
2786
- # query expressions can be combined in one query by adding `AND` or `OR`
2787
- # operators between the expressions. If a boolean operator appears within a
2788
- # quoted string, it is not treated as special, it's just another part of the
2789
- # character string to be matched. You can prepend the `NOT` operator to an
2790
- # expression to negate it. The following fields and functions are available for
2791
- # filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT
2788
+ # Multiple field query expressions can be combined in one query by adding `AND`
2789
+ # or `OR` operators between the expressions. If a boolean operator appears
2790
+ # within a quoted string, it is not treated as special, it's just another part
2791
+ # of the character string to be matched. You can prepend the `NOT` operator to
2792
+ # an expression to negate it. The following fields and functions are available
2793
+ # for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT
2792
2794
  # message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the
2793
2795
  # message was sent in the dataset's time_zone, from the MSH-7 segment. For
2794
2796
  # example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the
@@ -2859,10 +2861,10 @@ module Google
2859
2861
  # @return [String]
2860
2862
  attr_accessor :name
2861
2863
 
2862
- # A list of notification configs. Each configuration uses a filter to determine
2863
- # whether to publish a message (both Ingest & Create) on the corresponding
2864
- # notification destination. Only the message name is sent as part of the
2865
- # notification. Supplied by the client.
2864
+ # Optional. A list of notification configs. Each configuration uses a filter to
2865
+ # determine whether to publish a message (both Ingest & Create) on the
2866
+ # corresponding notification destination. Only the message name is sent as part
2867
+ # of the notification. Supplied by the client.
2866
2868
  # Corresponds to the JSON property `notificationConfigs`
2867
2869
  # @return [Array<Google::Apis::HealthcareV1::Hl7V2NotificationConfig>]
2868
2870
  attr_accessor :notification_configs
@@ -2873,15 +2875,15 @@ module Google
2873
2875
  # @return [Google::Apis::HealthcareV1::ParserConfig]
2874
2876
  attr_accessor :parser_config
2875
2877
 
2876
- # Determines whether to reject duplicate messages. A duplicate message is a
2877
- # message with the same raw bytes as a message that has already been ingested/
2878
- # created in this HL7v2 store. The default value is false, meaning that the
2879
- # store accepts the duplicate messages and it also returns the same ACK message
2880
- # in the IngestMessageResponse as has been returned previously. Note that only
2881
- # one resource is created in the store. When this field is set to true,
2882
- # CreateMessage/IngestMessage requests with a duplicate message will be rejected
2883
- # by the store, and IngestMessageErrorDetail returns a NACK message upon
2884
- # rejection.
2878
+ # Optional. Determines whether to reject duplicate messages. A duplicate message
2879
+ # is a message with the same raw bytes as a message that has already been
2880
+ # ingested/created in this HL7v2 store. The default value is false, meaning that
2881
+ # the store accepts the duplicate messages and it also returns the same ACK
2882
+ # message in the IngestMessageResponse as has been returned previously. Note
2883
+ # that only one resource is created in the store. When this field is set to true,
2884
+ # CreateMessage/IngestMessage requests with a duplicate message will be
2885
+ # rejected by the store, and IngestMessageErrorDetail returns a NACK message
2886
+ # upon rejection.
2885
2887
  # Corresponds to the JSON property `rejectDuplicateMessage`
2886
2888
  # @return [Boolean]
2887
2889
  attr_accessor :reject_duplicate_message
@@ -3992,7 +3994,7 @@ module Google
3992
3994
  class ParserConfig
3993
3995
  include Google::Apis::Core::Hashable
3994
3996
 
3995
- # Determines whether messages with no header are allowed.
3997
+ # Optional. Determines whether messages with no header are allowed.
3996
3998
  # Corresponds to the JSON property `allowNullHeader`
3997
3999
  # @return [Boolean]
3998
4000
  attr_accessor :allow_null_header
@@ -4699,37 +4701,37 @@ module Google
4699
4701
  class SchemaPackage
4700
4702
  include Google::Apis::Core::Hashable
4701
4703
 
4702
- # Flag to ignore all min_occurs restrictions in the schema. This means that
4703
- # incoming messages can omit any group, segment, field, component, or
4704
+ # Optional. Flag to ignore all min_occurs restrictions in the schema. This means
4705
+ # that incoming messages can omit any group, segment, field, component, or
4704
4706
  # subcomponent.
4705
4707
  # Corresponds to the JSON property `ignoreMinOccurs`
4706
4708
  # @return [Boolean]
4707
4709
  attr_accessor :ignore_min_occurs
4708
4710
  alias_method :ignore_min_occurs?, :ignore_min_occurs
4709
4711
 
4710
- # Schema configs that are layered based on their VersionSources that match the
4711
- # incoming message. Schema configs present in higher indices override those in
4712
- # lower indices with the same message type and trigger event if their
4712
+ # Optional. Schema configs that are layered based on their VersionSources that
4713
+ # match the incoming message. Schema configs present in higher indices override
4714
+ # those in lower indices with the same message type and trigger event if their
4713
4715
  # VersionSources all match an incoming message.
4714
4716
  # Corresponds to the JSON property `schemas`
4715
4717
  # @return [Array<Google::Apis::HealthcareV1::Hl7SchemaConfig>]
4716
4718
  attr_accessor :schemas
4717
4719
 
4718
- # Determines how messages that fail to parse are handled.
4720
+ # Optional. Determines how messages that fail to parse are handled.
4719
4721
  # Corresponds to the JSON property `schematizedParsingType`
4720
4722
  # @return [String]
4721
4723
  attr_accessor :schematized_parsing_type
4722
4724
 
4723
- # Schema type definitions that are layered based on their VersionSources that
4724
- # match the incoming message. Type definitions present in higher indices
4725
- # override those in lower indices with the same type name if their
4726
- # VersionSources all match an incoming message.
4725
+ # Optional. Schema type definitions that are layered based on their
4726
+ # VersionSources that match the incoming message. Type definitions present in
4727
+ # higher indices override those in lower indices with the same type name if
4728
+ # their VersionSources all match an incoming message.
4727
4729
  # Corresponds to the JSON property `types`
4728
4730
  # @return [Array<Google::Apis::HealthcareV1::Hl7TypesConfig>]
4729
4731
  attr_accessor :types
4730
4732
 
4731
- # Determines how unexpected segments (segments not matched to the schema) are
4732
- # handled.
4733
+ # Optional. Determines how unexpected segments (segments not matched to the
4734
+ # schema) are handled.
4733
4735
  # Corresponds to the JSON property `unexpectedSegmentHandling`
4734
4736
  # @return [String]
4735
4737
  attr_accessor :unexpected_segment_handling
@@ -5127,10 +5129,10 @@ module Google
5127
5129
  # @return [Google::Apis::HealthcareV1::DeidentifiedStoreDestination]
5128
5130
  attr_accessor :deidentified_store_destination
5129
5131
 
5130
- # Supply a FHIR resource type (such as "Patient" or "Observation"). See https://
5131
- # www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource
5132
- # types. The server treats an empty list as an intent to stream all the
5133
- # supported resource types in this FHIR store.
5132
+ # Optional. Supply a FHIR resource type (such as "Patient" or "Observation").
5133
+ # See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all
5134
+ # FHIR resource types. The server treats an empty list as an intent to stream
5135
+ # all the supported resource types in this FHIR store.
5134
5136
  # Corresponds to the JSON property `resourceTypes`
5135
5137
  # @return [Array<String>]
5136
5138
  attr_accessor :resource_types
@@ -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.65.0"
19
+ GEM_VERSION = "0.67.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240819"
25
+ REVISION = "20240910"
26
26
  end
27
27
  end
28
28
  end
@@ -4107,6 +4107,207 @@ module Google
4107
4107
  execute_or_queue_command(command, &block)
4108
4108
  end
4109
4109
 
4110
+ # Creates a FHIR Binary resource. This method can be used to create a Binary
4111
+ # resource either by using one of the accepted FHIR JSON content types, or as a
4112
+ # raw data stream. If a resource is created with this method using the FHIR
4113
+ # content type this method's behavior is the same as [`fhir.create`](https://
4114
+ # cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.
4115
+ # datasets.fhirStores.fhir/create). If a resource type other than Binary is used
4116
+ # in the request it's treated in the same way as non-FHIR data (e.g., images,
4117
+ # zip archives, pdf files, documents). When a non-FHIR content type is used in
4118
+ # the request, a Binary resource will be generated, and the uploaded data will
4119
+ # be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`
4120
+ # R4`). The Binary resource's `contentType` will be filled in using the value of
4121
+ # the `Content-Type` header, and the `securityContext` field (not present in `
4122
+ # DSTU2`) will be populated from the `X-Security-Context` header if it exists.
4123
+ # At this time `securityContext` has no special behavior in the Cloud Healthcare
4124
+ # API. Note: the limit on data ingested through this method is 2 GB. For best
4125
+ # performance, use a non-FHIR data type instead of wrapping the data in a Binary
4126
+ # resource. Some of the Healthcare API features, such as [exporting to BigQuery](
4127
+ # https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [
4128
+ # Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-
4129
+ # pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with
4130
+ # full resource content, do not support Binary resources that are larger than 10
4131
+ # MB. In these cases the resource's `data` field will be omitted. Instead, the "
4132
+ # http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be
4133
+ # present to indicate that including the data is `unsupported`. On success, an
4134
+ # empty `201 Created` response is returned. The newly created resource's ID and
4135
+ # version are returned in the Location header. Using `Prefer: representation=
4136
+ # resource` is not allowed for this method. The definition of the Binary REST
4137
+ # API can be found at https://hl7.org/fhir/binary.html#rest.
4138
+ # @param [String] parent
4139
+ # Required. The name of the FHIR store this resource belongs to.
4140
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
4141
+ # @param [String] fields
4142
+ # Selector specifying which fields to include in a partial response.
4143
+ # @param [String] quota_user
4144
+ # Available to use for quota purposes for server-side applications. Can be any
4145
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4146
+ # @param [Google::Apis::RequestOptions] options
4147
+ # Request-specific options
4148
+ #
4149
+ # @yield [result, err] Result & error if block supplied
4150
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
4151
+ # @yieldparam err [StandardError] error object if request failed
4152
+ #
4153
+ # @return [Google::Apis::HealthcareV1::HttpBody]
4154
+ #
4155
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4156
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4157
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4158
+ def binary_project_location_dataset_fhir_store_fhir_create(parent, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4159
+ command = make_simple_command(:post, 'v1/{+parent}/fhir/Binary', options)
4160
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4161
+ command.request_object = http_body_object
4162
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4163
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
4164
+ command.params['parent'] = parent unless parent.nil?
4165
+ command.query['fields'] = fields unless fields.nil?
4166
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4167
+ execute_or_queue_command(command, &block)
4168
+ end
4169
+
4170
+ # Gets the contents of a FHIR Binary resource. This method can be used to
4171
+ # retrieve a Binary resource either by using the FHIR JSON mimetype as the value
4172
+ # for the Accept header, or as a raw data stream. If the FHIR Accept type is
4173
+ # used this method will return a Binary resource with the data base64-encoded,
4174
+ # regardless of how the resource was created. The resource data can be retrieved
4175
+ # in base64-decoded form if the Accept type of the request matches the value of
4176
+ # the resource's `contentType` field. The definition of the Binary REST API can
4177
+ # be found at https://hl7.org/fhir/binary.html#rest.
4178
+ # @param [String] name
4179
+ # Required. The name of the Binary resource to retrieve.
4180
+ # @param [String] fields
4181
+ # Selector specifying which fields to include in a partial response.
4182
+ # @param [String] quota_user
4183
+ # Available to use for quota purposes for server-side applications. Can be any
4184
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4185
+ # @param [Google::Apis::RequestOptions] options
4186
+ # Request-specific options
4187
+ #
4188
+ # @yield [result, err] Result & error if block supplied
4189
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
4190
+ # @yieldparam err [StandardError] error object if request failed
4191
+ #
4192
+ # @return [Google::Apis::HealthcareV1::HttpBody]
4193
+ #
4194
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4195
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4196
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4197
+ def binary_project_location_dataset_fhir_store_fhir_read(name, fields: nil, quota_user: nil, options: nil, &block)
4198
+ command = make_simple_command(:get, 'v1/{+name}', options)
4199
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4200
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
4201
+ command.params['name'] = name unless name.nil?
4202
+ command.query['fields'] = fields unless fields.nil?
4203
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4204
+ execute_or_queue_command(command, &block)
4205
+ end
4206
+
4207
+ # Updates the entire contents of a Binary resource. If the specified resource
4208
+ # does not exist and the FHIR store has enable_update_create set, creates the
4209
+ # resource with the client-specified ID. It is strongly advised not to include
4210
+ # or encode any sensitive data such as patient identifiers in client-specified
4211
+ # resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud
4212
+ # Audit Logs and Pub/Sub notifications. Those IDs can also be contained in
4213
+ # reference fields within other resources. This method can be used to update a
4214
+ # Binary resource either by using one of the accepted FHIR JSON content types,
4215
+ # or as a raw data stream. If a resource is updated with this method using the
4216
+ # FHIR content type this method's behavior is the same as `update`. If a
4217
+ # resource type other than Binary is used in the request it will be treated in
4218
+ # the same way as non-FHIR data. When a non-FHIR content type is used in the
4219
+ # request, a Binary resource will be generated using the ID from the resource
4220
+ # path, and the uploaded data will be stored in the `content` field (`DSTU2` and
4221
+ # `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will
4222
+ # be filled in using the value of the `Content-Type` header, and the `
4223
+ # securityContext` field (not present in `DSTU2`) will be populated from the `X-
4224
+ # Security-Context` header if it exists. At this time `securityContext` has no
4225
+ # special behavior in the Cloud Healthcare API. Note: the limit on data ingested
4226
+ # through this method is 2 GB. For best performance, use a non-FHIR data type
4227
+ # instead of wrapping the data in a Binary resource. Some of the Healthcare API
4228
+ # features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-
4229
+ # api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://
4230
+ # cloud.google.com/healthcare-api/docs/fhir-pubsub#
4231
+ # behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full
4232
+ # resource content, do not support Binary resources that are larger than 10 MB.
4233
+ # In these cases the resource's `data` field will be omitted. Instead, the "http:
4234
+ # //hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be
4235
+ # present to indicate that including the data is `unsupported`. On success, an
4236
+ # empty 200 OK response will be returned, or a 201 Created if the resource did
4237
+ # not exit. The resource's ID and version are returned in the Location header.
4238
+ # Using `Prefer: representation=resource` is not allowed for this method. The
4239
+ # definition of the Binary REST API can be found at https://hl7.org/fhir/binary.
4240
+ # html#rest.
4241
+ # @param [String] name
4242
+ # Required. The name of the resource to update.
4243
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
4244
+ # @param [String] fields
4245
+ # Selector specifying which fields to include in a partial response.
4246
+ # @param [String] quota_user
4247
+ # Available to use for quota purposes for server-side applications. Can be any
4248
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4249
+ # @param [Google::Apis::RequestOptions] options
4250
+ # Request-specific options
4251
+ #
4252
+ # @yield [result, err] Result & error if block supplied
4253
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
4254
+ # @yieldparam err [StandardError] error object if request failed
4255
+ #
4256
+ # @return [Google::Apis::HealthcareV1::HttpBody]
4257
+ #
4258
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4259
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4260
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4261
+ def binary_project_location_dataset_fhir_store_fhir_update(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4262
+ command = make_simple_command(:put, 'v1/{+name}', options)
4263
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4264
+ command.request_object = http_body_object
4265
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4266
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
4267
+ command.params['name'] = name unless name.nil?
4268
+ command.query['fields'] = fields unless fields.nil?
4269
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4270
+ execute_or_queue_command(command, &block)
4271
+ end
4272
+
4273
+ # Gets the contents of a version (current or historical) of a FHIR Binary
4274
+ # resource by version ID. This method can be used to retrieve a Binary resource
4275
+ # version either by using the FHIR JSON mimetype as the value for the Accept
4276
+ # header, or as a raw data stream. If the FHIR Accept type is used this method
4277
+ # will return a Binary resource with the data base64-encoded, regardless of how
4278
+ # the resource version was created. The resource data can be retrieved in base64-
4279
+ # decoded form if the Accept type of the request matches the value of the
4280
+ # resource version's `contentType` field. The definition of the Binary REST API
4281
+ # can be found at https://hl7.org/fhir/binary.html#rest.
4282
+ # @param [String] name
4283
+ # Required. The name of the Binary resource version to retrieve.
4284
+ # @param [String] fields
4285
+ # Selector specifying which fields to include in a partial response.
4286
+ # @param [String] quota_user
4287
+ # Available to use for quota purposes for server-side applications. Can be any
4288
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4289
+ # @param [Google::Apis::RequestOptions] options
4290
+ # Request-specific options
4291
+ #
4292
+ # @yield [result, err] Result & error if block supplied
4293
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
4294
+ # @yieldparam err [StandardError] error object if request failed
4295
+ #
4296
+ # @return [Google::Apis::HealthcareV1::HttpBody]
4297
+ #
4298
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4299
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4300
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4301
+ def binary_project_location_dataset_fhir_store_fhir_vread(name, fields: nil, quota_user: nil, options: nil, &block)
4302
+ command = make_simple_command(:get, 'v1/{+name}', options)
4303
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4304
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
4305
+ command.params['name'] = name unless name.nil?
4306
+ command.query['fields'] = fields unless fields.nil?
4307
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4308
+ execute_or_queue_command(command, &block)
4309
+ end
4310
+
4110
4311
  # Retrieves a Patient resource and resources related to that patient. Implements
4111
4312
  # the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/
4112
4313
  # implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](
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.65.0
4
+ version: 0.67.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: 2024-09-01 00:00:00.000000000 Z
11
+ date: 2024-09-22 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.65.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1/v0.67.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: []