google-apis-healthcare_v1beta1 0.54.0 → 0.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99cf872a52524ebf4a9e6bffbf2495cb6383610ab85bf1494e75f2bdd02a6124
-  data.tar.gz: 0114dbd1d2eb8afd3eb0b4167e06ff710f1e0f0994ca56b9b5296b159f0fd871
+  metadata.gz: f37f1ee250be74bd390d34084d90873153305f42d2ba87b185627b009e2c67bc
+  data.tar.gz: 69b6cd156f006d3b9703f930f3140a04df5f72af56a079afee10f038930d7e41
 SHA512:
-  metadata.gz: d0f64926ef1c21e6a077126ccef235aa205c98e70d6935bb7db774a35147f1acd6e3bfc3c216d7ec262e0b4a4c55c9ac7921083df729eb1ae6da09926fa8451f
-  data.tar.gz: c8a360cb830a01dac3bf9d0a7e5ef5b4f81f0ec84374bf2002ef08b714486db25e765c89c1a35f9b6bddb917a9ce2904cbf0465cc47a7937d91ef0b2dee6a9d6
+  metadata.gz: e9fbea24ada856115910f0a2763d78720b02d6ef56a186d5c1a7a278a739f0bb92a2b37551034f90da2343415a4a310ebec8dbb270d5fb4cee4cba8b9634857b
+  data.tar.gz: ec75c627cb6bfbed90124c3ada01f5a53ccd04c0a9485c48bf12b5c5250cc8f62f09822f19e76b7891cf5593a6e8f82639efaf2df3e84b77bd05e97e2b9fe75e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-healthcare_v1beta1
 
+### v0.56.0 (2023-10-01)
+
+* Regenerated from discovery document revision 20230921
+
+### v0.55.0 (2023-09-24)
+
+* Regenerated from discovery document revision 20230912
+
 ### v0.54.0 (2023-09-03)
 
 * Regenerated from discovery document revision 20230817

data/lib/google/apis/healthcare_v1beta1/classes.rb

@@ -22,6 +22,29 @@ module Google
   module Apis
     module HealthcareV1beta1
       
+      # Configures consent audit log config for FHIR create, read, update, and delete (
+      # CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://
+      # cloud.google.com/logging/docs/audit/configure-data-access#config-console-
+      # enable). The consent-related logs are included as part of `protoPayload.
+      # metadata`.
+      class AccessDeterminationLogConfig
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Controls the amount of detail to include as part of the audit logs.
+        # Corresponds to the JSON property `logLevel`
+        # @return [String]
+        attr_accessor :log_level
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @log_level = args[:log_level] if args.key?(:log_level)
+        end
+      end
+      
       # Specifies a selection of tags and an `Action` to apply to each one.
       class Action
         include Google::Apis::Core::Hashable
@@ -31,7 +54,7 @@ module Google
         # @return [Google::Apis::HealthcareV1beta1::ImageConfig]
         attr_accessor :clean_image_tag
       
-        # Inspect text and transform sensitive text. Configurable using `TextConfig`.
+        # Inspect text and transform sensitive text. Configurable using TextConfig.
         # Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/
         # output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT,
         # DA, DT, AS
@@ -136,6 +159,30 @@ module Google
         end
       end
       
+      # List of admin Consent resources to be applied.
+      class AdminConsents
+        include Google::Apis::Core::Hashable
+      
+        # The versioned names of the admin Consent resource(s), in the format `projects/`
+        # project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
+        # fhir_store_id`/fhir/Consent/`resource_id`/_history/`version_id``. For FHIR
+        # stores with `disable_resource_versioning=true`, the format is `projects/`
+        # project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
+        # fhir_store_id`/fhir/Consent/`resource_id``.
+        # Corresponds to the JSON property `names`
+        # @return [Array<String>]
+        attr_accessor :names
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @names = args[:names] if args.key?(:names)
+        end
+      end
+      
       # The request to analyze healthcare entities in a document.
       class AnalyzeEntitiesRequest
         include Google::Apis::Core::Hashable
