google-apis-healthcare_v1beta1 0.81.0 → 0.82.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/google/apis/healthcare_v1beta1/classes.rb +3 -694
- data/lib/google/apis/healthcare_v1beta1/gem_version.rb +3 -3
- data/lib/google/apis/healthcare_v1beta1/representations.rb +0 -367
- data/lib/google/apis/healthcare_v1beta1/service.rb +423 -897
- metadata +3 -3
|
@@ -178,7 +178,8 @@ module Google
|
|
|
178
178
|
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
|
|
179
179
|
# @param [String] source_dataset
|
|
180
180
|
# Required. Source dataset resource name. For example, `projects/`project_id`/
|
|
181
|
-
# locations/`location_id`/datasets/`dataset_id``.
|
|
181
|
+
# locations/`location_id`/datasets/`dataset_id``. R5 FHIR stores are not
|
|
182
|
+
# supported and will be skipped.
|
|
182
183
|
# @param [Google::Apis::HealthcareV1beta1::DeidentifyDatasetRequest] deidentify_dataset_request_object
|
|
183
184
|
# @param [String] fields
|
|
184
185
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -471,183 +472,6 @@ module Google
|
|
|
471
472
|
execute_or_queue_command(command, &block)
|
|
472
473
|
end
|
|
473
474
|
|
|
474
|
-
# Creates a new Annotation store within the parent dataset.
|
|
475
|
-
# @param [String] parent
|
|
476
|
-
# Required. The name of the dataset this Annotation store belongs to.
|
|
477
|
-
# @param [Google::Apis::HealthcareV1beta1::AnnotationStore] annotation_store_object
|
|
478
|
-
# @param [String] annotation_store_id
|
|
479
|
-
# Required. The ID of the Annotation store that is being created. The string
|
|
480
|
-
# must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
|
|
481
|
-
# @param [String] fields
|
|
482
|
-
# Selector specifying which fields to include in a partial response.
|
|
483
|
-
# @param [String] quota_user
|
|
484
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
485
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
486
|
-
# @param [Google::Apis::RequestOptions] options
|
|
487
|
-
# Request-specific options
|
|
488
|
-
#
|
|
489
|
-
# @yield [result, err] Result & error if block supplied
|
|
490
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::AnnotationStore] parsed result object
|
|
491
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
492
|
-
#
|
|
493
|
-
# @return [Google::Apis::HealthcareV1beta1::AnnotationStore]
|
|
494
|
-
#
|
|
495
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
496
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
497
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
498
|
-
def create_project_location_dataset_annotation_store(parent, annotation_store_object = nil, annotation_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
499
|
-
command = make_simple_command(:post, 'v1beta1/{+parent}/annotationStores', options)
|
|
500
|
-
command.request_representation = Google::Apis::HealthcareV1beta1::AnnotationStore::Representation
|
|
501
|
-
command.request_object = annotation_store_object
|
|
502
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::AnnotationStore::Representation
|
|
503
|
-
command.response_class = Google::Apis::HealthcareV1beta1::AnnotationStore
|
|
504
|
-
command.params['parent'] = parent unless parent.nil?
|
|
505
|
-
command.query['annotationStoreId'] = annotation_store_id unless annotation_store_id.nil?
|
|
506
|
-
command.query['fields'] = fields unless fields.nil?
|
|
507
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
508
|
-
execute_or_queue_command(command, &block)
|
|
509
|
-
end
|
|
510
|
-
|
|
511
|
-
# Deletes the specified Annotation store and removes all annotations that are
|
|
512
|
-
# contained within it.
|
|
513
|
-
# @param [String] name
|
|
514
|
-
# Required. The resource name of the Annotation store to delete.
|
|
515
|
-
# @param [String] fields
|
|
516
|
-
# Selector specifying which fields to include in a partial response.
|
|
517
|
-
# @param [String] quota_user
|
|
518
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
519
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
520
|
-
# @param [Google::Apis::RequestOptions] options
|
|
521
|
-
# Request-specific options
|
|
522
|
-
#
|
|
523
|
-
# @yield [result, err] Result & error if block supplied
|
|
524
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::Empty] parsed result object
|
|
525
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
526
|
-
#
|
|
527
|
-
# @return [Google::Apis::HealthcareV1beta1::Empty]
|
|
528
|
-
#
|
|
529
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
530
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
531
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
532
|
-
def delete_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
533
|
-
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
|
534
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
|
|
535
|
-
command.response_class = Google::Apis::HealthcareV1beta1::Empty
|
|
536
|
-
command.params['name'] = name unless name.nil?
|
|
537
|
-
command.query['fields'] = fields unless fields.nil?
|
|
538
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
539
|
-
execute_or_queue_command(command, &block)
|
|
540
|
-
end
|
|
541
|
-
|
|
542
|
-
# Evaluate an Annotation store against a ground truth Annotation store. When the
|
|
543
|
-
# operation finishes successfully, a detailed response is returned of type
|
|
544
|
-
# EvaluateAnnotationStoreResponse, contained in the response. The metadata field
|
|
545
|
-
# type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing
|
|
546
|
-
# error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
|
|
547
|
-
# logging)).
|
|
548
|
-
# @param [String] name
|
|
549
|
-
# Required. The Annotation store to compare against `golden_store`, in the
|
|
550
|
-
# format of `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
551
|
-
# annotationStores/`annotation_store_id``.
|
|
552
|
-
# @param [Google::Apis::HealthcareV1beta1::EvaluateAnnotationStoreRequest] evaluate_annotation_store_request_object
|
|
553
|
-
# @param [String] fields
|
|
554
|
-
# Selector specifying which fields to include in a partial response.
|
|
555
|
-
# @param [String] quota_user
|
|
556
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
557
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
558
|
-
# @param [Google::Apis::RequestOptions] options
|
|
559
|
-
# Request-specific options
|
|
560
|
-
#
|
|
561
|
-
# @yield [result, err] Result & error if block supplied
|
|
562
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::Operation] parsed result object
|
|
563
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
564
|
-
#
|
|
565
|
-
# @return [Google::Apis::HealthcareV1beta1::Operation]
|
|
566
|
-
#
|
|
567
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
568
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
569
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
570
|
-
def evaluate_annotation_store(name, evaluate_annotation_store_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
571
|
-
command = make_simple_command(:post, 'v1beta1/{+name}:evaluate', options)
|
|
572
|
-
command.request_representation = Google::Apis::HealthcareV1beta1::EvaluateAnnotationStoreRequest::Representation
|
|
573
|
-
command.request_object = evaluate_annotation_store_request_object
|
|
574
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
|
|
575
|
-
command.response_class = Google::Apis::HealthcareV1beta1::Operation
|
|
576
|
-
command.params['name'] = name unless name.nil?
|
|
577
|
-
command.query['fields'] = fields unless fields.nil?
|
|
578
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
579
|
-
execute_or_queue_command(command, &block)
|
|
580
|
-
end
|
|
581
|
-
|
|
582
|
-
# Export Annotations from the Annotation store. If the request is successful, a
|
|
583
|
-
# detailed response is returned of type ExportAnnotationsResponse, contained in
|
|
584
|
-
# the response field when the operation finishes. The metadata field type is
|
|
585
|
-
# OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs
|
|
586
|
-
# in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
|
|
587
|
-
# @param [String] name
|
|
588
|
-
# Required. The name of the Annotation store to export annotations to, in the
|
|
589
|
-
# format of `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
590
|
-
# annotationStores/`annotation_store_id``.
|
|
591
|
-
# @param [Google::Apis::HealthcareV1beta1::ExportAnnotationsRequest] export_annotations_request_object
|
|
592
|
-
# @param [String] fields
|
|
593
|
-
# Selector specifying which fields to include in a partial response.
|
|
594
|
-
# @param [String] quota_user
|
|
595
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
596
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
597
|
-
# @param [Google::Apis::RequestOptions] options
|
|
598
|
-
# Request-specific options
|
|
599
|
-
#
|
|
600
|
-
# @yield [result, err] Result & error if block supplied
|
|
601
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::Operation] parsed result object
|
|
602
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
603
|
-
#
|
|
604
|
-
# @return [Google::Apis::HealthcareV1beta1::Operation]
|
|
605
|
-
#
|
|
606
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
607
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
608
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
609
|
-
def export_annotation_store_annotations(name, export_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
610
|
-
command = make_simple_command(:post, 'v1beta1/{+name}:export', options)
|
|
611
|
-
command.request_representation = Google::Apis::HealthcareV1beta1::ExportAnnotationsRequest::Representation
|
|
612
|
-
command.request_object = export_annotations_request_object
|
|
613
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
|
|
614
|
-
command.response_class = Google::Apis::HealthcareV1beta1::Operation
|
|
615
|
-
command.params['name'] = name unless name.nil?
|
|
616
|
-
command.query['fields'] = fields unless fields.nil?
|
|
617
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
618
|
-
execute_or_queue_command(command, &block)
|
|
619
|
-
end
|
|
620
|
-
|
|
621
|
-
# Gets the specified Annotation store or returns NOT_FOUND if it does not exist.
|
|
622
|
-
# @param [String] name
|
|
623
|
-
# Required. The resource name of the Annotation store to get.
|
|
624
|
-
# @param [String] fields
|
|
625
|
-
# Selector specifying which fields to include in a partial response.
|
|
626
|
-
# @param [String] quota_user
|
|
627
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
628
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
629
|
-
# @param [Google::Apis::RequestOptions] options
|
|
630
|
-
# Request-specific options
|
|
631
|
-
#
|
|
632
|
-
# @yield [result, err] Result & error if block supplied
|
|
633
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::AnnotationStore] parsed result object
|
|
634
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
635
|
-
#
|
|
636
|
-
# @return [Google::Apis::HealthcareV1beta1::AnnotationStore]
|
|
637
|
-
#
|
|
638
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
639
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
640
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
641
|
-
def get_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
642
|
-
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
643
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::AnnotationStore::Representation
|
|
644
|
-
command.response_class = Google::Apis::HealthcareV1beta1::AnnotationStore
|
|
645
|
-
command.params['name'] = name unless name.nil?
|
|
646
|
-
command.query['fields'] = fields unless fields.nil?
|
|
647
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
648
|
-
execute_or_queue_command(command, &block)
|
|
649
|
-
end
|
|
650
|
-
|
|
651
475
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
|
652
476
|
# resource exists and does not have a policy set.
|
|
653
477
|
# @param [String] resource
|
|
@@ -693,147 +517,6 @@ module Google
|
|
|
693
517
|
execute_or_queue_command(command, &block)
|
|
694
518
|
end
|
|
695
519
|
|
|
696
|
-
# Import Annotations to the Annotation store by loading data from the specified
|
|
697
|
-
# sources. If the request is successful, a detailed response is returned as of
|
|
698
|
-
# type ImportAnnotationsResponse, contained in the response field when the
|
|
699
|
-
# operation finishes. The metadata field type is OperationMetadata. Errors are
|
|
700
|
-
# logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://
|
|
701
|
-
# cloud.google.com/healthcare/docs/how-tos/logging)).
|
|
702
|
-
# @param [String] name
|
|
703
|
-
# Required. The name of the Annotation store to which the server imports
|
|
704
|
-
# annotations, in the format `projects/`project_id`/locations/`location_id`/
|
|
705
|
-
# datasets/`dataset_id`/annotationStores/`annotation_store_id``.
|
|
706
|
-
# @param [Google::Apis::HealthcareV1beta1::ImportAnnotationsRequest] import_annotations_request_object
|
|
707
|
-
# @param [String] fields
|
|
708
|
-
# Selector specifying which fields to include in a partial response.
|
|
709
|
-
# @param [String] quota_user
|
|
710
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
711
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
712
|
-
# @param [Google::Apis::RequestOptions] options
|
|
713
|
-
# Request-specific options
|
|
714
|
-
#
|
|
715
|
-
# @yield [result, err] Result & error if block supplied
|
|
716
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::Operation] parsed result object
|
|
717
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
718
|
-
#
|
|
719
|
-
# @return [Google::Apis::HealthcareV1beta1::Operation]
|
|
720
|
-
#
|
|
721
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
722
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
723
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
724
|
-
def import_annotation_store_annotations(name, import_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
725
|
-
command = make_simple_command(:post, 'v1beta1/{+name}:import', options)
|
|
726
|
-
command.request_representation = Google::Apis::HealthcareV1beta1::ImportAnnotationsRequest::Representation
|
|
727
|
-
command.request_object = import_annotations_request_object
|
|
728
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
|
|
729
|
-
command.response_class = Google::Apis::HealthcareV1beta1::Operation
|
|
730
|
-
command.params['name'] = name unless name.nil?
|
|
731
|
-
command.query['fields'] = fields unless fields.nil?
|
|
732
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
733
|
-
execute_or_queue_command(command, &block)
|
|
734
|
-
end
|
|
735
|
-
|
|
736
|
-
# Lists the Annotation stores in the given dataset for a source store.
|
|
737
|
-
# @param [String] parent
|
|
738
|
-
# Required. Name of the dataset.
|
|
739
|
-
# @param [String] filter
|
|
740
|
-
# Restricts stores returned to those matching a filter. The following syntax is
|
|
741
|
-
# available: * A string field value can be written as text inside quotation
|
|
742
|
-
# marks, for example `"query text"`. The only valid relational operation for
|
|
743
|
-
# text fields is equality (`=`), where text is searched within the field, rather
|
|
744
|
-
# than having the field be equal to the text. For example, `"Comment = great"`
|
|
745
|
-
# returns messages with `great` in the comment field. * A number field value can
|
|
746
|
-
# be written as an integer, a decimal, or an exponential. The valid relational
|
|
747
|
-
# operators for number fields are the equality operator (`=`), along with the
|
|
748
|
-
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
|
|
749
|
-
# inequality (`!=`) operator. You can prepend the `NOT` operator to an
|
|
750
|
-
# expression to negate it. * A date field value must be written in `yyyy-mm-dd`
|
|
751
|
-
# form. Fields with date and time use the RFC3339 time format. Leading zeros are
|
|
752
|
-
# required for one-digit months and days. The valid relational operators for
|
|
753
|
-
# date fields are the equality operator (`=`) , along with the less than/greater
|
|
754
|
-
# than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
|
|
755
|
-
# operator. You can prepend the `NOT` operator to an expression to negate it. *
|
|
756
|
-
# Multiple field query expressions can be combined in one query by adding `AND`
|
|
757
|
-
# or `OR` operators between the expressions. If a boolean operator appears
|
|
758
|
-
# within a quoted string, it is not treated as special, it's just another part
|
|
759
|
-
# of the character string to be matched. You can prepend the `NOT` operator to
|
|
760
|
-
# an expression to negate it. Only filtering on labels is supported, for example
|
|
761
|
-
# `labels.key=value`.
|
|
762
|
-
# @param [Fixnum] page_size
|
|
763
|
-
# Limit on the number of Annotation stores to return in a single response. If
|
|
764
|
-
# not specified, 100 is used. May not be larger than 1000.
|
|
765
|
-
# @param [String] page_token
|
|
766
|
-
# The next_page_token value returned from the previous List request, if any.
|
|
767
|
-
# @param [String] fields
|
|
768
|
-
# Selector specifying which fields to include in a partial response.
|
|
769
|
-
# @param [String] quota_user
|
|
770
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
771
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
772
|
-
# @param [Google::Apis::RequestOptions] options
|
|
773
|
-
# Request-specific options
|
|
774
|
-
#
|
|
775
|
-
# @yield [result, err] Result & error if block supplied
|
|
776
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::ListAnnotationStoresResponse] parsed result object
|
|
777
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
778
|
-
#
|
|
779
|
-
# @return [Google::Apis::HealthcareV1beta1::ListAnnotationStoresResponse]
|
|
780
|
-
#
|
|
781
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
782
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
783
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
784
|
-
def list_project_location_dataset_annotation_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
785
|
-
command = make_simple_command(:get, 'v1beta1/{+parent}/annotationStores', options)
|
|
786
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::ListAnnotationStoresResponse::Representation
|
|
787
|
-
command.response_class = Google::Apis::HealthcareV1beta1::ListAnnotationStoresResponse
|
|
788
|
-
command.params['parent'] = parent unless parent.nil?
|
|
789
|
-
command.query['filter'] = filter unless filter.nil?
|
|
790
|
-
command.query['pageSize'] = page_size unless page_size.nil?
|
|
791
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
|
792
|
-
command.query['fields'] = fields unless fields.nil?
|
|
793
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
794
|
-
execute_or_queue_command(command, &block)
|
|
795
|
-
end
|
|
796
|
-
|
|
797
|
-
# Updates the specified Annotation store.
|
|
798
|
-
# @param [String] name
|
|
799
|
-
# Identifier. Resource name of the Annotation store, of the form `projects/`
|
|
800
|
-
# project_id`/locations/`location_id`/datasets/`dataset_id`/annotationStores/`
|
|
801
|
-
# annotation_store_id``.
|
|
802
|
-
# @param [Google::Apis::HealthcareV1beta1::AnnotationStore] annotation_store_object
|
|
803
|
-
# @param [String] update_mask
|
|
804
|
-
# Required. The update mask applies to the resource. For the `FieldMask`
|
|
805
|
-
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
|
806
|
-
# google.protobuf#fieldmask
|
|
807
|
-
# @param [String] fields
|
|
808
|
-
# Selector specifying which fields to include in a partial response.
|
|
809
|
-
# @param [String] quota_user
|
|
810
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
811
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
812
|
-
# @param [Google::Apis::RequestOptions] options
|
|
813
|
-
# Request-specific options
|
|
814
|
-
#
|
|
815
|
-
# @yield [result, err] Result & error if block supplied
|
|
816
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::AnnotationStore] parsed result object
|
|
817
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
818
|
-
#
|
|
819
|
-
# @return [Google::Apis::HealthcareV1beta1::AnnotationStore]
|
|
820
|
-
#
|
|
821
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
822
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
823
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
824
|
-
def patch_project_location_dataset_annotation_store(name, annotation_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
825
|
-
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
826
|
-
command.request_representation = Google::Apis::HealthcareV1beta1::AnnotationStore::Representation
|
|
827
|
-
command.request_object = annotation_store_object
|
|
828
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::AnnotationStore::Representation
|
|
829
|
-
command.response_class = Google::Apis::HealthcareV1beta1::AnnotationStore
|
|
830
|
-
command.params['name'] = name unless name.nil?
|
|
831
|
-
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
832
|
-
command.query['fields'] = fields unless fields.nil?
|
|
833
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
834
|
-
execute_or_queue_command(command, &block)
|
|
835
|
-
end
|
|
836
|
-
|
|
837
520
|
# Sets the access control policy on the specified resource. Replaces any
|
|
838
521
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
|
839
522
|
# PERMISSION_DENIED` errors.
|
|
@@ -910,192 +593,6 @@ module Google
|
|
|
910
593
|
execute_or_queue_command(command, &block)
|
|
911
594
|
end
|
|
912
595
|
|
|
913
|
-
# Creates a new Annotation record. It is valid to create Annotation objects for
|
|
914
|
-
# the same source more than once since a unique ID is assigned to each record by
|
|
915
|
-
# this service.
|
|
916
|
-
# @param [String] parent
|
|
917
|
-
# Required. The name of the Annotation store this annotation belongs to. For
|
|
918
|
-
# example, `projects/my-project/locations/us-central1/datasets/mydataset/
|
|
919
|
-
# annotationStores/myannotationstore`.
|
|
920
|
-
# @param [Google::Apis::HealthcareV1beta1::Annotation] annotation_object
|
|
921
|
-
# @param [String] fields
|
|
922
|
-
# Selector specifying which fields to include in a partial response.
|
|
923
|
-
# @param [String] quota_user
|
|
924
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
925
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
926
|
-
# @param [Google::Apis::RequestOptions] options
|
|
927
|
-
# Request-specific options
|
|
928
|
-
#
|
|
929
|
-
# @yield [result, err] Result & error if block supplied
|
|
930
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::Annotation] parsed result object
|
|
931
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
932
|
-
#
|
|
933
|
-
# @return [Google::Apis::HealthcareV1beta1::Annotation]
|
|
934
|
-
#
|
|
935
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
936
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
937
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
938
|
-
def create_project_location_dataset_annotation_store_annotation(parent, annotation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
939
|
-
command = make_simple_command(:post, 'v1beta1/{+parent}/annotations', options)
|
|
940
|
-
command.request_representation = Google::Apis::HealthcareV1beta1::Annotation::Representation
|
|
941
|
-
command.request_object = annotation_object
|
|
942
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::Annotation::Representation
|
|
943
|
-
command.response_class = Google::Apis::HealthcareV1beta1::Annotation
|
|
944
|
-
command.params['parent'] = parent unless parent.nil?
|
|
945
|
-
command.query['fields'] = fields unless fields.nil?
|
|
946
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
947
|
-
execute_or_queue_command(command, &block)
|
|
948
|
-
end
|
|
949
|
-
|
|
950
|
-
# Deletes an Annotation or returns NOT_FOUND if it does not exist.
|
|
951
|
-
# @param [String] name
|
|
952
|
-
# Required. The resource name of the Annotation to delete.
|
|
953
|
-
# @param [String] fields
|
|
954
|
-
# Selector specifying which fields to include in a partial response.
|
|
955
|
-
# @param [String] quota_user
|
|
956
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
957
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
958
|
-
# @param [Google::Apis::RequestOptions] options
|
|
959
|
-
# Request-specific options
|
|
960
|
-
#
|
|
961
|
-
# @yield [result, err] Result & error if block supplied
|
|
962
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::Empty] parsed result object
|
|
963
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
964
|
-
#
|
|
965
|
-
# @return [Google::Apis::HealthcareV1beta1::Empty]
|
|
966
|
-
#
|
|
967
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
968
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
969
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
970
|
-
def delete_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
971
|
-
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
|
972
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
|
|
973
|
-
command.response_class = Google::Apis::HealthcareV1beta1::Empty
|
|
974
|
-
command.params['name'] = name unless name.nil?
|
|
975
|
-
command.query['fields'] = fields unless fields.nil?
|
|
976
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
977
|
-
execute_or_queue_command(command, &block)
|
|
978
|
-
end
|
|
979
|
-
|
|
980
|
-
# Gets an Annotation.
|
|
981
|
-
# @param [String] name
|
|
982
|
-
# Required. The resource name of the Annotation to retrieve.
|
|
983
|
-
# @param [String] fields
|
|
984
|
-
# Selector specifying which fields to include in a partial response.
|
|
985
|
-
# @param [String] quota_user
|
|
986
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
987
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
988
|
-
# @param [Google::Apis::RequestOptions] options
|
|
989
|
-
# Request-specific options
|
|
990
|
-
#
|
|
991
|
-
# @yield [result, err] Result & error if block supplied
|
|
992
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::Annotation] parsed result object
|
|
993
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
994
|
-
#
|
|
995
|
-
# @return [Google::Apis::HealthcareV1beta1::Annotation]
|
|
996
|
-
#
|
|
997
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
998
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
999
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1000
|
-
def get_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1001
|
-
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
1002
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::Annotation::Representation
|
|
1003
|
-
command.response_class = Google::Apis::HealthcareV1beta1::Annotation
|
|
1004
|
-
command.params['name'] = name unless name.nil?
|
|
1005
|
-
command.query['fields'] = fields unless fields.nil?
|
|
1006
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1007
|
-
execute_or_queue_command(command, &block)
|
|
1008
|
-
end
|
|
1009
|
-
|
|
1010
|
-
# Lists the Annotations in the given Annotation store for a source resource.
|
|
1011
|
-
# @param [String] parent
|
|
1012
|
-
# Required. Name of the Annotation store to retrieve Annotations from.
|
|
1013
|
-
# @param [String] filter
|
|
1014
|
-
# Restricts Annotations returned to those matching a filter. Functions available
|
|
1015
|
-
# for filtering are: - `matches("annotation_source.cloud_healthcare_source.name",
|
|
1016
|
-
# substring)`. Filter on `cloud_healthcare_source.name`. For example: `matches("
|
|
1017
|
-
# annotation_source.cloud_healthcare_source.name", "some source")`. - `matches("
|
|
1018
|
-
# annotation", substring)`. Filter on all fields of annotation. For example: `
|
|
1019
|
-
# matches("annotation", "some-content")`. - `type("text")`, `type("image")`, `
|
|
1020
|
-
# type("resource")`. Filter on the type of annotation `data`.
|
|
1021
|
-
# @param [Fixnum] page_size
|
|
1022
|
-
# Limit on the number of Annotations to return in a single response. If not
|
|
1023
|
-
# specified, 100 is used. May not be larger than 1000.
|
|
1024
|
-
# @param [String] page_token
|
|
1025
|
-
# The next_page_token value returned from the previous List request, if any.
|
|
1026
|
-
# @param [String] view
|
|
1027
|
-
# Controls which fields are populated in the response.
|
|
1028
|
-
# @param [String] fields
|
|
1029
|
-
# Selector specifying which fields to include in a partial response.
|
|
1030
|
-
# @param [String] quota_user
|
|
1031
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
1032
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1033
|
-
# @param [Google::Apis::RequestOptions] options
|
|
1034
|
-
# Request-specific options
|
|
1035
|
-
#
|
|
1036
|
-
# @yield [result, err] Result & error if block supplied
|
|
1037
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::ListAnnotationsResponse] parsed result object
|
|
1038
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
1039
|
-
#
|
|
1040
|
-
# @return [Google::Apis::HealthcareV1beta1::ListAnnotationsResponse]
|
|
1041
|
-
#
|
|
1042
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1043
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1044
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1045
|
-
def list_project_location_dataset_annotation_store_annotations(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1046
|
-
command = make_simple_command(:get, 'v1beta1/{+parent}/annotations', options)
|
|
1047
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::ListAnnotationsResponse::Representation
|
|
1048
|
-
command.response_class = Google::Apis::HealthcareV1beta1::ListAnnotationsResponse
|
|
1049
|
-
command.params['parent'] = parent unless parent.nil?
|
|
1050
|
-
command.query['filter'] = filter unless filter.nil?
|
|
1051
|
-
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1052
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1053
|
-
command.query['view'] = view unless view.nil?
|
|
1054
|
-
command.query['fields'] = fields unless fields.nil?
|
|
1055
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1056
|
-
execute_or_queue_command(command, &block)
|
|
1057
|
-
end
|
|
1058
|
-
|
|
1059
|
-
# Updates the Annotation.
|
|
1060
|
-
# @param [String] name
|
|
1061
|
-
# Identifier. Resource name of the Annotation, of the form `projects/`project_id`
|
|
1062
|
-
# /locations/`location_id`/datasets/`dataset_id`/annotationStores/`
|
|
1063
|
-
# annotation_store_id`/annotations/`annotation_id``.
|
|
1064
|
-
# @param [Google::Apis::HealthcareV1beta1::Annotation] annotation_object
|
|
1065
|
-
# @param [String] update_mask
|
|
1066
|
-
# Required. The update mask applies to the resource. For the `FieldMask`
|
|
1067
|
-
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
|
1068
|
-
# google.protobuf#fieldmask
|
|
1069
|
-
# @param [String] fields
|
|
1070
|
-
# Selector specifying which fields to include in a partial response.
|
|
1071
|
-
# @param [String] quota_user
|
|
1072
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
1073
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1074
|
-
# @param [Google::Apis::RequestOptions] options
|
|
1075
|
-
# Request-specific options
|
|
1076
|
-
#
|
|
1077
|
-
# @yield [result, err] Result & error if block supplied
|
|
1078
|
-
# @yieldparam result [Google::Apis::HealthcareV1beta1::Annotation] parsed result object
|
|
1079
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
1080
|
-
#
|
|
1081
|
-
# @return [Google::Apis::HealthcareV1beta1::Annotation]
|
|
1082
|
-
#
|
|
1083
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1084
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1085
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1086
|
-
def patch_project_location_dataset_annotation_store_annotation(name, annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1087
|
-
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
1088
|
-
command.request_representation = Google::Apis::HealthcareV1beta1::Annotation::Representation
|
|
1089
|
-
command.request_object = annotation_object
|
|
1090
|
-
command.response_representation = Google::Apis::HealthcareV1beta1::Annotation::Representation
|
|
1091
|
-
command.response_class = Google::Apis::HealthcareV1beta1::Annotation
|
|
1092
|
-
command.params['name'] = name unless name.nil?
|
|
1093
|
-
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1094
|
-
command.query['fields'] = fields unless fields.nil?
|
|
1095
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1096
|
-
execute_or_queue_command(command, &block)
|
|
1097
|
-
end
|
|
1098
|
-
|
|
1099
596
|
# Checks if a particular data_id of a User data mapping in the specified consent
|
|
1100
597
|
# store is consented for the specified use.
|
|
1101
598
|
# @param [String] consent_store
|
|
@@ -4282,7 +3779,7 @@ module Google
|
|
|
4282
3779
|
# instead of an Operation. No resources will be reindexed and the `
|
|
4283
3780
|
# consent_config.enforced_admin_consents` field will be unchanged. To enforce a
|
|
4284
3781
|
# consent check for data access, `consent_config.access_enforced` must be set to
|
|
4285
|
-
# true for the FhirStore.
|
|
3782
|
+
# true for the FhirStore. FHIR Consent is not supported in DSTU2 or R5.
|
|
4286
3783
|
# @param [String] name
|
|
4287
3784
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
|
4288
3785
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
|
@@ -4328,7 +3825,7 @@ module Google
|
|
|
4328
3825
|
# was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in
|
|
4329
3826
|
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To
|
|
4330
3827
|
# enforce consent check for data access, `consent_config.access_enforced` must
|
|
4331
|
-
# be set to true for the FhirStore.
|
|
3828
|
+
# be set to true for the FhirStore. FHIR Consent is not supported in DSTU2 or R5.
|
|
4332
3829
|
# @param [String] name
|
|
4333
3830
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
|
4334
3831
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
|
@@ -4537,7 +4034,8 @@ module Google
|
|
|
4537
4034
|
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
|
|
4538
4035
|
# @param [String] source_store
|
|
4539
4036
|
# Required. Source FHIR store resource name. For example, `projects/`project_id`/
|
|
4540
|
-
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
|
|
4037
|
+
# locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. R5
|
|
4038
|
+
# stores are not supported.
|
|
4541
4039
|
# @param [Google::Apis::HealthcareV1beta1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object
|
|
4542
4040
|
# @param [String] fields
|
|
4543
4041
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -4599,7 +4097,7 @@ module Google
|
|
|
4599
4097
|
end
|
|
4600
4098
|
|
|
4601
4099
|
# Explains all the permitted/denied actor, purpose and environment for a given
|
|
4602
|
-
# resource.
|
|
4100
|
+
# resource. FHIR Consent is not supported in DSTU2 or R5.
|
|
4603
4101
|
# @param [String] name
|
|
4604
4102
|
# Required. The name of the FHIR store to enforce, in the format `projects/`
|
|
4605
4103
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
|
|
@@ -5186,24 +4684,24 @@ module Google
|
|
|
5186
4684
|
# zip archives, pdf files, documents). When a non-FHIR content type is used in
|
|
5187
4685
|
# the request, a Binary resource will be generated, and the uploaded data will
|
|
5188
4686
|
# be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`
|
|
5189
|
-
# R4`). The Binary resource's `contentType` will be filled in using the
|
|
5190
|
-
# the `Content-Type` header, and the `securityContext` field (not
|
|
5191
|
-
# DSTU2`) will be populated from the `X-Security-Context` header if
|
|
5192
|
-
# At this time `securityContext` has no special behavior in the Cloud
|
|
5193
|
-
# API. Note: the limit on data ingested through this method is 1 GB.
|
|
5194
|
-
# performance, use a non-FHIR data type instead of wrapping the data in
|
|
5195
|
-
# resource. Some of the Healthcare API features, such as [exporting to
|
|
5196
|
-
# https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-
|
|
5197
|
-
# Pub/Sub notifications](https://cloud.google.com/healthcare-api/
|
|
5198
|
-
# pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high)
|
|
5199
|
-
# full resource content, do not support Binary resources that are larger
|
|
5200
|
-
# MB. In these cases the resource's `data` field will be omitted.
|
|
5201
|
-
# http://hl7.org/fhir/StructureDefinition/data-absent-reason"
|
|
5202
|
-
# present to indicate that including the data is `unsupported`.
|
|
5203
|
-
# empty `201 Created` response is returned. The newly created
|
|
5204
|
-
# version are returned in the Location header. Using `Prefer:
|
|
5205
|
-
# resource` is not allowed for this method. The definition of the
|
|
5206
|
-
# API can be found at https://hl7.org/fhir/binary.html#rest.
|
|
4687
|
+
# R4` and `R5`). The Binary resource's `contentType` will be filled in using the
|
|
4688
|
+
# value of the `Content-Type` header, and the `securityContext` field (not
|
|
4689
|
+
# present in `DSTU2`) will be populated from the `X-Security-Context` header if
|
|
4690
|
+
# it exists. At this time `securityContext` has no special behavior in the Cloud
|
|
4691
|
+
# Healthcare API. Note: the limit on data ingested through this method is 1 GB.
|
|
4692
|
+
# For best performance, use a non-FHIR data type instead of wrapping the data in
|
|
4693
|
+
# a Binary resource. Some of the Healthcare API features, such as [exporting to
|
|
4694
|
+
# BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-
|
|
4695
|
+
# bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/
|
|
4696
|
+
# docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high)
|
|
4697
|
+
# with full resource content, do not support Binary resources that are larger
|
|
4698
|
+
# than 10 MB. In these cases the resource's `data` field will be omitted.
|
|
4699
|
+
# Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
|
|
4700
|
+
# extension will be present to indicate that including the data is `unsupported`.
|
|
4701
|
+
# On success, an empty `201 Created` response is returned. The newly created
|
|
4702
|
+
# resource's ID and version are returned in the Location header. Using `Prefer:
|
|
4703
|
+
# representation=resource` is not allowed for this method. The definition of the
|
|
4704
|
+
# Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
|
|
5207
4705
|
# @param [String] parent
|
|
5208
4706
|
# Required. The name of the FHIR store this resource belongs to.
|
|
5209
4707
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
@@ -5287,16 +4785,16 @@ module Google
|
|
|
5287
4785
|
# the same way as non-FHIR data. When a non-FHIR content type is used in the
|
|
5288
4786
|
# request, a Binary resource will be generated using the ID from the resource
|
|
5289
4787
|
# path, and the uploaded data will be stored in the `content` field (`DSTU2` and
|
|
5290
|
-
# `STU3`), or the `data` field (`R4`). The Binary resource's `
|
|
5291
|
-
# be filled in using the value of the `Content-Type` header,
|
|
5292
|
-
# securityContext` field (not present in `DSTU2`) will be populated
|
|
5293
|
-
# Security-Context` header if it exists. At this time `
|
|
5294
|
-
# special behavior in the Cloud Healthcare API. Note:
|
|
5295
|
-
# through this method is 2 GB. For best performance,
|
|
5296
|
-
# instead of wrapping the data in a Binary resource.
|
|
5297
|
-
# features, such as [exporting to BigQuery](https://
|
|
5298
|
-
# api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub
|
|
5299
|
-
# cloud.google.com/healthcare-api/docs/fhir-pubsub#
|
|
4788
|
+
# `STU3`), or the `data` field (`R4` and `R5`). The Binary resource's `
|
|
4789
|
+
# contentType` will be filled in using the value of the `Content-Type` header,
|
|
4790
|
+
# and the `securityContext` field (not present in `DSTU2`) will be populated
|
|
4791
|
+
# from the `X-Security-Context` header if it exists. At this time `
|
|
4792
|
+
# securityContext` has no special behavior in the Cloud Healthcare API. Note:
|
|
4793
|
+
# the limit on data ingested through this method is 2 GB. For best performance,
|
|
4794
|
+
# use a non-FHIR data type instead of wrapping the data in a Binary resource.
|
|
4795
|
+
# Some of the Healthcare API features, such as [exporting to BigQuery](https://
|
|
4796
|
+
# cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub
|
|
4797
|
+
# notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#
|
|
5300
4798
|
# behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full
|
|
5301
4799
|
# resource content, do not support Binary resources that are larger than 10 MB.
|
|
5302
4800
|
# In these cases the resource's `data` field will be omitted. Instead, the "http:
|
|
@@ -5381,12 +4879,13 @@ module Google
|
|
|
5381
4879
|
# concept maps. Implements the FHIR standard $translate operation ([DSTU2](https:
|
|
5382
4880
|
# //www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://
|
|
5383
4881
|
# www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.
|
|
5384
|
-
# hl7.org/fhir/R4/operation-conceptmap-translate.html)
|
|
5385
|
-
#
|
|
5386
|
-
#
|
|
5387
|
-
#
|
|
5388
|
-
#
|
|
5389
|
-
#
|
|
4882
|
+
# hl7.org/fhir/R4/operation-conceptmap-translate.html), [R5](https://www.hl7.org/
|
|
4883
|
+
# fhir/R5/operation-conceptmap-translate.html)). On success, the response body
|
|
4884
|
+
# contains a JSON-encoded representation of a FHIR Parameters resource, which
|
|
4885
|
+
# includes the translation result. Errors generated by the FHIR store contain a
|
|
4886
|
+
# JSON-encoded `OperationOutcome` resource describing the reason for the error.
|
|
4887
|
+
# If the request cannot be mapped to a valid API method on a FHIR store, a
|
|
4888
|
+
# generic GCP error might be returned instead.
|
|
5390
4889
|
# @param [String] parent
|
|
5391
4890
|
# Required. The name for the FHIR store containing the concept map(s) to use for
|
|
5392
4891
|
# the translation.
|
|
@@ -5444,12 +4943,13 @@ module Google
|
|
|
5444
4943
|
# system. Implements the FHIR standard $translate operation ([DSTU2](https://www.
|
|
5445
4944
|
# hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.
|
|
5446
4945
|
# hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.
|
|
5447
|
-
# org/fhir/R4/operation-conceptmap-translate.html))
|
|
5448
|
-
#
|
|
5449
|
-
#
|
|
5450
|
-
#
|
|
5451
|
-
#
|
|
5452
|
-
#
|
|
4946
|
+
# org/fhir/R4/operation-conceptmap-translate.html)), [R5](https://www.hl7.org/
|
|
4947
|
+
# fhir/R5/operation-conceptmap-translate.html)). On success, the response body
|
|
4948
|
+
# contains a JSON-encoded representation of a FHIR Parameters resource, which
|
|
4949
|
+
# includes the translation result. Errors generated by the FHIR store contain a
|
|
4950
|
+
# JSON-encoded `OperationOutcome` resource describing the reason for the error.
|
|
4951
|
+
# If the request cannot be mapped to a valid API method on a FHIR store, a
|
|
4952
|
+
# generic GCP error might be returned instead.
|
|
5453
4953
|
# @param [String] name
|
|
5454
4954
|
# Required. The URL for the concept map to use for the translation.
|
|
5455
4955
|
# @param [String] code
|
|
@@ -5527,20 +5027,22 @@ module Google
|
|
|
5527
5027
|
# Retrieves an Encounter resource and resources related to that Encounter.
|
|
5528
5028
|
# Implements the FHIR extended operation Encounter-everything ([DSTU2](https://
|
|
5529
5029
|
# hl7.org/fhir/DSTU2/encounter-operations.html#everything), [STU3](https://hl7.
|
|
5530
|
-
# org/fhir/STU3/encounter-operations.html#everything),
|
|
5531
|
-
#
|
|
5532
|
-
#
|
|
5533
|
-
#
|
|
5534
|
-
#
|
|
5535
|
-
#
|
|
5536
|
-
#
|
|
5537
|
-
#
|
|
5538
|
-
#
|
|
5539
|
-
#
|
|
5540
|
-
#
|
|
5541
|
-
#
|
|
5542
|
-
#
|
|
5543
|
-
#
|
|
5030
|
+
# org/fhir/STU3/encounter-operations.html#everything), [R4](https://hl7.org/fhir/
|
|
5031
|
+
# R4/encounter-operation-everything.html), or [R5](https://hl7.org/fhir/R5/
|
|
5032
|
+
# encounter-operation-everything.html)). On success, the response body contains
|
|
5033
|
+
# a JSON-encoded representation of a `Bundle` resource of type `searchset`,
|
|
5034
|
+
# containing the results of the operation. Errors generated by the FHIR store
|
|
5035
|
+
# contain a JSON-encoded `OperationOutcome` resource describing the reason for
|
|
5036
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
|
5037
|
+
# store, a generic GCP error might be returned instead. The resources in scope
|
|
5038
|
+
# for the response are: * The Encounter resource itself. * All the resources
|
|
5039
|
+
# directly referenced by the Encounter resource, including attachments and
|
|
5040
|
+
# binaries. * Resources directly referencing the Encounter resource that meet
|
|
5041
|
+
# the inclusion criteria. The inclusion criteria are based on the membership
|
|
5042
|
+
# rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/
|
|
5043
|
+
# DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/
|
|
5044
|
+
# compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/
|
|
5045
|
+
# compartmentdefinition-encounter.html), [R5](http://hl7.org/fhir/R5/
|
|
5544
5046
|
# compartmentdefinition-encounter.html)), which details the eligible resource
|
|
5545
5047
|
# types and referencing search parameters. * Resources referencing to the
|
|
5546
5048
|
# Encounter resource through the "http://hl7.org/fhir/StructureDefinition/
|
|
@@ -5602,24 +5104,25 @@ module Google
|
|
|
5602
5104
|
# search criteria specified as query parameters, grouped by `Observation.code`,
|
|
5603
5105
|
# sorted from most recent to oldest. Implements the FHIR extended operation
|
|
5604
5106
|
# Observation-lastn ([STU3](https://hl7.org/fhir/STU3/observation-operations.
|
|
5605
|
-
# html#lastn), [R4](https://hl7.org/fhir/R4/observation-operation-lastn.html)
|
|
5606
|
-
# DSTU2 doesn't
|
|
5607
|
-
# the
|
|
5608
|
-
#
|
|
5609
|
-
#
|
|
5610
|
-
#
|
|
5611
|
-
#
|
|
5612
|
-
#
|
|
5613
|
-
#
|
|
5614
|
-
#
|
|
5615
|
-
#
|
|
5616
|
-
# the
|
|
5617
|
-
#
|
|
5618
|
-
#
|
|
5619
|
-
#
|
|
5620
|
-
#
|
|
5621
|
-
#
|
|
5622
|
-
#
|
|
5107
|
+
# html#lastn), [R4](https://hl7.org/fhir/R4/observation-operation-lastn.html), [
|
|
5108
|
+
# R5](https://hl7.org/fhir/R5/observation-operation-lastn.html)). DSTU2 doesn't
|
|
5109
|
+
# define the Observation-lastn method, but the server supports it the same way
|
|
5110
|
+
# it supports STU3. Search terms are provided as query parameters following the
|
|
5111
|
+
# same pattern as the search method. The following search parameters must be
|
|
5112
|
+
# provided: - `subject` or `patient` to specify a subject for the Observation. -
|
|
5113
|
+
# `code`, `category` or any of the composite parameters that include `code`. Any
|
|
5114
|
+
# other valid Observation search parameters can also be provided. This operation
|
|
5115
|
+
# accepts an additional query parameter `max`, which specifies N, the maximum
|
|
5116
|
+
# number of Observations to return from each group, with a default of 1.
|
|
5117
|
+
# Searches with over 1000 results are rejected. Results are counted before
|
|
5118
|
+
# grouping and limiting the results with `max`. To stay within the limit,
|
|
5119
|
+
# constrain these searches using Observation search parameters such as `
|
|
5120
|
+
# _lastUpdated` or `date`. On success, the response body contains a JSON-encoded
|
|
5121
|
+
# representation of a `Bundle` resource of type `searchset`, containing the
|
|
5122
|
+
# results of the operation. Errors generated by the FHIR store contain a JSON-
|
|
5123
|
+
# encoded `OperationOutcome` resource describing the reason for the error. If
|
|
5124
|
+
# the request cannot be mapped to a valid API method on a FHIR store, a generic
|
|
5125
|
+
# GCP error might be returned instead.
|
|
5623
5126
|
# @param [String] parent
|
|
5624
5127
|
# Required. Name of the FHIR store to retrieve resources from.
|
|
5625
5128
|
# @param [String] fields
|
|
@@ -5701,19 +5204,21 @@ module Google
|
|
|
5701
5204
|
# the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/
|
|
5702
5205
|
# DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/
|
|
5703
5206
|
# patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-
|
|
5704
|
-
# operation-everything.html)
|
|
5705
|
-
#
|
|
5706
|
-
#
|
|
5707
|
-
#
|
|
5708
|
-
#
|
|
5709
|
-
#
|
|
5710
|
-
#
|
|
5711
|
-
#
|
|
5712
|
-
# patient resource
|
|
5713
|
-
#
|
|
5714
|
-
#
|
|
5715
|
-
# org/fhir/
|
|
5716
|
-
#
|
|
5207
|
+
# operation-everything.html), [R5](https://hl7.org/fhir/R5/patient-operation-
|
|
5208
|
+
# everything.html)). On success, the response body contains a JSON-encoded
|
|
5209
|
+
# representation of a `Bundle` resource of type `searchset`, containing the
|
|
5210
|
+
# results of the operation. Errors generated by the FHIR store contain a JSON-
|
|
5211
|
+
# encoded `OperationOutcome` resource describing the reason for the error. If
|
|
5212
|
+
# the request cannot be mapped to a valid API method on a FHIR store, a generic
|
|
5213
|
+
# GCP error might be returned instead. The resources in scope for the response
|
|
5214
|
+
# are: * The patient resource itself. * All the resources directly referenced by
|
|
5215
|
+
# the patient resource. * Resources directly referencing the patient resource
|
|
5216
|
+
# that meet the inclusion criteria. The inclusion criteria are based on the
|
|
5217
|
+
# membership rules in the patient compartment definition ([DSTU2](https://hl7.
|
|
5218
|
+
# org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/
|
|
5219
|
+
# compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/
|
|
5220
|
+
# compartmentdefinition-patient.html), [R5](http://hl7.org/fhir/R5/
|
|
5221
|
+
# compartmentdefinition-patient.html)), which details the eligible resource
|
|
5717
5222
|
# types and referencing search parameters. For samples that show how to call `
|
|
5718
5223
|
# Patient-everything`, see [Getting all patient compartment resources](https://
|
|
5719
5224
|
# cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
|
@@ -5884,26 +5389,26 @@ module Google
|
|
|
5884
5389
|
# Validates an input FHIR resource's conformance to its profiles and the
|
|
5885
5390
|
# profiles configured on the FHIR store. Implements the FHIR extended operation $
|
|
5886
5391
|
# validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate)
|
|
5887
|
-
# , [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate),
|
|
5888
|
-
# https://hl7.org/fhir/R4/resource-operation-validate.html)
|
|
5889
|
-
#
|
|
5890
|
-
#
|
|
5891
|
-
#
|
|
5892
|
-
#
|
|
5893
|
-
#
|
|
5894
|
-
#
|
|
5895
|
-
#
|
|
5896
|
-
#
|
|
5897
|
-
# instead.
|
|
5392
|
+
# , [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), [R4](
|
|
5393
|
+
# https://hl7.org/fhir/R4/resource-operation-validate.html), or [R5](https://hl7.
|
|
5394
|
+
# org/fhir/R5/resource-operation-validate.html)). The request body must contain
|
|
5395
|
+
# a JSON-encoded FHIR resource, and the request headers must contain `Content-
|
|
5396
|
+
# Type: application/fhir+json`. The `Parameters` input syntax is not supported.
|
|
5397
|
+
# The `profile` query parameter can be used to request that the resource only be
|
|
5398
|
+
# validated against a specific profile. If a profile with the given URL cannot
|
|
5399
|
+
# be found in the FHIR store then an error is returned. Errors generated by
|
|
5400
|
+
# validation contain a JSON-encoded `OperationOutcome` resource describing the
|
|
5401
|
+
# reason for the error. If the request cannot be mapped to a valid API method on
|
|
5402
|
+
# a FHIR store, a generic GCP error might be returned instead.
|
|
5898
5403
|
# @param [String] parent
|
|
5899
5404
|
# Required. The name of the FHIR store that holds the profiles being used for
|
|
5900
5405
|
# validation.
|
|
5901
5406
|
# @param [String] type
|
|
5902
5407
|
# Required. The FHIR resource type of the resource being validated. For a
|
|
5903
5408
|
# complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/
|
|
5904
|
-
# resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
5905
|
-
#
|
|
5906
|
-
# in the provided content.
|
|
5409
|
+
# resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](
|
|
5410
|
+
# https://hl7.org/fhir/R4/resourcelist.html), or [R5](https://hl7.org/fhir/R5/
|
|
5411
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
|
5907
5412
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
5908
5413
|
# @param [String] profile
|
|
5909
5414
|
# Optional. The canonical URL of a profile that this resource should be
|
|
@@ -6014,14 +5519,15 @@ module Google
|
|
|
6014
5519
|
|
|
6015
5520
|
# Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/
|
|
6016
5521
|
# capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.
|
|
6017
|
-
# html)
|
|
6018
|
-
# html) in the
|
|
6019
|
-
#
|
|
6020
|
-
# capabilities interaction
|
|
6021
|
-
#
|
|
6022
|
-
#
|
|
6023
|
-
#
|
|
6024
|
-
#
|
|
5522
|
+
# html), [R5](https://hl7.org/fhir/R5/capabilitystatement.html)), or the [
|
|
5523
|
+
# conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the
|
|
5524
|
+
# DSTU2 case for the store, which contains a description of functionality
|
|
5525
|
+
# supported by the server. Implements the FHIR standard capabilities interaction
|
|
5526
|
+
# ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.
|
|
5527
|
+
# org/fhir/R4/http.html#capabilities), [R5](https://hl7.org/fhir/R5/http.html#
|
|
5528
|
+
# capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/
|
|
5529
|
+
# http.html#conformance) in the DSTU2 case. On success, the response body
|
|
5530
|
+
# contains a JSON-encoded representation of a `CapabilityStatement` resource.
|
|
6025
5531
|
# @param [String] name
|
|
6026
5532
|
# Required. Name of the FHIR store to retrieve the capabilities for.
|
|
6027
5533
|
# @param [String] fields
|
|
@@ -6054,30 +5560,31 @@ module Google
|
|
|
6054
5560
|
# Deletes FHIR resources that match a search query. Implements the FHIR standard
|
|
6055
5561
|
# conditional delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.
|
|
6056
5562
|
# 1.0.12.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.13.1), [R4](https:
|
|
6057
|
-
# //hl7.org/fhir/R4/http.html#3.1.0.7.1)
|
|
6058
|
-
#
|
|
6059
|
-
#
|
|
6060
|
-
#
|
|
6061
|
-
#
|
|
6062
|
-
# deleted depends on the page size of
|
|
6063
|
-
#
|
|
6064
|
-
# delete a maximum 1,000 FHIR
|
|
6065
|
-
#
|
|
6066
|
-
#
|
|
6067
|
-
# moved to a history repository that can
|
|
6068
|
-
# related methods, unless they are removed
|
|
6069
|
-
# requires the`healthcare.fhirStores.
|
|
6070
|
-
# fhirResources.delete` permissions on the
|
|
6071
|
-
# show how to call `conditionalDelete`, see [
|
|
6072
|
-
# resource](https://cloud.google.com/healthcare/
|
|
6073
|
-
# conditionally_deleting_a_fhir_resource).
|
|
5563
|
+
# //hl7.org/fhir/R4/http.html#3.1.0.7.1), [R5](https://hl7.org/fhir/R5/http.html#
|
|
5564
|
+
# 3.1.0.7.1)). If multiple resources match, all matching resources are deleted.
|
|
5565
|
+
# Search terms are provided as query parameters following the same pattern as
|
|
5566
|
+
# the search method. Not all FHIR resources that match the search query might be
|
|
5567
|
+
# deleted because, by default, a maximum of 100 FHIR resources can be deleted.
|
|
5568
|
+
# The number of FHIR resources that can be deleted depends on the page size of
|
|
5569
|
+
# the returned resources, which you can control using the `_count` query
|
|
5570
|
+
# parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR
|
|
5571
|
+
# resources per each call of `conditionalDelete`. Note: Unless resource
|
|
5572
|
+
# versioning is disabled by setting the disable_resource_versioning flag on the
|
|
5573
|
+
# FHIR store, the deleted resources are moved to a history repository that can
|
|
5574
|
+
# still be retrieved through vread and related methods, unless they are removed
|
|
5575
|
+
# by the purge method. This method requires the`healthcare.fhirStores.
|
|
5576
|
+
# searchResources` and `healthcare.fhirResources.delete` permissions on the
|
|
5577
|
+
# parent FHIR store. For samples that show how to call `conditionalDelete`, see [
|
|
5578
|
+
# Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/
|
|
5579
|
+
# docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).
|
|
6074
5580
|
# @param [String] parent
|
|
6075
5581
|
# Required. The name of the FHIR store this resource belongs to.
|
|
6076
5582
|
# @param [String] type
|
|
6077
5583
|
# Required. The FHIR resource type to delete, such as Patient or Observation.
|
|
6078
5584
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6079
5585
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6080
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
|
5586
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
5587
|
+
# resourcelist.html)).
|
|
6081
5588
|
# @param [String] fields
|
|
6082
5589
|
# Selector specifying which fields to include in a partial response.
|
|
6083
5590
|
# @param [String] quota_user
|
|
@@ -6110,30 +5617,32 @@ module Google
|
|
|
6110
5617
|
# parameters, updates part of that resource by applying the operations specified
|
|
6111
5618
|
# in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR
|
|
6112
5619
|
# standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.
|
|
6113
|
-
# html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)
|
|
6114
|
-
# define a conditional patch method,
|
|
6115
|
-
# it supports STU3. Search terms are
|
|
6116
|
-
# same pattern as the search method.
|
|
6117
|
-
# one match, the request returns a `
|
|
6118
|
-
#
|
|
6119
|
-
# Content-Type: application/json-
|
|
6120
|
-
#
|
|
6121
|
-
#
|
|
6122
|
-
#
|
|
6123
|
-
#
|
|
6124
|
-
#
|
|
6125
|
-
#
|
|
6126
|
-
#
|
|
6127
|
-
#
|
|
6128
|
-
#
|
|
6129
|
-
# docs/how-tos/fhir-
|
|
5620
|
+
# html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.
|
|
5621
|
+
# org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method,
|
|
5622
|
+
# but the server supports it in the same way it supports STU3. Search terms are
|
|
5623
|
+
# provided as query parameters following the same pattern as the search method.
|
|
5624
|
+
# If the search criteria identify more than one match, the request returns a `
|
|
5625
|
+
# 412 Precondition Failed` error. The request body must contain a JSON Patch
|
|
5626
|
+
# document, and the request headers must contain `Content-Type: application/json-
|
|
5627
|
+
# patch+json`. On success, the response body contains a JSON-encoded
|
|
5628
|
+
# representation of the updated resource, including the server-assigned version
|
|
5629
|
+
# ID. Errors generated by the FHIR store contain a JSON-encoded `
|
|
5630
|
+
# OperationOutcome` resource describing the reason for the error. If the request
|
|
5631
|
+
# cannot be mapped to a valid API method on a FHIR store, a generic GCP error
|
|
5632
|
+
# might be returned instead. This method requires the`healthcare.fhirStores.
|
|
5633
|
+
# searchResources` permission on the parent FHIR store and the `healthcare.
|
|
5634
|
+
# fhirResources.patch` permission on the requested FHIR store resource. For
|
|
5635
|
+
# samples that show how to call `conditionalPatch`, see [Conditionally patching
|
|
5636
|
+
# a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
5637
|
+
# resources#conditionally_patching_a_fhir_resource).
|
|
6130
5638
|
# @param [String] parent
|
|
6131
5639
|
# Required. The name of the FHIR store this resource belongs to.
|
|
6132
5640
|
# @param [String] type
|
|
6133
5641
|
# Required. The FHIR resource type to update, such as Patient or Observation.
|
|
6134
5642
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6135
5643
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6136
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
|
5644
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
5645
|
+
# resourcelist.html)).
|
|
6137
5646
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
6138
5647
|
# @param [String] fields
|
|
6139
5648
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -6169,38 +5678,39 @@ module Google
|
|
|
6169
5678
|
# parameters, updates the entire contents of that resource. Implements the FHIR
|
|
6170
5679
|
# standard conditional update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/
|
|
6171
5680
|
# http.html#2.1.0.10.2), [STU3](https://hl7.org/fhir/STU3/http.html#cond-update),
|
|
6172
|
-
# [R4](https://hl7.org/fhir/R4/http.html#cond-update)
|
|
6173
|
-
#
|
|
6174
|
-
#
|
|
6175
|
-
#
|
|
6176
|
-
#
|
|
6177
|
-
#
|
|
6178
|
-
#
|
|
6179
|
-
#
|
|
6180
|
-
#
|
|
6181
|
-
#
|
|
6182
|
-
#
|
|
6183
|
-
#
|
|
6184
|
-
#
|
|
6185
|
-
#
|
|
6186
|
-
#
|
|
6187
|
-
#
|
|
6188
|
-
#
|
|
6189
|
-
#
|
|
6190
|
-
#
|
|
6191
|
-
# instead. This method requires the`
|
|
6192
|
-
# healthcare.
|
|
6193
|
-
# samples that show how to call `
|
|
6194
|
-
# a FHIR resource](https://cloud.
|
|
6195
|
-
# resources#
|
|
5681
|
+
# [R4](https://hl7.org/fhir/R4/http.html#cond-update), [R5](https://hl7.org/
|
|
5682
|
+
# fhir/R5/http.html#cond-update)). Search terms are provided as query parameters
|
|
5683
|
+
# following the same pattern as the search method. If the search criteria
|
|
5684
|
+
# identify more than one match, the request returns a `412 Precondition Failed`
|
|
5685
|
+
# error. If the search criteria identify zero matches, and the supplied resource
|
|
5686
|
+
# body contains an `id`, and the FHIR store has enable_update_create set,
|
|
5687
|
+
# creates the resource with the client-specified ID. It is strongly advised not
|
|
5688
|
+
# to include or encode any sensitive data such as patient identifiers in client-
|
|
5689
|
+
# specified resource IDs. Those IDs are part of the FHIR resource path recorded
|
|
5690
|
+
# in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained
|
|
5691
|
+
# in reference fields within other resources. If the search criteria identify
|
|
5692
|
+
# zero matches, and the supplied resource body does not contain an `id`, the
|
|
5693
|
+
# resource is created with a server-assigned ID as per the create method. The
|
|
5694
|
+
# request body must contain a JSON-encoded FHIR resource, and the request
|
|
5695
|
+
# headers must contain `Content-Type: application/fhir+json`. On success, the
|
|
5696
|
+
# response body contains a JSON-encoded representation of the updated resource,
|
|
5697
|
+
# including the server-assigned version ID. Errors generated by the FHIR store
|
|
5698
|
+
# contain a JSON-encoded `OperationOutcome` resource describing the reason for
|
|
5699
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
|
5700
|
+
# store, a generic GCP error might be returned instead. This method requires the`
|
|
5701
|
+
# healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update`
|
|
5702
|
+
# permissions on the parent FHIR store. For samples that show how to call `
|
|
5703
|
+
# conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.
|
|
5704
|
+
# google.com/healthcare/docs/how-tos/fhir-resources#
|
|
5705
|
+
# conditionally_updating_a_fhir_resource).
|
|
6196
5706
|
# @param [String] parent
|
|
6197
5707
|
# Required. The name of the FHIR store this resource belongs to.
|
|
6198
5708
|
# @param [String] type
|
|
6199
5709
|
# Required. The FHIR resource type to update, such as Patient or Observation.
|
|
6200
5710
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6201
5711
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6202
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
|
6203
|
-
# in the provided content.
|
|
5712
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
5713
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
|
6204
5714
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
6205
5715
|
# @param [String] fields
|
|
6206
5716
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -6234,31 +5744,32 @@ module Google
|
|
|
6234
5744
|
|
|
6235
5745
|
# Creates a FHIR resource. Implements the FHIR standard create interaction ([
|
|
6236
5746
|
# DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/
|
|
6237
|
-
# fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)),
|
|
6238
|
-
# which creates a new resource
|
|
6239
|
-
#
|
|
6240
|
-
#
|
|
6241
|
-
# [
|
|
6242
|
-
#
|
|
6243
|
-
#
|
|
6244
|
-
#
|
|
6245
|
-
#
|
|
6246
|
-
#
|
|
6247
|
-
#
|
|
6248
|
-
#
|
|
6249
|
-
#
|
|
6250
|
-
#
|
|
6251
|
-
#
|
|
6252
|
-
#
|
|
6253
|
-
#
|
|
5747
|
+
# fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)), [
|
|
5748
|
+
# R5](https://hl7.org/fhir/R5/http.html#create)), which creates a new resource
|
|
5749
|
+
# with a server-assigned resource ID. Also supports the FHIR standard
|
|
5750
|
+
# conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#
|
|
5751
|
+
# ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://
|
|
5752
|
+
# hl7.org/fhir/R4/http.html#ccreate)), [R5](https://hl7.org/fhir/R5/http.html#
|
|
5753
|
+
# ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR
|
|
5754
|
+
# search query. If no resources match this search query, the server processes
|
|
5755
|
+
# the create operation as normal. The request body must contain a JSON-encoded
|
|
5756
|
+
# FHIR resource, and the request headers must contain `Content-Type: application/
|
|
5757
|
+
# fhir+json`. On success, the response body contains a JSON-encoded
|
|
5758
|
+
# representation of the resource as it was created on the server, including the
|
|
5759
|
+
# server-assigned resource ID and version ID. Errors generated by the FHIR store
|
|
5760
|
+
# contain a JSON-encoded `OperationOutcome` resource describing the reason for
|
|
5761
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
|
5762
|
+
# store, a generic GCP error might be returned instead. For samples that show
|
|
5763
|
+
# how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/
|
|
5764
|
+
# healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).
|
|
6254
5765
|
# @param [String] parent
|
|
6255
5766
|
# Required. The name of the FHIR store this resource belongs to.
|
|
6256
5767
|
# @param [String] type
|
|
6257
5768
|
# Required. The FHIR resource type to create, such as Patient or Observation.
|
|
6258
5769
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6259
5770
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6260
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
|
6261
|
-
# in the provided content.
|
|
5771
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
5772
|
+
# resourcelist.html)). Must match the resource type in the provided content.
|
|
6262
5773
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
6263
5774
|
# @param [String] fields
|
|
6264
5775
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -6292,13 +5803,14 @@ module Google
|
|
|
6292
5803
|
|
|
6293
5804
|
# Deletes a FHIR resource. Implements the FHIR standard delete interaction ([
|
|
6294
5805
|
# DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/
|
|
6295
|
-
# fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete)
|
|
6296
|
-
# Note: Unless resource
|
|
6297
|
-
#
|
|
6298
|
-
# moved to a history repository that can
|
|
6299
|
-
# related methods, unless they are removed
|
|
6300
|
-
# show how to call `delete`, see [Deleting
|
|
6301
|
-
# com/healthcare/docs/how-tos/fhir-
|
|
5806
|
+
# fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete), [
|
|
5807
|
+
# R5](https://hl7.org/fhir/R5/http.html#delete)). Note: Unless resource
|
|
5808
|
+
# versioning is disabled by setting the disable_resource_versioning flag on the
|
|
5809
|
+
# FHIR store, the deleted resources are moved to a history repository that can
|
|
5810
|
+
# still be retrieved through vread and related methods, unless they are removed
|
|
5811
|
+
# by the purge method. For samples that show how to call `delete`, see [Deleting
|
|
5812
|
+
# a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
5813
|
+
# resources#deleting_a_fhir_resource).
|
|
6302
5814
|
# @param [String] name
|
|
6303
5815
|
# Required. The name of the resource to delete.
|
|
6304
5816
|
# @param [String] fields
|
|
@@ -6331,35 +5843,37 @@ module Google
|
|
|
6331
5843
|
# Executes all the requests in the given Bundle. Implements the FHIR standard
|
|
6332
5844
|
# batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/
|
|
6333
5845
|
# fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/fhir/STU3/http.html#
|
|
6334
|
-
# transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction)
|
|
6335
|
-
# all interactions within a
|
|
6336
|
-
#
|
|
6337
|
-
# transaction`
|
|
6338
|
-
#
|
|
6339
|
-
# http.html#2.
|
|
6340
|
-
#
|
|
6341
|
-
#
|
|
6342
|
-
# hl7.org/fhir/
|
|
6343
|
-
#
|
|
6344
|
-
#
|
|
6345
|
-
#
|
|
6346
|
-
#
|
|
6347
|
-
#
|
|
6348
|
-
#
|
|
6349
|
-
#
|
|
6350
|
-
#
|
|
6351
|
-
#
|
|
6352
|
-
#
|
|
6353
|
-
#
|
|
6354
|
-
#
|
|
6355
|
-
#
|
|
6356
|
-
#
|
|
6357
|
-
#
|
|
6358
|
-
#
|
|
6359
|
-
#
|
|
6360
|
-
#
|
|
6361
|
-
#
|
|
6362
|
-
#
|
|
5846
|
+
# transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction), [R5](https:/
|
|
5847
|
+
# /hl7.org/fhir/R5/http.html#transaction)). Supports all interactions within a
|
|
5848
|
+
# bundle, except search. This method accepts Bundles of type `batch`, `
|
|
5849
|
+
# transaction` and `history`, processing `batch` and `transaction` bundles
|
|
5850
|
+
# according to the batch processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/
|
|
5851
|
+
# http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.1),
|
|
5852
|
+
# [R4](https://hl7.org/fhir/R4/http.html#brules), [R5](https://hl7.org/fhir/R5/
|
|
5853
|
+
# http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/
|
|
5854
|
+
# fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/STU3/http.html#2.
|
|
5855
|
+
# 21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules), [R5](https://hl7.
|
|
5856
|
+
# org/fhir/R5/http.html#trules)). The request body must contain a JSON-encoded
|
|
5857
|
+
# FHIR `Bundle` resource, and the request headers must contain `Content-Type:
|
|
5858
|
+
# application/fhir+json`. For a batch bundle or a successful transaction, the
|
|
5859
|
+
# response body contains a JSON-encoded representation of a `Bundle` resource of
|
|
5860
|
+
# type `batch-response` or `transaction-response` containing one entry for each
|
|
5861
|
+
# entry in the request, with the outcome of processing the entry. In the case of
|
|
5862
|
+
# an error for a `transaction` or `history` bundle, the response body contains a
|
|
5863
|
+
# JSON-encoded `OperationOutcome` resource describing the reason for the error.
|
|
5864
|
+
# If the request cannot be mapped to a valid API method on a FHIR store, a
|
|
5865
|
+
# generic GCP error might be returned instead. This method checks permissions
|
|
5866
|
+
# for each request in the bundle. The `executeBundle` permission is required to
|
|
5867
|
+
# call this method, but you must also grant sufficient permissions to execute
|
|
5868
|
+
# the individual requests in the bundle. For example, if the bundle contains a
|
|
5869
|
+
# request to create a FHIR resource, the caller must also have been granted the `
|
|
5870
|
+
# healthcare.fhirResources.create` permission. `history` bundles also check the `
|
|
5871
|
+
# import` permission. You can use audit logs to view the permissions for `
|
|
5872
|
+
# executeBundle` and each request in the bundle. For more information, see [
|
|
5873
|
+
# Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/
|
|
5874
|
+
# audit-logging). For samples that show how to call `executeBundle`, see [
|
|
5875
|
+
# Managing FHIR resources using FHIR bundles](https://cloud.google.com/
|
|
5876
|
+
# healthcare/docs/how-tos/fhir-bundles).
|
|
6363
5877
|
# @param [String] parent
|
|
6364
5878
|
# Required. Name of the FHIR store in which this bundle will be executed.
|
|
6365
5879
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
@@ -6396,12 +5910,13 @@ module Google
|
|
|
6396
5910
|
# deleted versions) from the FHIR store. Implements the per-resource form of the
|
|
6397
5911
|
# FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.
|
|
6398
5912
|
# html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https:
|
|
6399
|
-
# //hl7.org/fhir/R4/http.html#history)
|
|
6400
|
-
#
|
|
6401
|
-
#
|
|
6402
|
-
#
|
|
6403
|
-
#
|
|
6404
|
-
#
|
|
5913
|
+
# //hl7.org/fhir/R4/http.html#history), [R5](https://hl7.org/fhir/R5/http.html#
|
|
5914
|
+
# history)). On success, the response body contains a JSON-encoded
|
|
5915
|
+
# representation of a `Bundle` resource of type `history`, containing the
|
|
5916
|
+
# version history sorted from most recent to oldest versions. Errors generated
|
|
5917
|
+
# by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
5918
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
5919
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
6405
5920
|
# instead. For samples that show how to call `history`, see [Listing FHIR
|
|
6406
5921
|
# resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-
|
|
6407
5922
|
# resources#listing_fhir_resource_versions).
|
|
@@ -6461,17 +5976,18 @@ module Google
|
|
|
6461
5976
|
# Updates part of an existing resource by applying the operations specified in a
|
|
6462
5977
|
# [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard
|
|
6463
5978
|
# patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](
|
|
6464
|
-
# https://hl7.org/fhir/R4/http.html#patch)
|
|
6465
|
-
#
|
|
6466
|
-
#
|
|
6467
|
-
# Content-Type: application/json-
|
|
6468
|
-
#
|
|
6469
|
-
#
|
|
6470
|
-
#
|
|
6471
|
-
#
|
|
6472
|
-
#
|
|
6473
|
-
#
|
|
6474
|
-
# tos/
|
|
5979
|
+
# https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.
|
|
5980
|
+
# html#patch)). DSTU2 doesn't define a patch method, but the server supports it
|
|
5981
|
+
# in the same way it supports STU3. The request body must contain a JSON Patch
|
|
5982
|
+
# document, and the request headers must contain `Content-Type: application/json-
|
|
5983
|
+
# patch+json`. On success, the response body contains a JSON-encoded
|
|
5984
|
+
# representation of the updated resource, including the server-assigned version
|
|
5985
|
+
# ID. Errors generated by the FHIR store contain a JSON-encoded `
|
|
5986
|
+
# OperationOutcome` resource describing the reason for the error. If the request
|
|
5987
|
+
# cannot be mapped to a valid API method on a FHIR store, a generic GCP error
|
|
5988
|
+
# might be returned instead. For samples that show how to call `patch`, see [
|
|
5989
|
+
# Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
|
|
5990
|
+
# fhir-resources#patching_a_fhir_resource).
|
|
6475
5991
|
# @param [String] name
|
|
6476
5992
|
# Required. The name of the resource to update.
|
|
6477
5993
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
@@ -6507,17 +6023,19 @@ module Google
|
|
|
6507
6023
|
# Gets the contents of a FHIR resource. Implements the FHIR standard read
|
|
6508
6024
|
# interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https:/
|
|
6509
6025
|
# /hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#
|
|
6510
|
-
# read)). Also supports the FHIR
|
|
6511
|
-
#
|
|
6512
|
-
#
|
|
6513
|
-
#
|
|
6514
|
-
#
|
|
6515
|
-
#
|
|
6516
|
-
#
|
|
6517
|
-
#
|
|
6518
|
-
#
|
|
6519
|
-
#
|
|
6520
|
-
#
|
|
6026
|
+
# read)), [R5](https://hl7.org/fhir/R5/http.html#read)). Also supports the FHIR
|
|
6027
|
+
# standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.
|
|
6028
|
+
# html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://
|
|
6029
|
+
# hl7.org/fhir/R4/http.html#cread)), [R5](https://hl7.org/fhir/R5/http.html#
|
|
6030
|
+
# cread)) specified by supplying an `If-Modified-Since` header with a date/time
|
|
6031
|
+
# value or an `If-None-Match` header with an ETag value. On success, the
|
|
6032
|
+
# response body contains a JSON-encoded representation of the resource. Errors
|
|
6033
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
6034
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
6035
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
6036
|
+
# instead. For samples that show how to call `read`, see [Getting a FHIR
|
|
6037
|
+
# resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
|
|
6038
|
+
# getting_a_fhir_resource).
|
|
6521
6039
|
# @param [String] name
|
|
6522
6040
|
# Required. The name of the resource to retrieve.
|
|
6523
6041
|
# @param [String] fields
|
|
@@ -6550,63 +6068,65 @@ module Google
|
|
|
6550
6068
|
# Searches for resources in the given FHIR store according to criteria specified
|
|
6551
6069
|
# as query parameters. Implements the FHIR standard search interaction ([DSTU2](
|
|
6552
6070
|
# https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/
|
|
6553
|
-
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)
|
|
6554
|
-
# search
|
|
6555
|
-
#
|
|
6556
|
-
# [
|
|
6557
|
-
#
|
|
6558
|
-
#
|
|
6559
|
-
#
|
|
6560
|
-
#
|
|
6561
|
-
#
|
|
6562
|
-
#
|
|
6563
|
-
#
|
|
6564
|
-
#
|
|
6565
|
-
#
|
|
6566
|
-
#
|
|
6567
|
-
#
|
|
6568
|
-
#
|
|
6569
|
-
#
|
|
6570
|
-
#
|
|
6571
|
-
#
|
|
6572
|
-
#
|
|
6573
|
-
#
|
|
6574
|
-
#
|
|
6575
|
-
#
|
|
6071
|
+
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https:/
|
|
6072
|
+
# /hl7.org/fhir/R5/http.html#search)) using the search semantics described in
|
|
6073
|
+
# the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html),
|
|
6074
|
+
# [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/
|
|
6075
|
+
# search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four
|
|
6076
|
+
# methods of search defined by the specification: * `GET [base]?[parameters]` to
|
|
6077
|
+
# search across all resources. * `GET [base]/[type]?[parameters]` to search
|
|
6078
|
+
# resources of a specified type. * `POST [base]/_search?[parameters]` as an
|
|
6079
|
+
# alternate form having the same semantics as the `GET` method across all
|
|
6080
|
+
# resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form
|
|
6081
|
+
# having the same semantics as the `GET` method for the specified type. The `GET`
|
|
6082
|
+
# and `POST` methods do not support compartment searches. The `POST` method
|
|
6083
|
+
# does not support `application/x-www-form-urlencoded` search parameters. On
|
|
6084
|
+
# success, the response body contains a JSON-encoded representation of a `Bundle`
|
|
6085
|
+
# resource of type `searchset`, containing the results of the search. Errors
|
|
6086
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
6087
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
6088
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
6089
|
+
# instead. The server's capability statement, retrieved through capabilities,
|
|
6090
|
+
# indicates what search parameters are supported on each FHIR resource. A list
|
|
6091
|
+
# of all search parameters defined by the specification can be found in the FHIR
|
|
6092
|
+
# Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-
|
|
6093
|
+
# registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [
|
|
6094
|
+
# R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search
|
|
6095
|
+
# parameters for DSTU2 can be found on each resource's definition page.
|
|
6576
6096
|
# Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
|
|
6577
6097
|
# `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and
|
|
6578
|
-
# STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `
|
|
6579
|
-
#
|
|
6580
|
-
# The maximum number of search results returned defaults to 100,
|
|
6581
|
-
# overridden by the `_count` parameter up to a maximum limit of
|
|
6582
|
-
# might return fewer resources than requested to prevent
|
|
6583
|
-
# responses. If there are additional results, the returned `
|
|
6584
|
-
# link of `relation` "next", which has a `_page_token`
|
|
6585
|
-
# pagination token that can be used to retrieve the next
|
|
6586
|
-
# total size larger than 5MB or a field count larger than
|
|
6587
|
-
# fully searchable as the server might trim its generated
|
|
6588
|
-
# cases. Note: FHIR resources are indexed asynchronously,
|
|
6589
|
-
# slight delay between the time a resource is created or
|
|
6590
|
-
# when the change reflects in search results. The only
|
|
6591
|
-
# identifier data, which is indexed synchronously as a
|
|
6592
|
-
# result, searching using resource identifier is not subject
|
|
6593
|
-
# To use the special synchronous index, the search term for
|
|
6594
|
-
# in the pattern `identifier=[system]|[value]` or `
|
|
6595
|
-
# of the following search result parameters can be
|
|
6596
|
-
# * `_revinclude` * `_summary` * `_elements` If
|
|
6597
|
-
# search parameters, the standard asynchronous
|
|
6598
|
-
# that searching against the special index is
|
|
6599
|
-
# number of matches. The search isn't optimized
|
|
6600
|
-
# criteria matches a large number (i.e. more than 2,
|
|
6601
|
-
# search query that will match a large number of
|
|
6602
|
-
# using the special synchronous index by including
|
|
6603
|
-
# parameter in your query. Use `_sort=-_lastUpdated` if
|
|
6604
|
-
# default sorting order. Note: The special synchronous
|
|
6605
|
-
# currently disabled for DocumentReference and
|
|
6606
|
-
# samples and detailed information, see [
|
|
6607
|
-
# cloud.google.com/healthcare/docs/how-tos/
|
|
6608
|
-
# search features](https://cloud.google.com/
|
|
6609
|
-
# advanced-search).
|
|
6098
|
+
# STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `
|
|
6099
|
+
# _count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `
|
|
6100
|
+
# _elements`. The maximum number of search results returned defaults to 100,
|
|
6101
|
+
# which can be overridden by the `_count` parameter up to a maximum limit of
|
|
6102
|
+
# 1000. The server might return fewer resources than requested to prevent
|
|
6103
|
+
# excessively large responses. If there are additional results, the returned `
|
|
6104
|
+
# Bundle` contains a link of `relation` "next", which has a `_page_token`
|
|
6105
|
+
# parameter for an opaque pagination token that can be used to retrieve the next
|
|
6106
|
+
# page. Resources with a total size larger than 5MB or a field count larger than
|
|
6107
|
+
# 50,000 might not be fully searchable as the server might trim its generated
|
|
6108
|
+
# search index in those cases. Note: FHIR resources are indexed asynchronously,
|
|
6109
|
+
# so there might be a slight delay between the time a resource is created or
|
|
6110
|
+
# changed, and the time when the change reflects in search results. The only
|
|
6111
|
+
# exception is resource identifier data, which is indexed synchronously as a
|
|
6112
|
+
# special index. As a result, searching using resource identifier is not subject
|
|
6113
|
+
# to indexing delay. To use the special synchronous index, the search term for
|
|
6114
|
+
# identifier should be in the pattern `identifier=[system]|[value]` or `
|
|
6115
|
+
# identifier=[value]`, and any of the following search result parameters can be
|
|
6116
|
+
# used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If
|
|
6117
|
+
# your query contains any other search parameters, the standard asynchronous
|
|
6118
|
+
# index will be used instead. Note that searching against the special index is
|
|
6119
|
+
# optimized for resolving a small number of matches. The search isn't optimized
|
|
6120
|
+
# if your identifier search criteria matches a large number (i.e. more than 2,
|
|
6121
|
+
# 000) of resources. For a search query that will match a large number of
|
|
6122
|
+
# resources, you can avoiding using the special synchronous index by including
|
|
6123
|
+
# an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if
|
|
6124
|
+
# you want to keep the default sorting order. Note: The special synchronous
|
|
6125
|
+
# identifier index are currently disabled for DocumentReference and
|
|
6126
|
+
# DocumentManifest searches. For samples and detailed information, see [
|
|
6127
|
+
# Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/
|
|
6128
|
+
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
|
6129
|
+
# healthcare/docs/how-tos/fhir-advanced-search).
|
|
6610
6130
|
# @param [String] parent
|
|
6611
6131
|
# Required. Name of the FHIR store to retrieve resources from.
|
|
6612
6132
|
# @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object
|
|
@@ -6642,70 +6162,73 @@ module Google
|
|
|
6642
6162
|
# Searches for resources in the given FHIR store according to criteria specified
|
|
6643
6163
|
# as query parameters. Implements the FHIR standard search interaction ([DSTU2](
|
|
6644
6164
|
# https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/
|
|
6645
|
-
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)
|
|
6646
|
-
# search
|
|
6647
|
-
#
|
|
6648
|
-
# [
|
|
6649
|
-
#
|
|
6650
|
-
#
|
|
6651
|
-
#
|
|
6652
|
-
#
|
|
6653
|
-
#
|
|
6654
|
-
#
|
|
6655
|
-
#
|
|
6656
|
-
#
|
|
6657
|
-
#
|
|
6658
|
-
#
|
|
6659
|
-
#
|
|
6660
|
-
#
|
|
6661
|
-
#
|
|
6662
|
-
#
|
|
6663
|
-
#
|
|
6664
|
-
#
|
|
6665
|
-
#
|
|
6666
|
-
#
|
|
6667
|
-
#
|
|
6165
|
+
# http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https:/
|
|
6166
|
+
# /hl7.org/fhir/R5/http.html#search)) using the search semantics described in
|
|
6167
|
+
# the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html),
|
|
6168
|
+
# [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/
|
|
6169
|
+
# search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four
|
|
6170
|
+
# methods of search defined by the specification: * `GET [base]?[parameters]` to
|
|
6171
|
+
# search across all resources. * `GET [base]/[type]?[parameters]` to search
|
|
6172
|
+
# resources of a specified type. * `POST [base]/_search?[parameters]` as an
|
|
6173
|
+
# alternate form having the same semantics as the `GET` method across all
|
|
6174
|
+
# resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form
|
|
6175
|
+
# having the same semantics as the `GET` method for the specified type. The `GET`
|
|
6176
|
+
# and `POST` methods do not support compartment searches. The `POST` method
|
|
6177
|
+
# does not support `application/x-www-form-urlencoded` search parameters. On
|
|
6178
|
+
# success, the response body contains a JSON-encoded representation of a `Bundle`
|
|
6179
|
+
# resource of type `searchset`, containing the results of the search. Errors
|
|
6180
|
+
# generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
6181
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
6182
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
6183
|
+
# instead. The server's capability statement, retrieved through capabilities,
|
|
6184
|
+
# indicates what search parameters are supported on each FHIR resource. A list
|
|
6185
|
+
# of all search parameters defined by the specification can be found in the FHIR
|
|
6186
|
+
# Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-
|
|
6187
|
+
# registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [
|
|
6188
|
+
# R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search
|
|
6189
|
+
# parameters for DSTU2 can be found on each resource's definition page.
|
|
6668
6190
|
# Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
|
|
6669
6191
|
# `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and
|
|
6670
|
-
# STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `
|
|
6671
|
-
#
|
|
6672
|
-
# The maximum number of search results returned defaults to 100,
|
|
6673
|
-
# overridden by the `_count` parameter up to a maximum limit of
|
|
6674
|
-
# might return fewer resources than requested to prevent
|
|
6675
|
-
# responses. If there are additional results, the returned `
|
|
6676
|
-
# link of `relation` "next", which has a `_page_token`
|
|
6677
|
-
# pagination token that can be used to retrieve the next
|
|
6678
|
-
# total size larger than 5MB or a field count larger than
|
|
6679
|
-
# fully searchable as the server might trim its generated
|
|
6680
|
-
# cases. Note: FHIR resources are indexed asynchronously,
|
|
6681
|
-
# slight delay between the time a resource is created or
|
|
6682
|
-
# when the change reflects in search results. The only
|
|
6683
|
-
# identifier data, which is indexed synchronously as a
|
|
6684
|
-
# result, searching using resource identifier is not subject
|
|
6685
|
-
# To use the special synchronous index, the search term for
|
|
6686
|
-
# in the pattern `identifier=[system]|[value]` or `
|
|
6687
|
-
# of the following search result parameters can be
|
|
6688
|
-
# * `_revinclude` * `_summary` * `_elements` If
|
|
6689
|
-
# search parameters, the standard asynchronous
|
|
6690
|
-
# that searching against the special index is
|
|
6691
|
-
# number of matches. The search isn't optimized
|
|
6692
|
-
# criteria matches a large number (i.e. more than 2,
|
|
6693
|
-
# search query that will match a large number of
|
|
6694
|
-
# using the special synchronous index by including
|
|
6695
|
-
# parameter in your query. Use `_sort=-_lastUpdated` if
|
|
6696
|
-
# default sorting order. Note: The special synchronous
|
|
6697
|
-
# currently disabled for DocumentReference and
|
|
6698
|
-
# samples and detailed information, see [
|
|
6699
|
-
# cloud.google.com/healthcare/docs/how-tos/
|
|
6700
|
-
# search features](https://cloud.google.com/
|
|
6701
|
-
# advanced-search).
|
|
6192
|
+
# STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `
|
|
6193
|
+
# _count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `
|
|
6194
|
+
# _elements`. The maximum number of search results returned defaults to 100,
|
|
6195
|
+
# which can be overridden by the `_count` parameter up to a maximum limit of
|
|
6196
|
+
# 1000. The server might return fewer resources than requested to prevent
|
|
6197
|
+
# excessively large responses. If there are additional results, the returned `
|
|
6198
|
+
# Bundle` contains a link of `relation` "next", which has a `_page_token`
|
|
6199
|
+
# parameter for an opaque pagination token that can be used to retrieve the next
|
|
6200
|
+
# page. Resources with a total size larger than 5MB or a field count larger than
|
|
6201
|
+
# 50,000 might not be fully searchable as the server might trim its generated
|
|
6202
|
+
# search index in those cases. Note: FHIR resources are indexed asynchronously,
|
|
6203
|
+
# so there might be a slight delay between the time a resource is created or
|
|
6204
|
+
# changed, and the time when the change reflects in search results. The only
|
|
6205
|
+
# exception is resource identifier data, which is indexed synchronously as a
|
|
6206
|
+
# special index. As a result, searching using resource identifier is not subject
|
|
6207
|
+
# to indexing delay. To use the special synchronous index, the search term for
|
|
6208
|
+
# identifier should be in the pattern `identifier=[system]|[value]` or `
|
|
6209
|
+
# identifier=[value]`, and any of the following search result parameters can be
|
|
6210
|
+
# used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If
|
|
6211
|
+
# your query contains any other search parameters, the standard asynchronous
|
|
6212
|
+
# index will be used instead. Note that searching against the special index is
|
|
6213
|
+
# optimized for resolving a small number of matches. The search isn't optimized
|
|
6214
|
+
# if your identifier search criteria matches a large number (i.e. more than 2,
|
|
6215
|
+
# 000) of resources. For a search query that will match a large number of
|
|
6216
|
+
# resources, you can avoiding using the special synchronous index by including
|
|
6217
|
+
# an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if
|
|
6218
|
+
# you want to keep the default sorting order. Note: The special synchronous
|
|
6219
|
+
# identifier index are currently disabled for DocumentReference and
|
|
6220
|
+
# DocumentManifest searches. For samples and detailed information, see [
|
|
6221
|
+
# Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/
|
|
6222
|
+
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
|
|
6223
|
+
# healthcare/docs/how-tos/fhir-advanced-search).
|
|
6702
6224
|
# @param [String] parent
|
|
6703
6225
|
# Required. Name of the FHIR store to retrieve resources from.
|
|
6704
6226
|
# @param [String] resource_type
|
|
6705
6227
|
# Optional. The FHIR resource type to search, such as Patient or Observation.
|
|
6706
6228
|
# For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/
|
|
6707
6229
|
# DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html),
|
|
6708
|
-
# [R4](https://hl7.org/fhir/R4/resourcelist.html)
|
|
6230
|
+
# [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/
|
|
6231
|
+
# resourcelist.html)).
|
|
6709
6232
|
# @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object
|
|
6710
6233
|
# @param [String] fields
|
|
6711
6234
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -6740,23 +6263,25 @@ module Google
|
|
|
6740
6263
|
# Updates the entire contents of a resource. Implements the FHIR standard update
|
|
6741
6264
|
# interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](
|
|
6742
6265
|
# https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.
|
|
6743
|
-
# html#update)). If the
|
|
6744
|
-
#
|
|
6745
|
-
#
|
|
6746
|
-
#
|
|
6747
|
-
#
|
|
6748
|
-
#
|
|
6749
|
-
#
|
|
6750
|
-
#
|
|
6751
|
-
# contain an `id`
|
|
6752
|
-
#
|
|
6753
|
-
#
|
|
6754
|
-
#
|
|
6755
|
-
#
|
|
6756
|
-
#
|
|
6757
|
-
#
|
|
6758
|
-
#
|
|
6759
|
-
#
|
|
6266
|
+
# html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the
|
|
6267
|
+
# specified resource does not exist and the FHIR store has enable_update_create
|
|
6268
|
+
# set, creates the resource with the client-specified ID. It is strongly advised
|
|
6269
|
+
# not to include or encode any sensitive data such as patient identifiers in
|
|
6270
|
+
# client-specified resource IDs. Those IDs are part of the FHIR resource path
|
|
6271
|
+
# recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
|
|
6272
|
+
# contained in reference fields within other resources. The request body must
|
|
6273
|
+
# contain a JSON-encoded FHIR resource, and the request headers must contain `
|
|
6274
|
+
# Content-Type: application/fhir+json`. The resource must contain an `id`
|
|
6275
|
+
# element having an identical value to the ID in the REST path of the request.
|
|
6276
|
+
# On success, the response body contains a JSON-encoded representation of the
|
|
6277
|
+
# updated resource, including the server-assigned version ID. Errors generated
|
|
6278
|
+
# by the FHIR store contain a JSON-encoded `OperationOutcome` resource
|
|
6279
|
+
# describing the reason for the error. If the request cannot be mapped to a
|
|
6280
|
+
# valid API method on a FHIR store, a generic GCP error might be returned
|
|
6281
|
+
# instead. In R5, the conditional update interaction If-None-Match is supported,
|
|
6282
|
+
# including the wildcard behaviour. For samples that show how to call `update`,
|
|
6283
|
+
# see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-
|
|
6284
|
+
# tos/fhir-resources#updating_a_fhir_resource).
|
|
6760
6285
|
# @param [String] name
|
|
6761
6286
|
# Required. The name of the resource to update.
|
|
6762
6287
|
# @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
|
|
@@ -6792,14 +6317,15 @@ module Google
|
|
|
6792
6317
|
# Gets the contents of a version (current or historical) of a FHIR resource by
|
|
6793
6318
|
# version ID. Implements the FHIR standard vread interaction ([DSTU2](https://
|
|
6794
6319
|
# hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.
|
|
6795
|
-
# html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread)
|
|
6796
|
-
# response body contains a JSON-
|
|
6797
|
-
#
|
|
6798
|
-
#
|
|
6799
|
-
#
|
|
6800
|
-
#
|
|
6801
|
-
# resource version](https://cloud.
|
|
6802
|
-
# resources#
|
|
6320
|
+
# html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread), [R5](https://hl7.
|
|
6321
|
+
# org/fhir/R5/http.html#vread)). On success, the response body contains a JSON-
|
|
6322
|
+
# encoded representation of the resource. Errors generated by the FHIR store
|
|
6323
|
+
# contain a JSON-encoded `OperationOutcome` resource describing the reason for
|
|
6324
|
+
# the error. If the request cannot be mapped to a valid API method on a FHIR
|
|
6325
|
+
# store, a generic GCP error might be returned instead. For samples that show
|
|
6326
|
+
# how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.
|
|
6327
|
+
# google.com/healthcare/docs/how-tos/fhir-resources#
|
|
6328
|
+
# retrieving_a_fhir_resource_version).
|
|
6803
6329
|
# @param [String] name
|
|
6804
6330
|
# Required. The name of the resource version to retrieve.
|
|
6805
6331
|
# @param [String] fields
|