Class: Google::Apis::HealthcareV1alpha2::CloudHealthcareService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/healthcare_v1alpha2/service.rb

Overview

Cloud Healthcare API

Manage, store, and access healthcare data in Google Cloud Platform.

Examples:

require 'google/apis/healthcare_v1alpha2'

Healthcare = Google::Apis::HealthcareV1alpha2 # Alias the module
service = Healthcare::CloudHealthcareService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeCloudHealthcareService

Returns a new instance of CloudHealthcareService



45
46
47
48
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 45

def initialize
  super('https://healthcare.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 38

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#capabilities_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Gets the FHIR capability statement for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction. On success, the response body will contain a JSON-encoded representation of a CapabilityStatement resource.

Parameters:

  • name (String)

    Name of the FHIR store to retrieve the capabilities for.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2105
2106
2107
2108
2109
2110
2111
2112
2113
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2105

def capabilities_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}/metadata', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#capabilities_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Gets the FHIR capability statement for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction. On success, the response body will contain a JSON-encoded representation of a CapabilityStatement resource.

Parameters:

  • name (String)

    Name of the FHIR store to retrieve the capabilities for.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2727

def capabilities_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}/fhir/metadata', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#conditional_project_location_dataset_fhir_store_fhir_delete(parent, type, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction. If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method.

Parameters:

  • parent (String)

    The name of the FHIR store this resource belongs to.

  • type (String)

    The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2773