@@ -348,6 +395,165 @@ module Google
         end
       end
       
+      # Request to apply the admin Consent resources for the specified FHIR store.
+      class ApplyAdminConsentsRequest
+        include Google::Apis::Core::Hashable
+      
+        # List of admin Consent resources to be applied.
+        # Corresponds to the JSON property `newConsentsList`
+        # @return [Google::Apis::HealthcareV1beta1::AdminConsents]
+        attr_accessor :new_consents_list
+      
+        # If true, the method only validates Consent resources to make sure they are
+        # supported. Otherwise, the method applies the aggregate consent information to
+        # update the enforcement model and reindex the FHIR resources. If all Consent
+        # resources can be applied successfully, the ApplyAdminConsentsResponse is
+        # returned containing the following fields: * `consent_apply_success` to
+        # indicate the number of Consent resources applied. * `affected_resources` to
+        # indicate the number of resources that might have had their consent access
+        # changed. If, however, one or more Consent resources are unsupported or cannot
+        # be applied, the method fails and ApplyAdminConsentsErrorDetail is is returned
+        # with details about the unsupported Consent resources.
+        # Corresponds to the JSON property `validateOnly`
+        # @return [Boolean]
+        attr_accessor :validate_only
+        alias_method :validate_only?, :validate_only
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @new_consents_list = args[:new_consents_list] if args.key?(:new_consents_list)
+          @validate_only = args[:validate_only] if args.key?(:validate_only)
+        end
+      end
+      
+      # Response when all admin Consent resources in scope were processed and all
+      # affected resources were reindexed successfully. This structure will be
+      # included in the response when the operation finishes successfully.
+      class ApplyAdminConsentsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The number of resources (including the Consent resources) that may have
+        # consent access change.
+        # Corresponds to the JSON property `affectedResources`
+        # @return [Fixnum]
+        attr_accessor :affected_resources
+      
+        # If `validate_only=false` in ApplyAdminConsentsRequest, this counter contains
+        # the number of Consent resources that were successfully applied. Otherwise, it
+        # is the number of Consent resources that are supported.
+        # Corresponds to the JSON property `consentApplySuccess`
+        # @return [Fixnum]
+        attr_accessor :consent_apply_success
+      
+        # The number of resources (including the Consent resources) that
+        # ApplyAdminConsents failed to re-index.
+        # Corresponds to the JSON property `failedResources`
+        # @return [Fixnum]
+        attr_accessor :failed_resources
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @affected_resources = args[:affected_resources] if args.key?(:affected_resources)
+          @consent_apply_success = args[:consent_apply_success] if args.key?(:consent_apply_success)
+          @failed_resources = args[:failed_resources] if args.key?(:failed_resources)
+        end
+      end
+      
+      # Request to apply the Consent resources for the specified FHIR store.
+      class ApplyConsentsRequest
+        include Google::Apis::Core::Hashable
+      
+        # Apply consents given by a list of patients.
+        # Corresponds to the JSON property `patientScope`
+        # @return [Google::Apis::HealthcareV1beta1::PatientScope]
+        attr_accessor :patient_scope
+      
+        # Apply consents given by patients whose most recent consent changes are in the
+        # time range. Note that after identifying these patients, the server applies all
+        # Consent resources given by those patients, not just the Consent resources
+        # within the timestamp in the range.
+        # Corresponds to the JSON property `timeRange`
+        # @return [Google::Apis::HealthcareV1beta1::TimeRange]
+        attr_accessor :time_range
+      
+        # Optional. If true, the method only validates Consent resources to make sure
+        # they are supported. When the operation completes, ApplyConsentsResponse is
+        # returned where `consent_apply_success` and `consent_apply_failure` indicate
+        # supported and unsupported (or invalid) Consent resources, respectively.
+        # Otherwise, the method propagates the aggregate consensual information to the
+        # patient's resources. Upon success, `affected_resources` in the
+        # ApplyConsentsResponse indicates the number of resources that may have
+        # consensual access changed.
+        # Corresponds to the JSON property `validateOnly`
+        # @return [Boolean]
+        attr_accessor :validate_only
+        alias_method :validate_only?, :validate_only
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @patient_scope = args[:patient_scope] if args.key?(:patient_scope)
+          @time_range = args[:time_range] if args.key?(:time_range)
+          @validate_only = args[:validate_only] if args.key?(:validate_only)
+        end
+      end
+      
+      # Response when all Consent resources in scope were processed and all affected
+      # resources were reindexed successfully. This structure is included in the
+      # response when the operation finishes successfully.
+      class ApplyConsentsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The number of resources (including the Consent resources) that may have
+        # consensual access change.
+        # Corresponds to the JSON property `affectedResources`
+        # @return [Fixnum]
+        attr_accessor :affected_resources
+      
+        # If `validate_only = false` in ApplyConsentsRequest, this counter is the number
+        # of Consent resources that were failed to apply. Otherwise, it is the number of
+        # Consent resources that are not supported or invalid.
+        # Corresponds to the JSON property `consentApplyFailure`
+        # @return [Fixnum]
+        attr_accessor :consent_apply_failure
+      
+        # If `validate_only = false` in ApplyConsentsRequest, this counter is the number
+        # of Consent resources that were successfully applied. Otherwise, it is the
+        # number of Consent resources that are supported.
+        # Corresponds to the JSON property `consentApplySuccess`
+        # @return [Fixnum]
+        attr_accessor :consent_apply_success
+      
+        # The number of resources (including the Consent resources) that ApplyConsents
+        # failed to re-index.
+        # Corresponds to the JSON property `failedResources`
+        # @return [Fixnum]
+        attr_accessor :failed_resources
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @affected_resources = args[:affected_resources] if args.key?(:affected_resources)
+          @consent_apply_failure = args[:consent_apply_failure] if args.key?(:consent_apply_failure)
+          @consent_apply_success = args[:consent_apply_success] if args.key?(:consent_apply_success)
+          @failed_resources = args[:failed_resources] if args.key?(:failed_resources)
+        end
+      end
+      
       # Archives the specified User data mapping.
       class ArchiveUserDataMappingRequest
         include Google::Apis::Core::Hashable
