google-apis-healthcare_v1 0.69.0 → 0.71.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3431,6 +3431,9 @@ module Google
|
|
3431
3431
|
# Required. The path of the RetrieveRenderedInstance DICOMweb request. For
|
3432
3432
|
# example, `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
|
3433
3433
|
# rendered`.
|
3434
|
+
# @param [String] viewport
|
3435
|
+
# Optional. The viewport setting to use as specified in https://dicom.nema.org/
|
3436
|
+
# medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3
|
3434
3437
|
# @param [String] fields
|
3435
3438
|
# Selector specifying which fields to include in a partial response.
|
3436
3439
|
# @param [String] quota_user
|
@@ -3448,12 +3451,13 @@ module Google
|
|
3448
3451
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3449
3452
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3450
3453
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3451
|
-
def retrieve_project_location_dataset_dicom_store_study_series_instance_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
3454
|
+
def retrieve_project_location_dataset_dicom_store_study_series_instance_rendered(parent, dicom_web_path, viewport: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3452
3455
|
command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
3453
3456
|
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
3454
3457
|
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
3455
3458
|
command.params['parent'] = parent unless parent.nil?
|
3456
3459
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
3460
|
+
command.query['viewport'] = viewport unless viewport.nil?
|
3457
3461
|
command.query['fields'] = fields unless fields.nil?
|
3458
3462
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3459
3463
|
execute_or_queue_command(command, &block)
|
@@ -3520,6 +3524,9 @@ module Google
|
|
3520
3524
|
# Required. The path of the RetrieveRenderedFrames DICOMweb request. For example,
|
3521
3525
|
# `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
|
3522
3526
|
# frame_list`/rendered`.
|
3527
|
+
# @param [String] viewport
|
3528
|
+
# Optional. The viewport setting to use as specified in https://dicom.nema.org/
|
3529
|
+
# medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3
|
3523
3530
|
# @param [String] fields
|
3524
3531
|
# Selector specifying which fields to include in a partial response.
|
3525
3532
|
# @param [String] quota_user
|
@@ -3537,12 +3544,196 @@ module Google
|
|
3537
3544
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3538
3545
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3539
3546
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3540
|
-
def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
3547
|
+
def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_rendered(parent, dicom_web_path, viewport: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3541
3548
|
command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
3542
3549
|
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
3543
3550
|
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
3544
3551
|
command.params['parent'] = parent unless parent.nil?
|
3545
3552
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
3553
|
+
command.query['viewport'] = viewport unless viewport.nil?
|
3554
|
+
command.query['fields'] = fields unless fields.nil?
|
3555
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3556
|
+
execute_or_queue_command(command, &block)
|
3557
|
+
end
|
3558
|
+
|
3559
|
+
# Applies the admin Consent resources for the FHIR store and reindexes the
|
3560
|
+
# underlying resources in the FHIR store according to the aggregate consents.
|
3561
|
+
# This method also updates the `consent_config.enforced_admin_consents` field of
|
3562
|
+
# the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any
|
3563
|
+
# admin Consent resource change after this operation execution (including
|
3564
|
+
# deletion) requires you to call ApplyAdminConsents again for the change to take
|
3565
|
+
# effect. This method returns an Operation that can be used to track the
|
3566
|
+
# progress of the resources that were reindexed, by calling GetOperation. Upon
|
3567
|
+
# completion, the ApplyAdminConsentsResponse additionally contains the number of
|
3568
|
+
# resources that were reindexed. If at least one Consent resource contains an
|
3569
|
+
# error or fails be be enforced for any reason, the method returns an error
|
3570
|
+
# instead of an Operation. No resources will be reindexed and the `
|
3571
|
+
# consent_config.enforced_admin_consents` field will be unchanged. To enforce a
|
3572
|
+
# consent check for data access, `consent_config.access_enforced` must be set to
|
3573
|
+
# true for the FhirStore.
|
3574
|
+
# @param [String] name
|
3575
|
+
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
3576
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
3577
|
+
# fhir_store_id``.
|
3578
|
+
# @param [Google::Apis::HealthcareV1::ApplyAdminConsentsRequest] apply_admin_consents_request_object
|
3579
|
+
# @param [String] fields
|
3580
|
+
# Selector specifying which fields to include in a partial response.
|
3581
|
+
# @param [String] quota_user
|
3582
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3583
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3584
|
+
# @param [Google::Apis::RequestOptions] options
|
3585
|
+
# Request-specific options
|
3586
|
+
#
|
3587
|
+
# @yield [result, err] Result & error if block supplied
|
3588
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
|
3589
|
+
# @yieldparam err [StandardError] error object if request failed
|
3590
|
+
#
|
3591
|
+
# @return [Google::Apis::HealthcareV1::Operation]
|
3592
|
+
#
|
3593
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3594
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3595
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3596
|
+
def apply_fhir_store_admin_consents(name, apply_admin_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3597
|
+
command = make_simple_command(:post, 'v1/{+name}:applyAdminConsents', options)
|
3598
|
+
command.request_representation = Google::Apis::HealthcareV1::ApplyAdminConsentsRequest::Representation
|
3599
|
+
command.request_object = apply_admin_consents_request_object
|
3600
|
+
command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
|
3601
|
+
command.response_class = Google::Apis::HealthcareV1::Operation
|
3602
|
+
command.params['name'] = name unless name.nil?
|
3603
|
+
command.query['fields'] = fields unless fields.nil?
|
3604
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3605
|
+
execute_or_queue_command(command, &block)
|
3606
|
+
end
|
3607
|
+
|
3608
|
+
# Apply the Consent resources for the FHIR store and reindex the underlying
|
3609
|
+
# resources in the FHIR store according to the aggregate consent. The aggregate
|
3610
|
+
# consent of the patient in scope in this request replaces any previous call of
|
3611
|
+
# this method. Any Consent resource change after this operation execution (
|
3612
|
+
# including deletion) requires you to call ApplyConsents again to have effect.
|
3613
|
+
# This method returns an Operation that can be used to track the progress of the
|
3614
|
+
# consent resources that were processed by calling GetOperation. Upon completion,
|
3615
|
+
# the ApplyConsentsResponse additionally contains the number of resources that
|
3616
|
+
# was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in
|
3617
|
+
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To
|
3618
|
+
# enforce consent check for data access, `consent_config.access_enforced` must
|
3619
|
+
# be set to true for the FhirStore.
|
3620
|
+
# @param [String] name
|
3621
|
+
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
3622
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
3623
|
+
# fhir_store_id``.
|
3624
|
+
# @param [Google::Apis::HealthcareV1::ApplyConsentsRequest] apply_consents_request_object
|
3625
|
+
# @param [String] fields
|
3626
|
+
# Selector specifying which fields to include in a partial response.
|
3627
|
+
# @param [String] quota_user
|
3628
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3629
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3630
|
+
# @param [Google::Apis::RequestOptions] options
|
3631
|
+
# Request-specific options
|
3632
|
+
#
|
3633
|
+
# @yield [result, err] Result & error if block supplied
|
3634
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
|
3635
|
+
# @yieldparam err [StandardError] error object if request failed
|
3636
|
+
#
|
3637
|
+
# @return [Google::Apis::HealthcareV1::Operation]
|
3638
|
+
#
|
3639
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3640
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3641
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3642
|
+
def apply_fhir_store_consents(name, apply_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3643
|
+
command = make_simple_command(:post, 'v1/{+name}:applyConsents', options)
|
3644
|
+
command.request_representation = Google::Apis::HealthcareV1::ApplyConsentsRequest::Representation
|
3645
|
+
command.request_object = apply_consents_request_object
|
3646
|
+
command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
|
3647
|
+
command.response_class = Google::Apis::HealthcareV1::Operation
|
3648
|
+
command.params['name'] = name unless name.nil?
|
3649
|
+
command.query['fields'] = fields unless fields.nil?
|
3650
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3651
|
+
execute_or_queue_command(command, &block)
|
3652
|
+
end
|
3653
|
+
|
3654
|
+
# Bulk exports a Group resource and resources in the member field, including
|
3655
|
+
# related resources for each Patient member. The export for each Patient is
|
3656
|
+
# identical to a GetPatientEverything request. Implements the FHIR
|
3657
|
+
# implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/
|
3658
|
+
# bulk-data/export.html#endpoint---group-of-patients). The following headers
|
3659
|
+
# must be set in the request: * `Accept`: specifies the format of the `
|
3660
|
+
# OperationOutcome` response. Only `application/fhir+json` is supported. * `
|
3661
|
+
# Prefer`: specifies whether the response is immediate or asynchronous. Must be
|
3662
|
+
# to `respond-async` because only asynchronous responses are supported. Specify
|
3663
|
+
# the destination for the server to write result files by setting the Cloud
|
3664
|
+
# Storage location bulk_export_gcs_destination on the FHIR store. URI of an
|
3665
|
+
# existing Cloud Storage directory where the server writes result files, in the
|
3666
|
+
# format gs://`bucket-id`/`path/to/destination/dir`. If there is no trailing
|
3667
|
+
# slash, the service appends one when composing the object path. The user is
|
3668
|
+
# responsible for creating the Cloud Storage bucket referenced. Supports the
|
3669
|
+
# following query parameters: * `_type`: string of comma-delimited FHIR resource
|
3670
|
+
# types. If provided, only resources of the specified type(s) are exported. * `
|
3671
|
+
# _since`: if provided, only resources updated after the specified time are
|
3672
|
+
# exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON
|
3673
|
+
# format. Exported file names use the format: `export_id`_`resource_type`.ndjson.
|
3674
|
+
# * `organizeOutputBy`: resource type to organize the output by. Required and
|
3675
|
+
# must be set to `Patient`. When specified, output files are organized by
|
3676
|
+
# instances of the specified resource type, including the resource, referenced
|
3677
|
+
# resources, and resources that contain references to that resource. On success,
|
3678
|
+
# the `Content-Location` header of response is set to a URL that you can use to
|
3679
|
+
# query the status of the export. The URL is in the format `projects/`project_id`
|
3680
|
+
# /locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id`/
|
3681
|
+
# operations/`export_id``. See get-fhir-operation-status for more information.
|
3682
|
+
# Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome`
|
3683
|
+
# resource describing the reason for the error.
|
3684
|
+
# @param [String] name
|
3685
|
+
# Required. Name of the Group resource that is exported, in format `projects/`
|
3686
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
3687
|
+
# fhir_store_id`/fhir/Group/`group_id``.
|
3688
|
+
# @param [String] _since
|
3689
|
+
# Optional. If provided, only resources updated after this time are exported.
|
3690
|
+
# The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-
|
3691
|
+
# 07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified
|
3692
|
+
# to the second and include a time zone.
|
3693
|
+
# @param [String] _type
|
3694
|
+
# Optional. String of comma-delimited FHIR resource types. If provided, only
|
3695
|
+
# resources of the specified resource type(s) are exported.
|
3696
|
+
# @param [String] organize_output_by
|
3697
|
+
# Optional. Required. The FHIR resource type used to organize exported resources.
|
3698
|
+
# Only supports "Patient". When organized by Patient resource, output files are
|
3699
|
+
# grouped as follows: * Patient file(s) containing the Patient resources. Each
|
3700
|
+
# Patient is sequentially followed by all resources the Patient references, and
|
3701
|
+
# all resources that reference the Patient (equivalent to a GetPatientEverything
|
3702
|
+
# request). * Individual files grouped by resource type for resources in the
|
3703
|
+
# Group's member field and the Group resource itself. Resources may be
|
3704
|
+
# duplicated across multiple Patients. For example, if two Patient resources
|
3705
|
+
# reference the same Organization resource, it will appear twice, once after
|
3706
|
+
# each Patient. The Group resource from the request does not appear in the
|
3707
|
+
# Patient files.
|
3708
|
+
# @param [String] output_format
|
3709
|
+
# Optional. Output format of the export. This field is optional and only `
|
3710
|
+
# application/fhir+ndjson` is supported.
|
3711
|
+
# @param [String] fields
|
3712
|
+
# Selector specifying which fields to include in a partial response.
|
3713
|
+
# @param [String] quota_user
|
3714
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3715
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3716
|
+
# @param [Google::Apis::RequestOptions] options
|
3717
|
+
# Request-specific options
|
3718
|
+
#
|
3719
|
+
# @yield [result, err] Result & error if block supplied
|
3720
|
+
# @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
|
3721
|
+
# @yieldparam err [StandardError] error object if request failed
|
3722
|
+
#
|
3723
|
+
# @return [Google::Apis::HealthcareV1::HttpBody]
|
3724
|
+
#
|
3725
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3726
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3727
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3728
|
+
def bulk_project_location_dataset_fhir_store_export_group(name, _since: nil, _type: nil, organize_output_by: nil, output_format: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3729
|
+
command = make_simple_command(:get, 'v1/{+name}/$export', options)
|
3730
|
+
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
3731
|
+
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
3732
|
+
command.params['name'] = name unless name.nil?
|
3733
|
+
command.query['_since'] = _since unless _since.nil?
|
3734
|
+
command.query['_type'] = _type unless _type.nil?
|
3735
|
+
command.query['organizeOutputBy'] = organize_output_by unless organize_output_by.nil?
|
3736
|
+
command.query['outputFormat'] = output_format unless output_format.nil?
|
3546
3737
|
command.query['fields'] = fields unless fields.nil?
|
3547
3738
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3548
3739
|
execute_or_queue_command(command, &block)
|
@@ -3654,6 +3845,43 @@ module Google
|
|
3654
3845
|
execute_or_queue_command(command, &block)
|
3655
3846
|
end
|
3656
3847
|
|
3848
|
+
# Explains all the permitted/denied actor, purpose and environment for a given
|
3849
|
+
# resource.
|
3850
|
+
# @param [String] name
|
3851
|
+
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
3852
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
3853
|
+
# fhir_store_id``.
|
3854
|
+
# @param [String] resource_id
|
3855
|
+
# Required. The ID (``resourceType`/`id``) of the resource to explain data
|
3856
|
+
# access on.
|
3857
|
+
# @param [String] fields
|
3858
|
+
# Selector specifying which fields to include in a partial response.
|
3859
|
+
# @param [String] quota_user
|
3860
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3861
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3862
|
+
# @param [Google::Apis::RequestOptions] options
|
3863
|
+
# Request-specific options
|
3864
|
+
#
|
3865
|
+
# @yield [result, err] Result & error if block supplied
|
3866
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ExplainDataAccessResponse] parsed result object
|
3867
|
+
# @yieldparam err [StandardError] error object if request failed
|
3868
|
+
#
|
3869
|
+
# @return [Google::Apis::HealthcareV1::ExplainDataAccessResponse]
|
3870
|
+
#
|
3871
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3872
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3873
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3874
|
+
def explain_project_location_dataset_fhir_store_data_access(name, resource_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3875
|
+
command = make_simple_command(:get, 'v1/{+name}:explainDataAccess', options)
|
3876
|
+
command.response_representation = Google::Apis::HealthcareV1::ExplainDataAccessResponse::Representation
|
3877
|
+
command.response_class = Google::Apis::HealthcareV1::ExplainDataAccessResponse
|
3878
|
+
command.params['name'] = name unless name.nil?
|
3879
|
+
command.query['resourceId'] = resource_id unless resource_id.nil?
|
3880
|
+
command.query['fields'] = fields unless fields.nil?
|
3881
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3882
|
+
execute_or_queue_command(command, &block)
|
3883
|
+
end
|
3884
|
+
|
3657
3885
|
# Export resources from the FHIR store to the specified destination. This method
|
3658
3886
|
# returns an Operation that can be used to track the status of the export by
|
3659
3887
|
# calling GetOperation. Immediate fatal errors appear in the error field, errors
|
@@ -4308,6 +4536,89 @@ module Google
|
|
4308
4536
|
execute_or_queue_command(command, &block)
|
4309
4537
|
end
|
4310
4538
|
|
4539
|
+
# Returns the consent enforcement status of a single consent resource. On
|
4540
|
+
# success, the response body contains a JSON-encoded representation of a `
|
4541
|
+
# Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, containing
|
4542
|
+
# the current enforcement status. Does not support DSTU2.
|
4543
|
+
# @param [String] name
|
4544
|
+
# Required. The name of the consent resource to find enforcement status, in the
|
4545
|
+
# format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
4546
|
+
# fhirStores/`fhir_store_id`/fhir/Consent/`consent_id``
|
4547
|
+
# @param [String] fields
|
4548
|
+
# Selector specifying which fields to include in a partial response.
|
4549
|
+
# @param [String] quota_user
|
4550
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4551
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4552
|
+
# @param [Google::Apis::RequestOptions] options
|
4553
|
+
# Request-specific options
|
4554
|
+
#
|
4555
|
+
# @yield [result, err] Result & error if block supplied
|
4556
|
+
# @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
|
4557
|
+
# @yieldparam err [StandardError] error object if request failed
|
4558
|
+
#
|
4559
|
+
# @return [Google::Apis::HealthcareV1::HttpBody]
|
4560
|
+
#
|
4561
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4562
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4563
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4564
|
+
def consent_project_location_dataset_fhir_store_fhir_enforcement_status(name, fields: nil, quota_user: nil, options: nil, &block)
|
4565
|
+
command = make_simple_command(:get, 'v1/{+name}/$consent-enforcement-status', options)
|
4566
|
+
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
4567
|
+
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
4568
|
+
command.params['name'] = name unless name.nil?
|
4569
|
+
command.query['fields'] = fields unless fields.nil?
|
4570
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4571
|
+
execute_or_queue_command(command, &block)
|
4572
|
+
end
|
4573
|
+
|
4574
|
+
# Returns the consent enforcement status of all consent resources for a patient.
|
4575
|
+
# On success, the response body contains a JSON-encoded representation of a
|
4576
|
+
# bundle of `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resources,
|
4577
|
+
# containing the current enforcement status for each consent resource of the
|
4578
|
+
# patient. Does not support DSTU2.
|
4579
|
+
# @param [String] name
|
4580
|
+
# Required. The name of the patient to find enforcement statuses, in the format `
|
4581
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
|
4582
|
+
# `fhir_store_id`/fhir/Patient/`patient_id``
|
4583
|
+
# @param [Fixnum] _count
|
4584
|
+
# Optional. The maximum number of results on a page. If not specified, 100 is
|
4585
|
+
# used. May not be larger than 1000.
|
4586
|
+
# @param [String] _page_token
|
4587
|
+
# Optional. Used to retrieve the first, previous, next, or last page of consent
|
4588
|
+
# enforcement statuses when using pagination. Value should be set to the value
|
4589
|
+
# of `_page_token` set in next or previous page links' URLs. Next and previous
|
4590
|
+
# page are returned in the response bundle's links field, where `link.relation`
|
4591
|
+
# is "previous" or "next". Omit `_page_token` if no previous request has been
|
4592
|
+
# made.
|
4593
|
+
# @param [String] fields
|
4594
|
+
# Selector specifying which fields to include in a partial response.
|
4595
|
+
# @param [String] quota_user
|
4596
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4597
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4598
|
+
# @param [Google::Apis::RequestOptions] options
|
4599
|
+
# Request-specific options
|
4600
|
+
#
|
4601
|
+
# @yield [result, err] Result & error if block supplied
|
4602
|
+
# @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
|
4603
|
+
# @yieldparam err [StandardError] error object if request failed
|
4604
|
+
#
|
4605
|
+
# @return [Google::Apis::HealthcareV1::HttpBody]
|
4606
|
+
#
|
4607
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4608
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4609
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4610
|
+
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)
|
4611
|
+
command = make_simple_command(:get, 'v1/{+name}/$consent-enforcement-status', options)
|
4612
|
+
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
4613
|
+
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
4614
|
+
command.params['name'] = name unless name.nil?
|
4615
|
+
command.query['_count'] = _count unless _count.nil?
|
4616
|
+
command.query['_page_token'] = _page_token unless _page_token.nil?
|
4617
|
+
command.query['fields'] = fields unless fields.nil?
|
4618
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4619
|
+
execute_or_queue_command(command, &block)
|
4620
|
+
end
|
4621
|
+
|
4311
4622
|
# Retrieves a Patient resource and resources related to that patient. Implements
|
4312
4623
|
# the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/
|
4313
4624
|
# implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](
|
@@ -4455,7 +4766,7 @@ module Google
|
|
4455
4766
|
# provided content.
|
4456
4767
|
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
|
4457
4768
|
# @param [String] profile
|
4458
|
-
#
|
4769
|
+
# Optional. The canonical URL of a profile that this resource should be
|
4459
4770
|
# validated against. For example, to validate a Patient resource against the US
|
4460
4771
|
# Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/
|
4461
4772
|
# StructureDefinition/us-core-patient`. A StructureDefinition with this
|
@@ -4491,6 +4802,76 @@ module Google
|
|
4491
4802
|
execute_or_queue_command(command, &block)
|
4492
4803
|
end
|
4493
4804
|
|
4805
|
+
# Bulk exports all resources from the FHIR store to the specified destination.
|
4806
|
+
# Implements the FHIR implementation guide [system level $export](https://build.
|
4807
|
+
# fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The
|
4808
|
+
# following headers must be set in the request: * `Accept`: specifies the format
|
4809
|
+
# of the `OperationOutcome` response. Only `application/fhir+json` is supported.
|
4810
|
+
# * `Prefer`: specifies whether the response is immediate or asynchronous. Must
|
4811
|
+
# be to `respond-async` because only asynchronous responses are supported.
|
4812
|
+
# Specify the destination for the server to write result files by setting the
|
4813
|
+
# Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of
|
4814
|
+
# an existing Cloud Storage directory where the server writes result files, in
|
4815
|
+
# the format gs://`bucket-id`/`path/to/destination/dir`. If there is no trailing
|
4816
|
+
# slash, the service appends one when composing the object path. The user is
|
4817
|
+
# responsible for creating the Cloud Storage bucket referenced. Supports the
|
4818
|
+
# following query parameters: * `_type`: string of comma-delimited FHIR resource
|
4819
|
+
# types. If provided, only the resources of the specified type(s) are exported. *
|
4820
|
+
# `_since`: if provided, only the resources that are updated after the
|
4821
|
+
# specified time are exported. * `_outputFormat`: optional, specify ndjson to
|
4822
|
+
# export data in NDJSON format. Exported file names use the format: `export_id`_`
|
4823
|
+
# resource_type`.ndjson. On success, the `Content-Location` header of the
|
4824
|
+
# response is set to a URL that the user can use to query the status of the
|
4825
|
+
# export. The URL is in the format: `projects/`project_id`/locations/`
|
4826
|
+
# location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id`/operations/`
|
4827
|
+
# export_id``. See get-fhir-operation-status for more information. Errors
|
4828
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
4829
|
+
# describing the reason for the error.
|
4830
|
+
# @param [String] name
|
4831
|
+
# Required. The name of the FHIR store to export resources from, in the format `
|
4832
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
|
4833
|
+
# `fhir_store_id``.
|
4834
|
+
# @param [String] _since
|
4835
|
+
# Optional. If provided, only resources updated after this time are exported.
|
4836
|
+
# The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-
|
4837
|
+
# 07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified
|
4838
|
+
# to the second and include a time zone.
|
4839
|
+
# @param [String] _type
|
4840
|
+
# Optional. String of comma-delimited FHIR resource types. If provided, only
|
4841
|
+
# resources of the specified resource type(s) are exported.
|
4842
|
+
# @param [String] output_format
|
4843
|
+
# Optional. Output format of the export. This field is optional and only `
|
4844
|
+
# application/fhir+ndjson` is supported.
|
4845
|
+
# @param [String] fields
|
4846
|
+
# Selector specifying which fields to include in a partial response.
|
4847
|
+
# @param [String] quota_user
|
4848
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4849
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4850
|
+
# @param [Google::Apis::RequestOptions] options
|
4851
|
+
# Request-specific options
|
4852
|
+
#
|
4853
|
+
# @yield [result, err] Result & error if block supplied
|
4854
|
+
# @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
|
4855
|
+
# @yieldparam err [StandardError] error object if request failed
|
4856
|
+
#
|
4857
|
+
# @return [Google::Apis::HealthcareV1::HttpBody]
|
4858
|
+
#
|
4859
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4860
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4861
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4862
|
+
def bulk_project_location_dataset_fhir_store_fhir_export(name, _since: nil, _type: nil, output_format: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4863
|
+
command = make_simple_command(:get, 'v1/{+name}/fhir/$export', options)
|
4864
|
+
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
4865
|
+
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
4866
|
+
command.params['name'] = name unless name.nil?
|
4867
|
+
command.query['_since'] = _since unless _since.nil?
|
4868
|
+
command.query['_type'] = _type unless _type.nil?
|
4869
|
+
command.query['outputFormat'] = output_format unless output_format.nil?
|
4870
|
+
command.query['fields'] = fields unless fields.nil?
|
4871
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4872
|
+
execute_or_queue_command(command, &block)
|
4873
|
+
end
|
4874
|
+
|
4494
4875
|
# Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/
|
4495
4876
|
# fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/
|
4496
4877
|
# fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.
|
@@ -5189,7 +5570,7 @@ module Google
|
|
5189
5570
|
# @param [String] parent
|
5190
5571
|
# Required. Name of the FHIR store to retrieve resources from.
|
5191
5572
|
# @param [String] resource_type
|
5192
|
-
#
|
5573
|
+
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
5193
5574
|
# For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/
|
5194
5575
|
# implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/
|
5195
5576
|
# implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/
|
@@ -5319,6 +5700,83 @@ module Google
|
|
5319
5700
|
execute_or_queue_command(command, &block)
|
5320
5701
|
end
|
5321
5702
|
|
5703
|
+
# Deletes operations as defined in the FHIR specification. Implements the FHIR
|
5704
|
+
# implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/
|
5705
|
+
# bulk-data/export.html#bulk-data-delete-request). Returns success if the
|
5706
|
+
# operation was successfully cancelled. If the operation is complete, or has
|
5707
|
+
# already been cancelled, returns an error response.
|
5708
|
+
# @param [String] name
|
5709
|
+
# Required. Name of the operation to be deleted, in the format `projects/`
|
5710
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
5711
|
+
# fhir_store_id`/operations/`operation_id``.
|
5712
|
+
# @param [String] fields
|
5713
|
+
# Selector specifying which fields to include in a partial response.
|
5714
|
+
# @param [String] quota_user
|
5715
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5716
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5717
|
+
# @param [Google::Apis::RequestOptions] options
|
5718
|
+
# Request-specific options
|
5719
|
+
#
|
5720
|
+
# @yield [result, err] Result & error if block supplied
|
5721
|
+
# @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
|
5722
|
+
# @yieldparam err [StandardError] error object if request failed
|
5723
|
+
#
|
5724
|
+
# @return [Google::Apis::HealthcareV1::HttpBody]
|
5725
|
+
#
|
5726
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5727
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5728
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5729
|
+
def delete_project_location_dataset_fhir_store_operation_fhir_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
5730
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
5731
|
+
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
5732
|
+
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
5733
|
+
command.params['name'] = name unless name.nil?
|
5734
|
+
command.query['fields'] = fields unless fields.nil?
|
5735
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5736
|
+
execute_or_queue_command(command, &block)
|
5737
|
+
end
|
5738
|
+
|
5739
|
+
# Gets the status of operations as defined in the FHIR specification. Implements
|
5740
|
+
# the FHIR implementation guide [bulk data status request](https://build.fhir.
|
5741
|
+
# org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can
|
5742
|
+
# have one of these states: * in-progress: response status code is `202` and `X-
|
5743
|
+
# Progress` header is set to `in progress`. * complete: response status code is `
|
5744
|
+
# 200` and the body is a JSON-encoded operation response as defined by the spec.
|
5745
|
+
# For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/
|
5746
|
+
# bulk-data/export.html#response---complete-status. * error: response status
|
5747
|
+
# code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource
|
5748
|
+
# describing the reason for the error.
|
5749
|
+
# @param [String] name
|
5750
|
+
# Required. Name of the operation to query, in the format `projects/`project_id`/
|
5751
|
+
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id`/
|
5752
|
+
# operations/`operation_id``.
|
5753
|
+
# @param [String] fields
|
5754
|
+
# Selector specifying which fields to include in a partial response.
|
5755
|
+
# @param [String] quota_user
|
5756
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5757
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5758
|
+
# @param [Google::Apis::RequestOptions] options
|
5759
|
+
# Request-specific options
|
5760
|
+
#
|
5761
|
+
# @yield [result, err] Result & error if block supplied
|
5762
|
+
# @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
|
5763
|
+
# @yieldparam err [StandardError] error object if request failed
|
5764
|
+
#
|
5765
|
+
# @return [Google::Apis::HealthcareV1::HttpBody]
|
5766
|
+
#
|
5767
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5768
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5769
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5770
|
+
def get_project_location_dataset_fhir_store_operation_fhir_operation_status(name, fields: nil, quota_user: nil, options: nil, &block)
|
5771
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
5772
|
+
command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
|
5773
|
+
command.response_class = Google::Apis::HealthcareV1::HttpBody
|
5774
|
+
command.params['name'] = name unless name.nil?
|
5775
|
+
command.query['fields'] = fields unless fields.nil?
|
5776
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5777
|
+
execute_or_queue_command(command, &block)
|
5778
|
+
end
|
5779
|
+
|
5322
5780
|
# Creates a new HL7v2 store within the parent dataset.
|
5323
5781
|
# @param [String] parent
|
5324
5782
|
# Required. The name of the dataset this HL7v2 store belongs to.
|
metadata
CHANGED
@@ -1,14 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-healthcare_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.71.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
|
-
autorequire:
|
9
8
|
bindir: bin
|
10
9
|
cert_chain: []
|
11
|
-
date:
|
10
|
+
date: 2025-03-02 00:00:00.000000000 Z
|
12
11
|
dependencies:
|
13
12
|
- !ruby/object:Gem::Dependency
|
14
13
|
name: google-apis-core
|
@@ -58,9 +57,8 @@ licenses:
|
|
58
57
|
metadata:
|
59
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
59
|
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.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1/v0.71.0
|
62
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1
|
63
|
-
post_install_message:
|
64
62
|
rdoc_options: []
|
65
63
|
require_paths:
|
66
64
|
- lib
|
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
73
|
- !ruby/object:Gem::Version
|
76
74
|
version: '0'
|
77
75
|
requirements: []
|
78
|
-
rubygems_version: 3.5
|
79
|
-
signing_key:
|
76
|
+
rubygems_version: 3.6.5
|
80
77
|
specification_version: 4
|
81
78
|
summary: Simple REST client for Cloud Healthcare API V1
|
82
79
|
test_files: []
|