Class: Google::Apis::HealthcareV1beta1::CloudHealthcareService

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

Overview

Cloud Healthcare API

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

Examples:

require 'google/apis/healthcare_v1beta1'

Healthcare = Google::Apis::HealthcareV1beta1 # 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

#initialize ⇒ CloudHealthcareService

Returns a new instance of CloudHealthcareService



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

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

Instance Attribute Details

#key ⇒ String

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_v1beta1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

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_v1beta1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#capabilities_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



2207
2208
2209
2210
2211
2212
2213
2214
2215
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2207

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

#conditional_project_location_dataset_fhir_store_fhir_delete(parent, type, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2253

def conditional_project_location_dataset_fhir_store_fhir_delete(parent, type, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+parent}/fhir/{+type}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2305

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, 'v1beta1/{+parent}/fhir/{+type}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2367

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, 'v1beta1/{+parent}/fhir/{+type}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3159

def create_message(parent, create_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/messages', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::CreateMessageRequest::Representation
  command.request_object = create_message_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Message::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/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, 'v1beta1/{+parent}/datasets', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_dicom_store(parent, dicom_store_object = nil, dicom_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



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

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, 'v1beta1/{+parent}/dicomStores', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::DicomStore::Representation
  command.request_object = dicom_store_object
  command.response_representation = Google::Apis::HealthcareV1beta1::DicomStore::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1619

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, 'v1beta1/{+parent}/fhirStores', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::FhirStore::Representation
  command.request_object = fhir_store_object
  command.response_representation = Google::Apis::HealthcareV1beta1::FhirStore::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2423

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, 'v1beta1/{+parent}/fhir/{+type}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2864

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, 'v1beta1/{+parent}/hl7V2Stores', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::Hl7V2Store::Representation
  command.request_object = hl7_v2_store_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Hl7V2Store::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/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, 'v1beta1/{+sourceDataset}:deidentify', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::DeidentifyDatasetRequest::Representation
  command.request_object = deidentify_dataset_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/service.rb', line 228

def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



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

def delete_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1010

def delete_project_location_dataset_dicom_store_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1239

def delete_project_location_dataset_dicom_store_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1390

def delete_project_location_dataset_dicom_store_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1652

def delete_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2464

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

#delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



2898
2899
2900
2901
2902
2903
2904
2905
2906
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2898

def delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



3191
3192
3193
3194
3195
3196
3197
3198
3199
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3191

def delete_project_location_dataset_hl7_v2_store_message(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2514

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, 'v1beta1/{+parent}/fhir', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



554
555
556
557
558
559
560
561
562
563
564
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 554

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, 'v1beta1/{+name}:export', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::ExportDicomDataRequest::Representation
  command.request_object = export_dicom_data_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_fhir_store_resources(name, export_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1696

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

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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_v1beta1/service.rb', line 70

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Location::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/service.rb', line 259

def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Dataset::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_dicom_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



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

def get_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::DicomStore::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



624
625
626
627
628
629
630
631
632
633
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 624

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



1728
1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1728

def get_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::FhirStore::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1766

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



2928
2929
2930
2931
2932
2933
2934
2935
2936
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2928

def get_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Hl7V2Store::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2966

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3224

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, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Message::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



3423
3424
3425
3426
3427
3428
3429
3430
3431
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3423

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

#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::HealthcareV1beta1::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:



2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2579

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, 'v1beta1/{+name}/_history', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['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::HealthcareV1beta1::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::HealthcareV1beta1::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:



664
665
666
667
668
669
670
671
672
673
674
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 664

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, 'v1beta1/{+name}:import', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::ImportDicomDataRequest::Representation
  command.request_object = import_dicom_data_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_fhir_store_resources(name, import_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



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

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

#ingest_message(parent, ingest_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



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

def ingest_message(parent, ingest_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/messages:ingest', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::IngestMessageRequest::Representation
  command.request_object = ingest_message_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::IngestMessageResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_dicom_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 705

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, 'v1beta1/{+parent}/dicomStores', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::ListDicomStoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1912

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, 'v1beta1/{+parent}/fhirStores', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::ListFhirStoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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".
  • 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:



3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3342

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, 'v1beta1/{+parent}/messages', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::ListMessagesResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3006

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, 'v1beta1/{+parent}/hl7V2Stores', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::ListHl7V2StoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3467

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/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, 'v1beta1/{+parent}/datasets', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::ListDatasetsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/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, 'v1beta1/{+name}/locations', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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

#observation_project_location_dataset_fhir_store_fhir_lastn(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



2075
2076
2077
2078
2079
2080
2081
2082
2083
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2075

def observation_project_location_dataset_fhir_store_fhir_lastn(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/fhir/Observation/$lastn', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Dataset::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_dicom_store(name, dicom_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



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

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::DicomStore::Representation
  command.request_object = dicom_store_object
  command.response_representation = Google::Apis::HealthcareV1beta1::DicomStore::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1952

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::FhirStore::Representation
  command.request_object = fhir_store_object
  command.response_representation = Google::Apis::HealthcareV1beta1::FhirStore::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2625

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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::HealthcareV1beta1::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::HealthcareV1beta1::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:



3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3046

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::Hl7V2Store::Representation
  command.request_object = hl7_v2_store_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Hl7V2Store::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3388

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::Message::Representation
  command.request_object = message_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Message::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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' urls. Next and previous page are returned in the response bundle's links field, where link.relation is "previous" or "next". Omit page_token if no previous request has been made.

  • 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:



2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2131

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, 'v1beta1/{+name}/$everything', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['_count'] = _count unless _count.nil?
  command.query['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::HealthcareV1beta1::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:



2669
2670
2671
2672
2673
2674
2675
2676
2677
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2669

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

#resource_project_location_dataset_fhir_store_fhir_purge(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



2168
2169
2170
2171
2172
2173
2174
2175
2176
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2168

def resource_project_location_dataset_fhir_store_fhir_purge(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}/$purge', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1048

def retrieve_project_location_dataset_dicom_store_study_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_instance_frame_frames(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1544

def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_frames(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_instance_frame_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1584

def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_instance_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1428

def retrieve_project_location_dataset_dicom_store_study_series_instance_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_instance_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1467

def retrieve_project_location_dataset_dicom_store_study_series_instance_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_instance_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1505

def retrieve_project_location_dataset_dicom_store_study_series_instance_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1277

def retrieve_project_location_dataset_dicom_store_study_series_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1314

def retrieve_project_location_dataset_dicom_store_study_series_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1085

def retrieve_project_location_dataset_dicom_store_study_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2740

def search_fhir_resources(parent, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/fhir/_search', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::SearchResourcesRequest::Representation
  command.request_object = search_resources_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



786
787
788
789
790
791
792
793
794
795
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 786

def search_project_location_dataset_dicom_store_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



823
824
825
826
827
828
829
830
831
832
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 823

def search_project_location_dataset_dicom_store_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_for_studies(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



859
860
861
862
863
864
865
866
867
868
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 859

def search_project_location_dataset_dicom_store_for_studies(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1123

def search_project_location_dataset_dicom_store_study_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1160

def search_project_location_dataset_dicom_store_study_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_series_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1352

def search_project_location_dataset_dicom_store_study_series_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



893
894
895
896
897
898
899
900
901
902
903
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 893

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1988

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3082

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 933

def store_project_location_dataset_dicom_store_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_study_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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:



1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 1199

def store_project_location_dataset_dicom_store_study_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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_v1beta1/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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



973
974
975
976
977
978
979
980
981
982
983
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 973

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



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

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 3121

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::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::HealthcareV1beta1::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::HealthcareV1beta1::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:



2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2789

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1beta1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#vread_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1beta1::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:



2830
2831
2832
2833
2834
2835
2836
2837
2838
 
# File 'generated/google/apis/healthcare_v1beta1/service.rb', line 2830

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