@@ -803,7 +1009,7 @@ module Google
         end
       end
       
-      # Inspect text and transform sensitive text. Configurable using `TextConfig`.
+      # Inspect text and transform sensitive text. Configurable using TextConfig.
       # Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/
       # output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT,
       # DA, DT, AS
@@ -1022,6 +1228,66 @@ module Google
         end
       end
       
+      # Configures whether to enforce consent for the FHIR store and which consent
+      # enforcement version is being used.
+      class ConsentConfig
+        include Google::Apis::Core::Hashable
+      
+        # Configures consent audit log config for FHIR create, read, update, and delete (
+        # CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://
+        # cloud.google.com/logging/docs/audit/configure-data-access#config-console-
+        # enable). The consent-related logs are included as part of `protoPayload.
+        # metadata`.
+        # Corresponds to the JSON property `accessDeterminationLogConfig`
+        # @return [Google::Apis::HealthcareV1beta1::AccessDeterminationLogConfig]
+        attr_accessor :access_determination_log_config
+      
+        # Optional. If set to true, when accessing FHIR resources, the consent headers
+        # provided using [SMART-on-FHIR](https://cloud.google.com/healthcare/private/
+        # docs/how-tos/smart-on-fhir) will be verified against consents given by
+        # patients. See the ConsentEnforcementVersion for the supported consent headers.
+        # Corresponds to the JSON property `accessEnforced`
+        # @return [Boolean]
+        attr_accessor :access_enforced
+        alias_method :access_enforced?, :access_enforced
+      
+        # How the server handles the consent header.
+        # Corresponds to the JSON property `consentHeaderHandling`
+        # @return [Google::Apis::HealthcareV1beta1::ConsentHeaderHandling]
+        attr_accessor :consent_header_handling
+      
+        # The versioned names of the enforced admin Consent resource(s), in the format `
+        # projects/`project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
+        # fhir_store_id`/fhir/Consent/`resource_id`/_history/`version_id``. For FHIR
+        # stores with `disable_resource_versioning=true`, the format is `projects/`
+        # project_id`/locations/`location`/datasets/`dataset_id`/fhirStores/`
+        # fhir_store_id`/fhir/Consent/`resource_id``. This field can only be updated
+        # using ApplyAdminConsents.
+        # Corresponds to the JSON property `enforcedAdminConsents`
+        # @return [Array<String>]
+        attr_accessor :enforced_admin_consents
+      
+        # Required. Specifies which consent enforcement version is being used for this
+        # FHIR store. This field can only be set once by either CreateFhirStore or
+        # UpdateFhirStore. After that, you must call ApplyConsents to change the version.
+        # Corresponds to the JSON property `version`
+        # @return [String]
+        attr_accessor :version
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @access_determination_log_config = args[:access_determination_log_config] if args.key?(:access_determination_log_config)
+          @access_enforced = args[:access_enforced] if args.key?(:access_enforced)
+          @consent_header_handling = args[:consent_header_handling] if args.key?(:consent_header_handling)
+          @enforced_admin_consents = args[:enforced_admin_consents] if args.key?(:enforced_admin_consents)
+          @version = args[:version] if args.key?(:version)
+        end
+      end
+      
       # The detailed evaluation of a particular Consent.
       class ConsentEvaluation
         include Google::Apis::Core::Hashable
