generated/google/apis/healthcare_v1/service.rb in google-api-client-0.39.2 vs generated/google/apis/healthcare_v1/service.rb in google-api-client-0.39.3

- old
+ new

@@ -100,12 +100,12 @@ # If errors occur, error is set. # The LRO result may still be successful if de-identification fails for some # DICOM instances. The new de-identified dataset will not contain these # failed resources. Failed resource totals are tracked in # Operation.metadata. - # Error details are also logged to Stackdriver Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # Error details are also logged to Cloud Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/logging). # @param [String] source_dataset # Source dataset resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. # @param [Google::Apis::HealthcareV1::DeidentifyDatasetRequest] deidentify_dataset_request_object # @param [String] fields @@ -212,10 +212,13 @@ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be # rejected. # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. @@ -320,11 +323,11 @@ execute_or_queue_command(command, &block) end # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields @@ -356,11 +359,11 @@ execute_or_queue_command(command, &block) end # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. # @param [String] resource # REQUIRED: The resource for which the policy detail is being requested. @@ -441,12 +444,12 @@ # error is set. # The LRO result may still be successful if de-identification fails for some # DICOM instances. The output DICOM store will not contain # these failed resources. Failed resource totals are tracked in # Operation.metadata. - # Error details are also logged to Stackdriver - # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + # Error details are also logged to Cloud Logging + # (see [Viewing logs](/healthcare/docs/how-tos/logging)). # @param [String] source_store # Source DICOM store resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # dicomStores/`dicom_store_id``. # @param [Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest] deidentify_dicom_store_request_object @@ -510,12 +513,12 @@ execute_or_queue_command(command, &block) end # Exports data to the specified destination by copying it from the DICOM # store. - # Errors are also logged to Stackdriver Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # Errors are also logged to Cloud Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/logging). # The metadata field type is # OperationMetadata. # @param [String] name # The DICOM store resource name from which to export the data. For # example, @@ -592,10 +595,13 @@ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be # rejected. # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. @@ -621,12 +627,12 @@ command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Imports data into the DICOM store by copying it from the specified source. - # Errors are logged to Stackdriver Logging. For more information, see - # [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The + # Errors are logged to Cloud Logging. For more information, see + # [Viewing logs](/healthcare/docs/how-tos/logging). The # metadata field type is # OperationMetadata. # @param [String] name # The name of the DICOM store resource into which the data is imported. # For example, @@ -856,11 +862,11 @@ execute_or_queue_command(command, &block) end # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields @@ -933,11 +939,11 @@ execute_or_queue_command(command, &block) end # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. # @param [String] resource # REQUIRED: The resource for which the policy detail is being requested. @@ -1625,12 +1631,12 @@ # is OperationMetadata. # If the request is successful, the # response field type is # DeidentifyFhirStoreSummary. If errors occur, # error is set. - # Error details are also logged to Stackdriver - # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + # Error details are also logged to Cloud Logging + # (see [Viewing logs](/healthcare/docs/how-tos/logging)). # @param [String] source_store # Source FHIR store resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object @@ -1697,12 +1703,12 @@ # This method returns an Operation that can # be used to track the status of the export by calling # GetOperation. # Immediate fatal errors appear in the # error field, errors are also logged - # to Stackdriver (see [Viewing - # logs](/healthcare/docs/how-tos/stackdriver-logging)). + # to Cloud Logging (see [Viewing + # logs](/healthcare/docs/how-tos/logging)). # Otherwise, when the operation finishes, a detailed response of type # ExportResourcesResponse is returned in the # response field. # The metadata field type for this # operation is OperationMetadata. @@ -1782,10 +1788,13 @@ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be # rejected. # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. @@ -1829,11 +1838,11 @@ # setting on the FHIR store. This allows the import of resources with # arbitrary interdependencies without considering grouping or ordering, but # if the input data contains invalid references or if some resources fail to # be imported, the FHIR store might be left in a state that violates # referential integrity. - # The import process does not trigger PubSub notification or BigQuery + # The import process does not trigger Pub/Sub notification or BigQuery # streaming update, regardless of how those are configured on the FHIR store. # If a resource with the specified ID already exists, the most recent # version of the resource is overwritten without creating a new historical # version, regardless of the # disable_resource_versioning @@ -1868,12 +1877,12 @@ # This method returns an Operation that can # be used to track the status of the import by calling # GetOperation. # Immediate fatal errors appear in the # error field, errors are also logged - # to Stackdriver (see [Viewing - # logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the + # to Cloud Logging (see [Viewing + # logs](/healthcare/docs/how-tos/logging)). Otherwise, when the # operation finishes, a detailed response of type ImportResourcesResponse # is returned in the response field. # The metadata field type for this # operation is OperationMetadata. # @param [String] name @@ -1991,99 +2000,13 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Searches for resources in the given FHIR store according to criteria - # specified as query parameters. - # Implements the FHIR standard search interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) - # using the search semantics described in the FHIR Search specification - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). - # Supports three methods of search defined by the specification: - # * `GET [base]?[parameters]` to search across all resources. - # * `GET [base]/[type]?[parameters]` to search resources of a specified - # type. - # * `POST [base]/[type]/_search?[parameters]` as an alternate form having - # the same semantics as the `GET` method. - # The `GET` methods do not support compartment searches. The `POST` method - # does not support `application/x-www-form-urlencoded` search parameters. - # On success, the response body will contain a JSON-encoded representation - # of a `Bundle` resource of type `searchset`, containing the results of the - # search. - # Errors generated by the FHIR store will contain a JSON-encoded - # `OperationOutcome` resource describing the reason for the error. If the - # request cannot be mapped to a valid API method on a FHIR store, a generic - # GCP error might be returned instead. - # The server's capability statement, retrieved through - # capabilities, indicates what search parameters - # are supported on each FHIR resource. A list of all search parameters - # defined by the specification can be found in the FHIR Search Parameter - # Registry - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. - # html), - # [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)) - # . - # FHIR search parameters for DSTU2 can be found on each resource's definition - # page. - # Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, - # `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. - # Supported search result parameters: `_sort`, `_count`, `_include`, - # `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. - # The maximum number of search results returned defaults to 100, which can - # be overridden by the `_count` parameter up to a maximum limit of 1000. If - # there are additional results, the returned `Bundle` will contain - # pagination links. - # Resources with a total size larger than 5MB or a field count larger than - # 50,000 might not be fully searchable as the server might trim its generated - # search index in those cases. - # Note: FHIR resources are indexed asynchronously, so there might be a slight - # delay between the time a resource is created or changes and when the change - # is reflected in search results. - # @param [String] parent - # Name of the FHIR store to retrieve resources from. - # @param [String] resource_type - # The FHIR resource type to search, such as Patient or Observation. For a - # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::HealthcareV1::HttpBody] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_project_location_dataset_fhir_stores(parent, resource_type: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+parent}/fhir', options) - command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation - command.response_class = Google::Apis::HealthcareV1::HttpBody - command.params['parent'] = parent unless parent.nil? - command.query['resourceType'] = resource_type unless resource_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields @@ -2115,11 +2038,11 @@ execute_or_queue_command(command, &block) end # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. # @param [String] resource # REQUIRED: The resource for which the policy detail is being requested. @@ -2152,12 +2075,11 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Retrieves all the resources directly referenced by a patient, as well as - # all of the resources in the patient compartment. + # Retrieves a Patient resource and resources related to that patient. # Implements the FHIR extended operation Patient-everything # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html# # everything), # [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html# # everything), @@ -2168,10 +2090,20 @@ # operation. # Errors generated by the FHIR store will contain a JSON-encoded # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. + # The resources in scope for the response are: + # * The patient resource itself. + # * All the resources directly referenced by the patient resource. + # * Resources directly referencing the patient resource that meet the + # inclusion criteria. The inclusion criteria are based on the membership + # rules in the patient compartment definition + # ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), + # [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), + # [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which + # details the eligible resource types and referencing search parameters. # @param [String] name # Name of the `Patient` resource for which the information is required. # @param [Fixnum] _count # Maximum number of resources in a page. Defaults to 100. # @param [String] _page_token @@ -2894,10 +2826,13 @@ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be # rejected. # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. @@ -3006,11 +2941,11 @@ execute_or_queue_command(command, &block) end # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields @@ -3042,10 +2977,10 @@ execute_or_queue_command(command, &block) end # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. # @param [String] resource # REQUIRED: The resource for which the policy detail is being requested.