def conditional_project_location_dataset_fhir_store_fhir_delete(parent, type, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+parent}/fhir/{+type}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['parent'] = parent unless parent.nil?
  command.params['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#conditional_project_location_dataset_fhir_store_fhir_patch(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a JSON Patch document. Implements the FHIR standard conditional patch interaction. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a 412 Precondition Failed error. The request body must contain a JSON Patch document, and the request headers must contain Content-Type: application/json-patch+json. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • parent (String)

    The name of the FHIR store this resource belongs to.

  • type (String)

    The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index.

  • http_body_object (Google::Apis::HealthcareV1alpha2::HttpBody) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2825

def conditional_project_location_dataset_fhir_store_fhir_patch(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+parent}/fhir/{+type}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#conditional_project_location_dataset_fhir_store_fhir_update(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a 412 Precondition Failed error. If the search criteria identify zero matches, and the supplied resource body contains an id, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. If the search criteria identify zero matches, and the supplied resource body does not contain an id, the resource will be created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • parent (String)

    The name of the FHIR store this resource belongs to.

  • type (String)

    The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index. Must match the resource type in the provided content.

  • http_body_object (Google::Apis::HealthcareV1alpha2::HttpBody) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2887

def conditional_project_location_dataset_fhir_store_fhir_update(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1alpha2/{+parent}/fhir/{+type}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_message(parent, create_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Message

Creates a message and sends a notification to the Cloud Pub/Sub topic. If configured, the MLLP adapter listens to messages created by this method and sends those back to the hospital. A successful response indicates the message has been persisted to storage and a Cloud Pub/Sub notification has been sent. Sending to the hospital by the MLLP adapter happens asynchronously.

Parameters:

  • parent (String)

    The name of the dataset this message belongs to.

  • create_message_request_object (Google::Apis::HealthcareV1alpha2::CreateMessageRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3679

def create_message(parent, create_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/messages', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::CreateMessageRequest::Representation
  command.request_object = create_message_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Message
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset(parent, dataset_object = nil, dataset_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Operation

Creates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response which contains a Dataset or Operation.error. The metadata field type is OperationMetadata. A Google Cloud Platform project can contain up to 500 datasets across all regions.

Parameters:

  • parent (String)

    The name of the project in which the dataset should be created (e.g., projects/project_id/locations/location_id``).

  • dataset_object (Google::Apis::HealthcareV1alpha2::Dataset) (defaults to: nil)
  • dataset_id (String)

    The ID of the dataset that is being created. The string must match the following regex: [\pL\pN_\-\.]1,256``.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



150
151
152
153
154
155
156
157
158
159
160
161
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 150

def create_project_location_dataset(parent, dataset_object = nil, dataset_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/datasets', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['datasetId'] = dataset_id unless dataset_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset_annotation_store(parent, annotation_store_object = nil, annotation_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::AnnotationStore

Creates a new Annotation store within the parent dataset.

Parameters:

  • parent (String)

    The name of the dataset this Annotation store belongs to.

  • annotation_store_object (Google::Apis::HealthcareV1alpha2::AnnotationStore) (defaults to: nil)
  • annotation_store_id (String)

    The ID of the Annotation store that is being created. The string must match the following regex: [\pL\pN_\-\.]1,256``.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



484
485
486
487
488
489
490
491
492
493
494
495
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 484

def create_project_location_dataset_annotation_store(parent, annotation_store_object = nil, annotation_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/annotationStores', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
  command.request_object = annotation_store_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore
  command.params['parent'] = parent unless parent.nil?
  command.query['annotationStoreId'] = annotation_store_id unless annotation_store_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset_annotation_store_annotation(parent, annotation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Annotation

Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.

Parameters:

  • parent (String)

    The name of the Annotation store this annotation belongs to. For example, projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/ myannotationstore.

  • annotation_object (Google::Apis::HealthcareV1alpha2::Annotation) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



782
783
784
785
786
787
788
789
790
791
792
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 782

def create_project_location_dataset_annotation_store_annotation(parent, annotation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/annotations', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
  command.request_object = annotation_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Annotation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset_dicom_store(parent, dicom_store_object = nil, dicom_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::DicomStore

Creates a new DICOM store within the parent dataset.

Parameters:

  • parent (String)

    The name of the dataset this DICOM store belongs to.

  • dicom_store_object (Google::Apis::HealthcareV1alpha2::DicomStore) (defaults to: nil)
  • dicom_store_id (String)

    The ID of the DICOM store that is being created. Any string value up to 256 characters in length.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



965
966
967
968
969
970
971
972
973
974
975
976
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 965

def create_project_location_dataset_dicom_store(parent, dicom_store_object = nil, dicom_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomStores', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
  command.request_object = dicom_store_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore
  command.params['parent'] = parent unless parent.nil?
  command.query['dicomStoreId'] = dicom_store_id unless dicom_store_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset_fhir_store(parent, fhir_store_object = nil, fhir_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::FhirStore

Creates a new FHIR store within the parent dataset.

Parameters:

  • parent (String)

    The name of the dataset this FHIR store belongs to.

  • fhir_store_object (Google::Apis::HealthcareV1alpha2::FhirStore) (defaults to: nil)
  • fhir_store_id (String)

    The ID of the FHIR store that is being created. The string must match the following regex: [\pL\pN_\-\.]1,256``.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2139

def create_project_location_dataset_fhir_store(parent, fhir_store_object = nil, fhir_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/fhirStores', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
  command.request_object = fhir_store_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore
  command.params['parent'] = parent unless parent.nil?
  command.query['fhirStoreId'] = fhir_store_id unless fhir_store_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset_fhir_store_fhir(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Creates a FHIR resource. Implements the FHIR standard create interaction, which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction, specified by supplying an If-None-Exist header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • parent (String)

    The name of the FHIR store this resource belongs to.

  • type (String)

    The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index. Must match the resource type in the provided content.

  • http_body_object (Google::Apis::HealthcareV1alpha2::HttpBody) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2943

def create_project_location_dataset_fhir_store_fhir(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir/{+type}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset_hl7_v2_store(parent, hl7_v2_store_object = nil, hl7_v2_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Hl7V2Store

Creates a new HL7v2 store within the parent dataset.

Parameters:

  • parent (String)

    The name of the dataset this HL7v2 store belongs to.

  • hl7_v2_store_object (Google::Apis::HealthcareV1alpha2::Hl7V2Store) (defaults to: nil)
  • hl7_v2_store_id (String)

    The ID of the HL7v2 store that is being created. The string must match the following regex: [\pL\pN_\-\.]1,256``.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3384

def create_project_location_dataset_hl7_v2_store(parent, hl7_v2_store_object = nil, hl7_v2_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/hl7V2Stores', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
  command.request_object = hl7_v2_store_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store
  command.params['parent'] = parent unless parent.nil?
  command.query['hl7V2StoreId'] = hl7_v2_store_id unless hl7_v2_store_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deidentify_dataset(source_dataset, deidentify_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Operation

Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, details field type is DeidentifyErrorDetails.

Parameters:

  • source_dataset (String)

    Source dataset resource name. (e.g., projects/project_id/locations/location_id/datasets/dataset_id``).

  • deidentify_dataset_request_object (Google::Apis::HealthcareV1alpha2::DeidentifyDatasetRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



193
194
195
196
197
198
199
200
201
202
203
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 193

def deidentify_dataset(source_dataset, deidentify_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+sourceDataset}:deidentify', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::DeidentifyDatasetRequest::Representation
  command.request_object = deidentify_dataset_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Operation
  command.params['sourceDataset'] = source_dataset unless source_dataset.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).

Parameters:

  • name (String)

    The name of the dataset to delete (e.g., projects/project_id/locations/location_id/datasets/dataset_id``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



228
229
230
231
232
233
234
235
236
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 228

def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes the specified Annotation store and removes all annotations that are contained within it.

Parameters:

  • name (String)

    The resource name of the Annotation store to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



518
519
520
521
522
523
524
525
526
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 518

def delete_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes an Annotation or returns NOT_FOUND if it does not exist.

Parameters:

  • name (String)

    The resource name of the Annotation to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



815
816
817
818
819
820
821
822
823
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 815

def delete_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes the specified DICOM store and removes all images that are contained within it.

Parameters:

  • name (String)

    The resource name of the DICOM store to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



999
1000
1001
1002
1003
1004
1005
1006
1007
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 999

def delete_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_dicom_store_dicom_web_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the WADO-RS standard.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the DeleteStudy request (e.g., studies/study_id``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1491

def delete_project_location_dataset_dicom_store_dicom_web_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_dicom_store_dicom_web_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the WADO-RS standard.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the DeleteSeries request (e.g., studies/study_id/series/series_id``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1720

def delete_project_location_dataset_dicom_store_dicom_web_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the WADO-RS standard.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the DeleteInstance request (e.g., studies/study_id/series/series_id/instances/instance_id``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1871

def delete_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes the specified FHIR store and removes all resources within it.

Parameters:

  • name (String)

    The resource name of the FHIR store to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2172
2173
2174
2175
2176
2177
2178
2179
2180
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2172

def delete_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Deletes a FHIR resource. Implements the FHIR standard delete interaction. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method.

Parameters:

  • name (String)

    The name of the resource to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2984
2985
2986
2987
2988
2989
2990
2991
2992
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2984

def delete_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes the specified HL7v2 store and removes all messages that are contained within it.

Parameters:

  • name (String)

    The resource name of the HL7v2 store to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3418
3419
3420
3421
3422
3423
3424
3425
3426
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3418

def delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_hl7_v2_store_message(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes an HL7v2 message.

Parameters:

  • name (String)

    The resource name of the HL7v2 message to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3711
3712
3713
3714
3715
3716
3717
3718
3719
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3711

def delete_project_location_dataset_hl7_v2_store_message(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_project_location_dataset_fhir_store_fhir_bundle(parent, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction. Supports all interactions within a bundle, except search. This method accepts Bundles of type batch and transaction, processing them according to the batch processing rules and transaction processing rules. The request body must contain a JSON-encoded FHIR Bundle resource, and the request headers must contain Content-Type: application/fhir+json. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a Bundle resource of type batch-response or transaction-response containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • parent (String)

    Name of the FHIR store in which this bundle will be executed.

  • http_body_object (Google::Apis::HealthcareV1alpha2::HttpBody) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3034

def execute_project_location_dataset_fhir_store_fhir_bundle(parent, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_dicom_store_dicom_data(name, export_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Operation

Exports data to the specified destination by copying it from the DICOM store. The metadata field type is OperationMetadata.

Parameters:

  • name (String)

    The DICOM store resource name from which the data should be exported (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • export_dicom_data_request_object (Google::Apis::HealthcareV1alpha2::ExportDicomDataRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1035

def export_dicom_store_dicom_data(name, export_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+name}:export', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::ExportDicomDataRequest::Representation
  command.request_object = export_dicom_data_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_fhir_store_resources(name, export_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Operation

Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

Parameters:

  • name (String)

    The name of the FHIR store to export resource from. The name should be in the format of projects/project_id/locations/location_id/datasets/dataset_id/ fhirStores/fhir_store_id``.

  • export_resources_request_object (Google::Apis::HealthcareV1alpha2::ExportResourcesRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2216

def export_fhir_store_resources(name, export_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+name}:export', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::ExportResourcesRequest::Representation
  command.request_object = export_resources_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_annotation_store_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission healthcare.AnnotationStores.getIamPolicy on the specified resource

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::HealthcareV1alpha2::GetIamPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



586
587
588
589
590
591
592
593
594
595
596
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 586

def get_annotation_store_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Location

Gets information about a location.

Parameters:

  • name (String)

    Resource name for the location.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



70
71
72
73
74
75
76
77
78
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 70

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Location::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Dataset

Gets any metadata associated with a dataset.

Parameters:

  • name (String)

    The name of the dataset to read (e.g., projects/project_id/locations/location_id/datasets/dataset_id``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



259
260
261
262
263
264
265
266
267
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 259

def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Dataset
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::AnnotationStore

Gets the specified Annotation store or returns NOT_FOUND if it does not exist.

Parameters:

  • name (String)

    The resource name of the Annotation store to get.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



549
550
551
552
553
554
555
556
557
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 549

def get_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Annotation

Gets an Annotation.

Parameters:

  • name (String)

    The resource name of the Annotation to retrieve.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



845
846
847
848
849
850
851
852
853
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 845

def get_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Annotation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::DicomStore

Gets the specified DICOM store.

Parameters:

  • name (String)

    The resource name of the DICOM store to get.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1067
1068
1069
1070
1071
1072
1073
1074
1075
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1067

def get_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_dicom_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum)

    Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1105

def get_project_location_dataset_dicom_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::FhirStore

Gets the configuration of the specified FHIR store.

Parameters:

  • name (String)

    The resource name of the FHIR store to get.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2248
2249
2250
2251
2252
2253
2254
2255
2256
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2248

def get_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_fhir_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum)

    Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2286

def get_project_location_dataset_fhir_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Hl7V2Store

Gets the specified HL7v2 store.

Parameters:

  • name (String)

    The resource name of the HL7v2 store to get.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3448
3449
3450
3451
3452
3453
3454
3455
3456
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3448

def get_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_hl7_v2_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum)

    Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3486

def get_project_location_dataset_hl7_v2_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_hl7_v2_store_message(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Message

Gets an HL7v2 message.

Parameters:

  • name (String)

    The resource name of the HL7v2 message to retrieve.

  • view (String)

    Specifies which parts of the Message resource should be returned in the response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3744

def get_project_location_dataset_hl7_v2_store_message(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Message
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum)

    Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



297
298
299
300
301
302
303
304
305
306
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 297

def get_project_location_dataset_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3945
3946
3947
3948
3949
3950
3951
3952
3953
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3945

def get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#history_project_location_dataset_fhir_store_fhir(name, at: nil, count: nil, page: nil, since: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction. On success, the response body will contain a JSON-encoded representation of a Bundle resource of type history, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • name (String)

    The name of the resource to retrieve.

  • at (String)

    Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following:

    • An entire year: _at=2019
    • An entire month: _at=2019-01
    • A specific day: _at=2019-01-20
    • A specific second: _at=2018-12-31T23:59:58Z
  • count (Fixnum)

    The maximum number of search results on a page. Defaults to 1000.

  • page (String)

    Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the link.url field returned in the response to the previous request, where link.relation is "first", "previous", "next" or "last". Omit page if no previous request has been made.

  • since (String)

    Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3099

def history_project_location_dataset_fhir_store_fhir(name, at: nil, count: nil, page: nil, since: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}/_history', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['at'] = at unless at.nil?
  command.query['count'] = count unless count.nil?
  command.query['page'] = page unless page.nil?
  command.query['since'] = since unless since.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_dicom_store_dicom_data(name, import_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Operation

Imports data into the DICOM store by copying it from the specified source. For errors, the Operation will be populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which will hold finer-grained error information. Errors are also logged to Stackdriver (see Viewing logs). The metadata field type is OperationMetadata.

Parameters:

  • name (String)

    The name of the DICOM store resource into which the data is imported (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • import_dicom_data_request_object (Google::Apis::HealthcareV1alpha2::ImportDicomDataRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1145

def import_dicom_store_dicom_data(name, import_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+name}:import', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::ImportDicomDataRequest::Representation
  command.request_object = import_dicom_data_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_fhir_store_resources(name, import_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Operation

Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the BUNDLE format. When using the BUNDLE format this method ignores the Bundle.type field, except for the special case of history, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in Bundle.entry.resource, ignoring Bundle.entry.request. As an example, this allows the import of searchset bundles produced by a FHIR search or Patient-everything operation. If history imports are enabled by setting enable_history_import in the FHIR store's configuration, this method can import historical versions of a resource by supplying a bundle of type history and using the BUNDLE format. The historical versions in the bundle must have lastUpdated timestamps, and the resulting resource history on the server will appear as if the versions had been created at those timestamps. If a current or historical version with the supplied resource ID already exists, the bundle is rejected to avoid creating an inconsistent sequence of resource versions. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

Parameters:

  • name (String)

    The name of the FHIR store to import FHIR resources to. The name should be in the format of projects/project_id/locations/location_id/datasets/dataset_id/ fhirStores/fhir_store_id``.

  • import_resources_request_object (Google::Apis::HealthcareV1alpha2::ImportResourcesRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2391

def import_fhir_store_resources(name, import_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+name}:import', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::ImportResourcesRequest::Representation
  command.request_object = import_resources_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#ingest_message(parent, ingest_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::IngestMessageResponse

Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned. If an identical HL7v2 message is created twice only one resource is created on the server and no error is reported.

Parameters:

  • parent (String)

    The name of the HL7v2 store this message belongs to.

  • ingest_message_request_object (Google::Apis::HealthcareV1alpha2::IngestMessageRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3780

def ingest_message(parent, ingest_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/messages:ingest', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::IngestMessageRequest::Representation
  command.request_object = ingest_message_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::IngestMessageResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::IngestMessageResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_annotation_store_annotations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse

Lists the Annotations in the given Annotation store for a source resource.

Parameters:

  • parent (String)

    Name of the Annotation store to retrieve Annotations from.

  • filter (String)

    Restricts Annotations returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are:

    • source_version
  • page_size (Fixnum)

    Limit on the number of Annotations to return in a single response. If zero the default page size of 100 is used.

  • page_token (String)

    The next_page_token value returned from the previous List request, if any.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



887
888
889
890
891
892
893
894
895
896
897
898
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 887

def list_project_location_dataset_annotation_store_annotations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/annotations', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_annotation_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse

Lists the Annotation stores in the given dataset for a source store.

Parameters:

  • parent (String)

    Name of the dataset.

  • filter (String)

    Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example labels.key=value.

  • page_size (Fixnum)

    Limit on the number of Annotation stores to return in a single response. If zero the default page size of 100 is used.

  • page_token (String)

    The next_page_token value returned from the previous List request, if any.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



627
628
629
630
631
632
633
634
635
636
637
638
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 627

def list_project_location_dataset_annotation_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/annotationStores', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_dicom_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse

Lists the DICOM stores in the given dataset.

Parameters:

  • parent (String)

    Name of the dataset.

  • filter (String)

    Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example labels.key=value.

  • page_size (Fixnum)

    Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used.

  • page_token (String)

    The next_page_token value returned from the previous List request, if any.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1186

def list_project_location_dataset_dicom_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomStores', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_fhir_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse

Lists the FHIR stores in the given dataset.

Parameters:

  • parent (String)

    Name of the dataset.

  • filter (String)

    Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example labels.key=value.

  • page_size (Fixnum)

    Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used.

  • page_token (String)

    The next_page_token value returned from the previous List request, if any.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2432

def list_project_location_dataset_fhir_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/fhirStores', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_hl7_v2_store_messages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListMessagesResponse

Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter.

Parameters:

  • parent (String)

    Name of the HL7v2 store to retrieve messages from.

  • filter (String)

    Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are:

    • message_type, from the MSH-9 segment; for example NOT message_type = "ADT"
    • send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example send_date < "2017-01-02"
    • send_time, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example send_time < "2017-01-02T00:00:00-05:00"
    • send_facility, the care center that the message came from, from the MSH-4 segment; for example send_facility = "ABC"
    • HL7RegExp(expr), which does regular expression matching of expr against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example HL7RegExp("^.*\|.*\|EMERG")
    • PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example PatientId("123456", "MRN")
    • labels.x, a string value of the label with key x as set using the Message.labels map, for example labels."priority"="high". The operator :* can be used to assert the existence of a label, for example labels."priority":*. Limitations on conjunctions:
    • Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: NOT PatientId("123456", "MRN"), NOT labels."tag1":*, NOT labels."tag2"="val2".
    • Conjunction of multiple patient ID functions is not supported, for example this query is invalid: PatientId("123456", "MRN") AND PatientId("456789", "MRN").
    • Conjunction of multiple labels fields is also not supported, for example this query is invalid: labels."tag1":* AND labels."tag2"="val2".
    • Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT". The HasLabel(x) and Label(x) syntax from previous API versions are deprecated; replaced by the labels.x syntax.
  • order_by (String)

    Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are:

    • send_time
  • page_size (Fixnum)

    Limit on the number of messages to return in a single response. If zero the default page size of 100 is used.

  • page_token (String)

    The next_page_token value returned from the previous List request, if any.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3864

def list_project_location_dataset_hl7_v2_store_messages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/messages', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListMessagesResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListMessagesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_hl7_v2_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse

Lists the HL7v2 stores in the given dataset.

Parameters:

  • parent (String)

    Name of the dataset.

  • filter (String)

    Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example labels.key=value.

  • page_size (Fixnum)

    Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used.

  • page_token (String)

    The next_page_token value returned from the previous List request, if any.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3526

def list_project_location_dataset_hl7_v2_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/hl7V2Stores', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String)

    The standard list filter.

  • page_size (Fixnum)

    The standard list page size.

  • page_token (String)

    The standard list page token.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3989

def list_project_location_dataset_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}/operations', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListOperationsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListDatasetsResponse

Lists the health datasets in the current project.

Parameters:

  • parent (String)

    The name of the project whose datasets should be listed (e.g., projects/project_id/locations/location_id``).

  • page_size (Fixnum)

    The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000.

  • page_token (String)

    The next_page_token value returned from a previous List request, if any.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



334
335
336
337
338
339
340
341
342
343
344
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 334

def list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/datasets', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListDatasetsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListDatasetsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • filter (String)

    The standard list filter.

  • page_size (Fixnum)

    The standard list page size.

  • page_token (String)

    The standard list page token.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



106
107
108
109
110
111
112
113
114
115
116
117
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 106

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}/locations', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::ListLocationsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#metadata_project_location_dataset_dicom_store_dicom_web_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveStudyMetadata DICOMweb request (e.g., studies/study_id/metadata).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1529

def (parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#metadata_project_location_dataset_dicom_store_dicom_web_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveSeriesMetadata DICOMweb request (e.g., studies/study_id/series/series_id/metadata).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1758

def (parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#metadata_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveInstanceMetadata DICOMweb request (e.g., studies/study_id/series/series_id/instances/instance_id/metadata).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1910

def (parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#observation_project_location_dataset_fhir_store_fhir_lastn(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Retrieves the N most recent Observation resources for a subject matching search criteria specified as query parameters, grouped by Observation.code, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn. Search terms are provided as query parameters following the same pattern as the search method. This operation accepts an additional query parameter max, which specifies N, the maximum number of Observations to return from each group, with a default of 1. On success, the response body will contain a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • parent (String)

    Name of the FHIR store to retrieve resources from.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2595
2596
2597
2598
2599
2600
2601
2602
2603
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2595

def observation_project_location_dataset_fhir_store_fhir_lastn(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/fhir/Observation/$lastn', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset(name, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Dataset

Updates dataset metadata.

Parameters:

  • name (String)

    Output only. Resource name of the dataset, of the form projects/project_id/locations/location_id/datasets/dataset_id``.

  • dataset_object (Google::Apis::HealthcareV1alpha2::Dataset) (defaults to: nil)
  • update_mask (String)

    The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



373
374
375
376
377
378
379
380
381
382
383
384
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 373

def patch_project_location_dataset(name, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Dataset
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset_annotation_store(name, annotation_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::AnnotationStore

Updates the specified Annotation store.

Parameters:

  • name (String)

    Output only. Resource name of the Annotation store, of the form projects/project_id/locations/location_id/datasets/dataset_id/ annotationStores/annotation_store_id``.

  • annotation_store_object (Google::Apis::HealthcareV1alpha2::AnnotationStore) (defaults to: nil)
  • update_mask (String)

    The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



668
669
670
671
672
673
674
675
676
677
678
679
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 668

def patch_project_location_dataset_annotation_store(name, annotation_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
  command.request_object = annotation_store_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset_annotation_store_annotation(name, annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Annotation

Updates the Annotation.

Parameters:

  • name (String)

    Output only. Resource name of the Annotation, of the form projects/project_id/locations/location_id/datasets/dataset_id/ annotationStores/annotation_store_id/annotations/annotation_id``.

  • annotation_object (Google::Apis::HealthcareV1alpha2::Annotation) (defaults to: nil)
  • update_mask (String)

    The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



928
929
930
931
932
933
934
935
936
937
938
939
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 928

def patch_project_location_dataset_annotation_store_annotation(name, annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
  command.request_object = annotation_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Annotation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset_dicom_store(name, dicom_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::DicomStore

Updates the specified DICOM store.

Parameters:

  • name (String)

    Output only. Resource name of the DICOM store, of the form projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``.

  • dicom_store_object (Google::Apis::HealthcareV1alpha2::DicomStore) (defaults to: nil)
  • update_mask (String)

    The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1227

def patch_project_location_dataset_dicom_store(name, dicom_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
  command.request_object = dicom_store_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset_fhir_store(name, fhir_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::FhirStore

Updates the configuration of the specified FHIR store.

Parameters:

  • name (String)

    Output only. Resource name of the FHIR store, of the form projects/project_id/datasets/dataset_id/fhirStores/fhir_store_id``.

  • fhir_store_object (Google::Apis::HealthcareV1alpha2::FhirStore) (defaults to: nil)
  • update_mask (String)

    The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2472

def patch_project_location_dataset_fhir_store(name, fhir_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
  command.request_object = fhir_store_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Updates part of an existing resource by applying the operations specified in a JSON Patch document. Implements the FHIR standard patch interaction. The request body must contain a JSON Patch document, and the request headers must contain Content-Type: application/json-patch+json. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • name (String)

    The name of the resource to update.

  • http_body_object (Google::Apis::HealthcareV1alpha2::HttpBody) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3145

def patch_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset_hl7_v2_store(name, hl7_v2_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Hl7V2Store

Updates the HL7v2 store.

Parameters:

  • name (String)

    Output only. Resource name of the HL7v2 store, of the form projects/project_id/datasets/dataset_id/hl7V2Stores/hl7v2_store_id``.

  • hl7_v2_store_object (Google::Apis::HealthcareV1alpha2::Hl7V2Store) (defaults to: nil)
  • update_mask (String)

    The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3566

def patch_project_location_dataset_hl7_v2_store(name, hl7_v2_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
  command.request_object = hl7_v2_store_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset_hl7_v2_store_message(name, message_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Message

Update the message.

Parameters:

  • name (String)

    Resource name of the Message, of the form projects/project_id/datasets/dataset_id/hl7V2Stores/hl7_v2_store_id/ messages/message_id``. Assigned by the server.

  • message_object (Google::Apis::HealthcareV1alpha2::Message) (defaults to: nil)
  • update_mask (String)

    The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask Only the labels field is allowed to be updated. The labels in the request will be merged with the existing set of labels. Existing labels with the same keys will be updated.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3910

def patch_project_location_dataset_hl7_v2_store_message(name, message_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::Message::Representation
  command.request_object = message_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Message
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patient_project_location_dataset_fhir_store_fhir_everything(name, _count: nil, end_: nil, page_token: nil, start: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Retrieves all the resources directly referenced by a patient, as well as all of the resources in the patient compartment. Implements the FHIR extended operation Patient-everything. On success, the response body will contain a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • name (String)

    Name of the Patient resource for which the information is required.

  • _count (Fixnum)

    Maximum number of resources in a page. Defaults to 100.

  • end_ (String)

    The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope.

  • page_token (String)

    Used to retrieve the next or previous page of results when using pagination. Value should be set to the value of page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where link.relation is "previous" or "next". Omit page_token if no previous request has been made.

  • start (String)

    The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2651

def patient_project_location_dataset_fhir_store_fhir_everything(name, _count: nil, end_: nil, page_token: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}/$everything', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['_count'] = _count unless _count.nil?
  command.query['end'] = end_ unless end_.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['start'] = start unless start.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Gets the contents of a FHIR resource. Implements the FHIR standard read interaction. Also supports the FHIR standard conditional read interaction specified by supplying an If-Modified-Since header with a date/time value or an If-None-Match header with an ETag value. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • name (String)

    The name of the resource to retrieve.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3189
3190
3191
3192
3193
3194
3195
3196
3197
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3189

def read_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rendered_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveRenderedInstance DICOMweb request (e.g., studies/study_id/series/series_id/instances/instance_id/rendered).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1948

def rendered_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rendered_project_location_dataset_dicom_store_dicom_web_study_series_instance_frame(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveRenderedFrames DICOMweb request (e.g., studies/study_id/series/series_id/instances/instance_id/frames/ frame_list/rendered).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2026

def rendered_project_location_dataset_dicom_store_dicom_web_study_series_instance_frame(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resource_project_location_dataset_fhir_store_fhir_purge(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Empty

Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation.

Parameters:

  • name (String)

    The name of the resource to purge.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2688

def resource_project_location_dataset_fhir_store_fhir_purge(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}/$purge', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retrieve_project_location_dataset_dicom_store_dicom_web_study_series_instance_frame_frames(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveFrames DICOMweb request (e.g., studies/study_id/series/series_id/instances/instance_id/frames/ frame_list``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2065

def retrieve_project_location_dataset_dicom_store_dicom_web_study_series_instance_frame_frames(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retrieve_project_location_dataset_dicom_store_dicom_web_study_series_instance_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveInstance DICOMweb request (e.g., studies/study_id/series/series_id/instances/instance_id``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1986

def retrieve_project_location_dataset_dicom_store_dicom_web_study_series_instance_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retrieve_project_location_dataset_dicom_store_dicom_web_study_series_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveSeries DICOMweb request (e.g., studies/study_id/series/series_id``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1795

def retrieve_project_location_dataset_dicom_store_dicom_web_study_series_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retrieve_project_location_dataset_dicom_store_dicom_web_study_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the RetrieveStudy DICOMweb request (e.g., studies/study_id``).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1566

def retrieve_project_location_dataset_dicom_store_dicom_web_study_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_fhir_resources(parent, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction using the search semantics described in the FHIR Search specification. Supports three methods of search defined by the specification:

  • GET [base]?[parameters] to search across all resources.
  • GET [base]/[type]?[parameters] to search resources of a specified type.
  • POST [base]/[type]/_search?[parameters] as an alternate form having the same semantics as the GET method. The GET methods do not support compartment searches. The POST method does not support application/x-www-form-urlencoded search parameters. On success, the response body will contain a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry. Supported search modifiers: :missing, :exact, :contains, :text, :in, :not-in, :above, :below, :[type], :not, and :recurse. Supported search result parameters: _sort, _count, _include, _revinclude, _summary=text, _summary=data, and _elements. The maximum number of search results returned defaults to 100, which can be overridden by the _count parameter up to a maximum limit of 1000. If there are additional results, the returned Bundle will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results.

Parameters:

  • parent (String)

    Name of the FHIR store to retrieve resources from.

  • search_resources_request_object (Google::Apis::HealthcareV1alpha2::SearchResourcesRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3260

def search_fhir_resources(parent, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir/_search', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::SearchResourcesRequest::Representation
  command.request_object = search_resources_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_dataset_dicom_store_dicom_web_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the SearchForInstancesRequest DICOMweb request (e.g., instances or series/series_uid/instances or studies/study_uid/instances).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1341

def search_project_location_dataset_dicom_store_dicom_web_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_dataset_dicom_store_dicom_web_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the SearchForSeries DICOMweb request(e.g., series or studies/study_uid/series).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1378

def search_project_location_dataset_dicom_store_dicom_web_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_dataset_dicom_store_dicom_web_for_studies(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the SearchForStudies DICOMweb request (e.g., studies).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1414

def search_project_location_dataset_dicom_store_dicom_web_for_studies(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_dataset_dicom_store_dicom_web_study_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the SearchForInstancesRequest DICOMweb request (e.g., instances or series/series_uid/instances or studies/study_uid/instances).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1604

def search_project_location_dataset_dicom_store_dicom_web_study_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_dataset_dicom_store_dicom_web_study_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the SearchForSeries DICOMweb request(e.g., series or studies/study_uid/series).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1641

def search_project_location_dataset_dicom_store_dicom_web_study_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_dataset_dicom_store_dicom_web_study_series_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the SearchForInstancesRequest DICOMweb request (e.g., instances or series/series_uid/instances or studies/study_uid/instances).

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1833

def search_project_location_dataset_dicom_store_dicom_web_study_series_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_annotation_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

POLICIES Sets the access control policy for a resource. Replaces any existing policy. Authorization requires the Google IAM permission healthcare.annotationStores.setIamPolicy on the specified resource

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



708
709
710
711
712
713
714
715
716
717
718
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 708

def set_annotation_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



409
410
411
412
413
414
415
416
417
418
419
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 409

def set_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_dicom_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1263

def set_dicom_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_fhir_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2508

def set_fhir_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_hl7_v2_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3602

def set_hl7_v2_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#store_project_location_dataset_dicom_store_dicom_web_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the StoreInstances DICOMweb request (e.g., studies/[study_id]). Note that the study_uid is optional.

  • http_body_object (Google::Apis::HealthcareV1alpha2::HttpBody) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1453

def store_project_location_dataset_dicom_store_dicom_web_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#store_project_location_dataset_dicom_store_dicom_web_study_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.

Parameters:

  • parent (String)

    The name of the DICOM store that is being accessed (e.g., projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``).

  • dicom_web_path (String)

    The path of the StoreInstances DICOMweb request (e.g., studies/[study_id]). Note that the study_uid is optional.

  • http_body_object (Google::Apis::HealthcareV1alpha2::HttpBody) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1680

def store_project_location_dataset_dicom_store_dicom_web_study_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_annotation_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. There is no permission required to make this API call.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



745
746
747
748
749
750
751
752
753
754
755
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 745

def test_annotation_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



448
449
450
451
452
453
454
455
456
457
458
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 448

def test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_dicom_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 1302

def test_dicom_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_fhir_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 2547

def test_fhir_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_hl7_v2_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3641

def test_hl7_v2_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Updates the entire contents of a resource. Implements the FHIR standard update interaction. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. The resource must contain an id element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • name (String)

    The name of the resource to update.

  • http_body_object (Google::Apis::HealthcareV1alpha2::HttpBody) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3309

def update_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#vread_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1alpha2::HttpBody

Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Parameters:

  • name (String)

    The name of the resource version to retrieve.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3350
3351
3352
3353
3354
3355
3356
3357
3358
# File 'generated/google/apis/healthcare_v1alpha2/service.rb', line 3350

def vread_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end