@@ -1041,6 +1307,26 @@ module Google
         end
       end
       
+      # How the server handles the consent header.
+      class ConsentHeaderHandling
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Specifies the default server behavior when the header is empty. If
+        # not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used.
+        # Corresponds to the JSON property `profile`
+        # @return [String]
+        attr_accessor :profile
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @profile = args[:profile] if args.key?(:profile)
+        end
+      end
+      
       # List of resource names of Consent resources.
       class ConsentList
         include Google::Apis::Core::Hashable
@@ -1361,9 +1647,9 @@ module Google
         # Ensures in-flight data remains in the region of origin during de-
         # identification. Using this option results in a significant reduction of
         # throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME`
-        # infoTypes. If the deprecated `DicomConfig` or `FhirConfig` are used, then `
-        # LOCATION` must be excluded within `TextConfig`, and must also be excluded
-        # within `ImageConfig` if image redaction is required.
+        # infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `
+        # LOCATION` must be excluded within TextConfig, and must also be excluded within
+        # ImageConfig if image redaction is required.
         # Corresponds to the JSON property `useRegionalDataProcessing`
         # @return [Boolean]
         attr_accessor :use_regional_data_processing
@@ -2545,8 +2831,8 @@ module Google
         # healthcare.fhirResources.update permission on the destination store to your
         # project's **Cloud Healthcare Service Agent** [service account](https://cloud.
         # google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#
-        # the_cloud_healthcare_service_agent). The destination store must set `
-        # enable_update_create` to true. The destination store must use FHIR version R4.
+        # the_cloud_healthcare_service_agent). The destination store must set
+        # enableUpdateCreate to true. The destination store must use FHIR version R4.
         # Writing these resources will consume FHIR operations quota from the project
         # containing the source data. De-identify operation metadata is only generated
         # for DICOM de-identification operations.
@@ -2580,6 +2866,12 @@ module Google
         # @return [String]
         attr_accessor :complex_data_type_reference_parsing
       
+        # Configures whether to enforce consent for the FHIR store and which consent
+        # enforcement version is being used.
+        # Corresponds to the JSON property `consentConfig`
+        # @return [Google::Apis::HealthcareV1beta1::ConsentConfig]
+        attr_accessor :consent_config
+      
         # If true, overrides the default search behavior for this FHIR store to `
         # handling=strict` which returns an error for unrecognized search parameters. If
         # false, uses the FHIR specification default `handling=lenient` which ignores
@@ -2697,6 +2989,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @complex_data_type_reference_parsing = args[:complex_data_type_reference_parsing] if args.key?(:complex_data_type_reference_parsing)
+          @consent_config = args[:consent_config] if args.key?(:consent_config)
           @default_search_handling_strict = args[:default_search_handling_strict] if args.key?(:default_search_handling_strict)
           @disable_referential_integrity = args[:disable_referential_integrity] if args.key?(:disable_referential_integrity)
           @disable_resource_versioning = args[:disable_resource_versioning] if args.key?(:disable_resource_versioning)
@@ -4957,14 +5250,17 @@ module Google
         # @return [String]
         attr_accessor :create_time
       
-        # The time at which execution was completed.
+        # The time at which execution workloads were completed. Some tasks will complete
+        # after this time such as logging audit logs.
         # Corresponds to the JSON property `endTime`
         # @return [String]
         attr_accessor :end_time
       
         # A link to audit and error logs in the log viewer. Error logs are generated
         # only by some operations, listed at [Viewing error logs in Cloud Logging](https:
-        # //cloud.google.com/healthcare/docs/how-tos/logging).
+        # //cloud.google.com/healthcare/docs/how-tos/logging). The `end_time` specified
+        # in this URL may not match the end time on the metadata because logs are
+        # written asynchronously from execution.
         # Corresponds to the JSON property `logsUrl`
         # @return [String]
         attr_accessor :logs_url
@@ -5111,6 +5407,27 @@ module Google
         end
       end
       
+      # Apply consents given by a list of patients.
+      class PatientScope
+        include Google::Apis::Core::Hashable
+      
+        # Optional. The list of patient IDs whose Consent resources will be enforced. At
+        # most 10,000 patients can be specified. An empty list is equivalent to all
+        # patients (meaning the entire FHIR store).
+        # Corresponds to the JSON property `patientIds`
+        # @return [Array<String>]
+        attr_accessor :patient_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @patient_ids = args[:patient_ids] if args.key?(:patient_ids)
+        end
+      end
+      
       # An Identity and Access Management (IAM) policy, which specifies access
       # controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
       # A `binding` binds one or more `members`, or principals, to a single `role`.
@@ -5220,6 +5537,16 @@ module Google
         # @return [Fixnum]
         attr_accessor :pending
       
+        # The number of secondary units that failed in the operation.
+        # Corresponds to the JSON property `secondaryFailure`
+        # @return [Fixnum]
+        attr_accessor :secondary_failure
+      
+        # The number of secondary units that succeeded in the operation.
+        # Corresponds to the JSON property `secondarySuccess`
+        # @return [Fixnum]
+        attr_accessor :secondary_success
+      
         # The number of units that succeeded in the operation.
         # Corresponds to the JSON property `success`
         # @return [Fixnum]
@@ -5233,6 +5560,8 @@ module Google
         def update!(**args)
           @failure = args[:failure] if args.key?(:failure)
           @pending = args[:pending] if args.key?(:pending)
+          @secondary_failure = args[:secondary_failure] if args.key?(:secondary_failure)
+          @secondary_success = args[:secondary_success] if args.key?(:secondary_success)
           @success = args[:success] if args.key?(:success)
         end
       end
@@ -6184,6 +6513,36 @@ module Google
         end
       end
       
+      # Apply consents given by patients whose most recent consent changes are in the
+      # time range. Note that after identifying these patients, the server applies all
+      # Consent resources given by those patients, not just the Consent resources
+      # within the timestamp in the range.
+      class TimeRange
+        include Google::Apis::Core::Hashable
+      
+        # Optional. The latest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+zz:
+        # zz If not specified, the system uses the time when ApplyConsents was called.
+        # Corresponds to the JSON property `end`
+        # @return [String]
+        attr_accessor :end
+      
+        # Optional. The earliest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+
+        # zz:zz If not specified, the system uses the FHIR store creation time.
+        # Corresponds to the JSON property `start`
+        # @return [String]
+        attr_accessor :start
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @end = args[:end] if args.key?(:end)
+          @start = args[:start] if args.key?(:start)
+        end
+      end
+      
       # A type definition for some HL7v2 type (incl. Segments and Datatypes).
       class Type
         include Google::Apis::Core::Hashable

data/lib/google/apis/healthcare_v1beta1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module HealthcareV1beta1
       # Version of the google-apis-healthcare_v1beta1 gem
-      GEM_VERSION = "0.54.0"
+      GEM_VERSION = "0.56.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230817"
+      REVISION = "20230921"
     end
   end
 end

data/lib/google/apis/healthcare_v1beta1/representations.rb

@@ -22,6 +22,12 @@ module Google
   module Apis
     module HealthcareV1beta1
       
+      class AccessDeterminationLogConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Action
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -34,6 +40,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class AdminConsents
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class AnalyzeEntitiesRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -70,6 +82,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ApplyAdminConsentsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ApplyAdminConsentsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ApplyConsentsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ApplyConsentsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ArchiveUserDataMappingRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -196,12 +232,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ConsentConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ConsentEvaluation
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ConsentHeaderHandling
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ConsentList
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -922,6 +970,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PatientScope
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Policy
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1144,6 +1198,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class TimeRange
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Type
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1174,6 +1234,13 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class AccessDeterminationLogConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :log_level, as: 'logLevel'
+        end
+      end
+      
       class Action
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1206,6 +1273,13 @@ module Google
         end
       end
       
+      class AdminConsents
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :names, as: 'names'
+        end
+      end
+      
       class AnalyzeEntitiesRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1268,6 +1342,45 @@ module Google
         end
       end
       
+      class ApplyAdminConsentsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :new_consents_list, as: 'newConsentsList', class: Google::Apis::HealthcareV1beta1::AdminConsents, decorator: Google::Apis::HealthcareV1beta1::AdminConsents::Representation
+      
+          property :validate_only, as: 'validateOnly'
+        end
+      end
+      
+      class ApplyAdminConsentsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :affected_resources, :numeric_string => true, as: 'affectedResources'
+          property :consent_apply_success, :numeric_string => true, as: 'consentApplySuccess'
+          property :failed_resources, :numeric_string => true, as: 'failedResources'
+        end
+      end
+      
+      class ApplyConsentsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :patient_scope, as: 'patientScope', class: Google::Apis::HealthcareV1beta1::PatientScope, decorator: Google::Apis::HealthcareV1beta1::PatientScope::Representation
+      
+          property :time_range, as: 'timeRange', class: Google::Apis::HealthcareV1beta1::TimeRange, decorator: Google::Apis::HealthcareV1beta1::TimeRange::Representation
+      
+          property :validate_only, as: 'validateOnly'
+        end
+      end
+      
+      class ApplyConsentsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :affected_resources, :numeric_string => true, as: 'affectedResources'
+          property :consent_apply_failure, :numeric_string => true, as: 'consentApplyFailure'
+          property :consent_apply_success, :numeric_string => true, as: 'consentApplySuccess'
+          property :failed_resources, :numeric_string => true, as: 'failedResources'
+        end
+      end
+      
       class ArchiveUserDataMappingRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1451,6 +1564,19 @@ module Google
         end
       end
       
+      class ConsentConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :access_determination_log_config, as: 'accessDeterminationLogConfig', class: Google::Apis::HealthcareV1beta1::AccessDeterminationLogConfig, decorator: Google::Apis::HealthcareV1beta1::AccessDeterminationLogConfig::Representation
+      
+          property :access_enforced, as: 'accessEnforced'
+          property :consent_header_handling, as: 'consentHeaderHandling', class: Google::Apis::HealthcareV1beta1::ConsentHeaderHandling, decorator: Google::Apis::HealthcareV1beta1::ConsentHeaderHandling::Representation
+      
+          collection :enforced_admin_consents, as: 'enforcedAdminConsents'
+          property :version, as: 'version'
+        end
+      end
+      
       class ConsentEvaluation
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1458,6 +1584,13 @@ module Google
         end
       end
       
+      class ConsentHeaderHandling
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :profile, as: 'profile'
+        end
+      end
+      
       class ConsentList
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1882,6 +2015,8 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :complex_data_type_reference_parsing, as: 'complexDataTypeReferenceParsing'
+          property :consent_config, as: 'consentConfig', class: Google::Apis::HealthcareV1beta1::ConsentConfig, decorator: Google::Apis::HealthcareV1beta1::ConsentConfig::Representation
+      
           property :default_search_handling_strict, as: 'defaultSearchHandlingStrict'
           property :disable_referential_integrity, as: 'disableReferentialIntegrity'
           property :disable_resource_versioning, as: 'disableResourceVersioning'
@@ -2582,6 +2717,13 @@ module Google
         end
       end
       
+      class PatientScope
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :patient_ids, as: 'patientIds'
+        end
+      end
+      
       class Policy
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2599,6 +2741,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :failure, :numeric_string => true, as: 'failure'
           property :pending, :numeric_string => true, as: 'pending'
+          property :secondary_failure, :numeric_string => true, as: 'secondaryFailure'
+          property :secondary_success, :numeric_string => true, as: 'secondarySuccess'
           property :success, :numeric_string => true, as: 'success'
         end
       end
@@ -2888,6 +3032,14 @@ module Google
         end
       end
       
+      class TimeRange
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end, as: 'end'
+          property :start, as: 'start'
+        end
+      end
+      
       class Type
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/healthcare_v1beta1/service.rb

@@ -3877,6 +3877,100 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Applies the admin Consent resources for the FHIR store and reindexes the
+        # underlying resources in the FHIR store according to the aggregate consents.
+        # This method also updates the `consent_config.enforced_admin_consents` field of
+        # the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any
+        # admin Consent resource change after this operation execution (including
+        # deletion) requires you to call ApplyAdminConsents again for the change to take
+        # effect. This method returns an Operation that can be used to track the
+        # progress of the resources that were reindexed, by calling GetOperation. Upon
+        # completion, the ApplyAdminConsentsResponse additionally contains the number of
+        # resources that were reindexed. If at least one Consent resource contains an
+        # error or fails be be enforced for any reason, the method returns an error
+        # instead of an Operation. No resources will be reindexed and the `
+        # consent_config.enforced_admin_consents` field will be unchanged. To enforce a
+        # consent check for data access, `consent_config.access_enforced` must be set to
+        # true for the FhirStore.
+        # @param [String] name
+        #   The name of the FHIR store to enforce, in the format `projects/`project_id`/
+        #   locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
+        # @param [Google::Apis::HealthcareV1beta1::ApplyAdminConsentsRequest] apply_admin_consents_request_object
+        # @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::HealthcareV1beta1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::Operation]
+        #
+        # @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 apply_fhir_store_admin_consents(name, apply_admin_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+name}:applyAdminConsents', options)
+          command.request_representation = Google::Apis::HealthcareV1beta1::ApplyAdminConsentsRequest::Representation
+          command.request_object = apply_admin_consents_request_object
+          command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::Operation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Apply the Consent resources for the FHIR store and reindex the underlying
+        # resources in the FHIR store according to the aggregate consent. The aggregate
+        # consent of the patient in scope in this request replaces any previous call of
+        # this method. Any Consent resource change after this operation execution (
+        # including deletion) requires you to call ApplyConsents again to have effect.
+        # This method returns an Operation that can be used to track the progress of the
+        # consent resources that were processed by calling GetOperation. Upon completion,
+        # the ApplyConsentsResponse additionally contains the number of resources that
+        # was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in
+        # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To
+        # enforce consent check for data access, `consent_config.access_enforced` must
+        # be set to true for the FhirStore.
+        # @param [String] name
+        #   Required. The name of the FHIR store to enforce, in the format `projects/`
+        #   project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
+        #   fhir_store_id``.
+        # @param [Google::Apis::HealthcareV1beta1::ApplyConsentsRequest] apply_consents_request_object
+        # @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::HealthcareV1beta1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::Operation]
+        #
+        # @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 apply_fhir_store_consents(name, apply_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+name}:applyConsents', options)
+          command.request_representation = Google::Apis::HealthcareV1beta1::ApplyConsentsRequest::Representation
+          command.request_object = apply_consents_request_object
+          command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::Operation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Configure the search parameters for the FHIR store and reindex resources in
         # the FHIR store according to the defined search parameters. The search
         # parameters provided in this request will replace any previous search
@@ -4545,6 +4639,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Returns the consent enforcement status of a single consent resource. On
+        # success, the response body contains a JSON-encoded representation of a `
+        # Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, containing
+        # the current enforcement status. Does not support DSTU2.
+        # @param [String] name
+        #   Required. The name of the consent resource to find enforcement status, in the
+        #   format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+        #   fhirStores/`fhir_store_id`/fhir/Consent/`consent_id``
+        # @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::HealthcareV1beta1::HttpBody] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::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 consent_project_location_dataset_fhir_store_fhir_enforcement_status(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+name}/$consent-enforcement-status', options)
+          command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Retrieves the N most recent `Observation` resources for a subject matching
         # search criteria specified as query parameters, grouped by `Observation.code`,
         # sorted from most recent to oldest. Implements the FHIR extended operation
@@ -4597,6 +4726,54 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Returns the consent enforcement status of all consent resources for a patient.
+        # On success, the response body contains a JSON-encoded representation of a
+        # bundle of `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resources,
+        # containing the current enforcement status for each consent resource of the
+        # patient. Does not support DSTU2.
+        # @param [String] name
+        #   Required. The name of the patient to find enforcement statuses, in the format `
+        #   projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
+        #   `fhir_store_id`/fhir/Patient/`patient_id``
+        # @param [Fixnum] _count
+        #   Optional. The maximum number of results on a page. If not specified, 100 is
+        #   used. May not be larger than 1000.
+        # @param [String] _page_token
+        #   Optional. Used to retrieve the first, previous, next, or last page of consent
+        #   enforcement statuses when using pagination. Value should be set to the value
+        #   of `_page_token` set in next or previous page links' URLs. Next and previous
+        #   page are returned in the response bundle's links field, where `link.relation`
+        #   is "previous" or "next". Omit `_page_token` if no previous request has been
+        #   made.
+        # @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::HealthcareV1beta1::HttpBody] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::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 patient_project_location_dataset_fhir_store_fhir_consent_enforcement_status(name, _count: nil, _page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+name}/$consent-enforcement-status', options)
+          command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
+          command.params['name'] = name unless name.nil?
+          command.query['_count'] = _count unless _count.nil?
+          command.query['_page_token'] = _page_token unless _page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Retrieves a Patient resource and resources related to that patient. Implements
         # the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/
         # implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](

data/lib/google/apis/healthcare_v1beta1.rb

@@ -29,6 +29,9 @@ module Google
       # This is NOT the gem version.
       VERSION = 'V1beta1'
 
+      # Read, write and manage healthcare data
+      AUTH_CLOUD_HEALTHCARE = 'https://www.googleapis.com/auth/cloud-healthcare'
+
       # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-healthcare_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.54.0
+  version: 0.56.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.54.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.56.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1beta1
 post_install_message: 
 rdoc_options: []