Class: Google::Apis::HealthcareV1::CloudHealthcareService

Inherits:

Core::BaseService

• Object
• Core::BaseService
• Google::Apis::HealthcareV1::CloudHealthcareService

Defined in:

lib/google/apis/healthcare_v1/service.rb

Overview

Cloud Healthcare API

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

Examples:

require 'google/apis/healthcare_v1'

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

See Also:

• https://cloud.google.com/healthcare

Instance Attribute Summary

• #key ⇒ String

  API key.

• #quota_user ⇒ String

  Available to use for quota purposes for server-side applications.

Instance Method Summary

• #activate_consent(name, activate_consent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

  Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE.

• #archive_user_data_mapping(name, archive_user_data_mapping_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse

  Archives the specified User data mapping.

• #cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Empty

  Starts asynchronous cancellation on a long-running operation.

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

  Gets the FHIR capability statement (STU3, R4), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server.

• #check_consent_store_data_access(consent_store, check_data_access_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::CheckDataAccessResponse

  Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.

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

  Parses and stores an HL7v2 message.

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

  Creates a new health dataset.

• #create_project_location_dataset_consent_store(parent, consent_store_object = nil, consent_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentStore

  Creates a new consent store in the parent dataset.

• #create_project_location_dataset_consent_store_attribute_definition(parent, attribute_definition_object = nil, attribute_definition_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::AttributeDefinition

  Creates a new Attribute definition in the parent consent store.

• #create_project_location_dataset_consent_store_consent(parent, consent_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

  Creates a new Consent in the parent consent store.

• #create_project_location_dataset_consent_store_consent_artifact(parent, consent_artifact_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentArtifact

  Creates a new Consent artifact in the parent consent store.

• #create_project_location_dataset_consent_store_user_data_mapping(parent, user_data_mapping_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::UserDataMapping

  Creates a new User data mapping in the parent consent store.

• #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::HealthcareV1::DicomStore

  Creates a new DICOM store within the parent dataset.

• #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::HealthcareV1::FhirStore

  Creates a new FHIR store within the parent dataset.

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

  Creates a FHIR resource.

• #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::HealthcareV1::Hl7V2Store

  Creates a new HL7v2 store within the parent dataset.

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

  Creates a new dataset containing de-identified data from the source dataset.

• #deidentify_dicom_store(source_store, deidentify_dicom_store_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation

  De-identifies data from the source store and writes it to the destination store.

• #deidentify_fhir_store(source_store, deidentify_fhir_store_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation

  De-identifies data from the source store and writes it to the destination store.

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

  Deletes the specified health dataset and all data contained in the dataset.

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

  Deletes the specified consent store and removes all the consent store's data.

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

  Deletes the specified Attribute definition.

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

  Deletes the Consent and its revisions.

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

  Deletes the specified Consent artifact.

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

  Deletes the specified revision of a Consent.

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

  Deletes the specified User data mapping.

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

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

• #delete_project_location_dataset_dicom_store_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation

  DeleteStudy deletes all instances within the given study.

• #delete_project_location_dataset_dicom_store_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation

  DeleteSeries deletes all instances within the given study and series.

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

  DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID.

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

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

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

  Deletes a FHIR resource.

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

  Deletes the specified HL7v2 store and removes all messages that it contains.

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

  Deletes an HL7v2 message.

• #evaluate_consent_store_user_consents(consent_store, evaluate_user_consents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::EvaluateUserConsentsResponse

  Evaluates the user's Consents for all matching User data mappings.

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

  Executes all the requests in the given Bundle.

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

  Exports data to the specified destination by copying it from the DICOM store.

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

  Export resources from the FHIR store to the specified destination.

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

  Gets information about a location.

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

  Gets any metadata associated with a dataset.

• #get_project_location_dataset_consent_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentStore

  Gets the specified consent store.

• #get_project_location_dataset_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::AttributeDefinition

  Gets the specified Attribute definition.

• #get_project_location_dataset_consent_store_consent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

  Gets the specified revision of a Consent, or the latest revision if revision_id is not specified in the resource name.

• #get_project_location_dataset_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentArtifact

  Gets the specified Consent artifact.

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

  Gets the access control policy for a resource.

• #get_project_location_dataset_consent_store_user_data_mapping(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::UserDataMapping

  Gets the specified User data mapping.

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

  Gets the specified DICOM store.

• #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::HealthcareV1::Policy

  Gets the access control policy for a resource.

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

  Gets the configuration of the specified FHIR store.

• #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::HealthcareV1::Policy

  Gets the access control policy for a resource.

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

  Gets the specified HL7v2 store.

• #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::HealthcareV1::Policy

  Gets the access control policy for a resource.

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

  Gets an HL7v2 message.

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

  Gets the access control policy for a resource.

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

  Gets the latest state of a long-running operation.

• #history_project_location_dataset_fhir_store_fhir(name, _at: nil, _count: nil, _page_token: nil, _since: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::HttpBody

  Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store.

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

  Imports data into the DICOM store by copying it from the specified source.

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

  Imports resources to the FHIR store by loading data from the specified sources.

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

  Parses and stores an HL7v2 message.

• #initialize ⇒ CloudHealthcareService constructor

  A new instance of CloudHealthcareService.

• #list_project_location_dataset_consent_store_attribute_definitions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse

  Lists the Attribute definitions in the specified consent store.

• #list_project_location_dataset_consent_store_consent_artifacts(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListConsentArtifactsResponse

  Lists the Consent artifacts in the specified consent store.

• #list_project_location_dataset_consent_store_consent_revisions(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListConsentRevisionsResponse

  Lists the revisions of the specified Consent in reverse chronological order.

• #list_project_location_dataset_consent_store_consents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListConsentsResponse

  Lists the Consent in the given consent store, returning each Consent's latest revision.

• #list_project_location_dataset_consent_store_user_data_mappings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListUserDataMappingsResponse

  Lists the User data mappings in the specified consent store.

• #list_project_location_dataset_consent_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListConsentStoresResponse

  Lists the consent stores in the specified dataset.

• #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::HealthcareV1::ListDicomStoresResponse

  Lists the DICOM stores in the given dataset.

• #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::HealthcareV1::ListFhirStoresResponse

  Lists the FHIR stores in the given dataset.

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

  Lists all the messages in the given HL7v2 store with support for filtering.

• #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::HealthcareV1::ListHl7V2StoresResponse

  Lists the HL7v2 stores in the given dataset.

• #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::HealthcareV1::ListOperationsResponse

  Lists operations that match the specified filter in the request.

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

  Lists the health datasets in the current project.

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

  Lists information about the supported locations for this service.

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

  Updates dataset metadata.

• #patch_project_location_dataset_consent_store(name, consent_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentStore

  Updates the specified consent store.

• #patch_project_location_dataset_consent_store_attribute_definition(name, attribute_definition_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::AttributeDefinition

  Updates the specified Attribute definition.

• #patch_project_location_dataset_consent_store_consent(name, consent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

  Updates the latest revision of the specified Consent by committing a new revision with the changes.

• #patch_project_location_dataset_consent_store_user_data_mapping(name, user_data_mapping_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::UserDataMapping

  Updates the specified User data mapping.

• #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::HealthcareV1::DicomStore

  Updates the specified DICOM store.

• #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::HealthcareV1::FhirStore

  Updates the configuration of the specified FHIR store.

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

  Updates part of an existing resource by applying the operations specified in a JSON Patch document.

• #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::HealthcareV1::Hl7V2Store

  Updates the HL7v2 store.

• #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::HealthcareV1::Message

  Update the message.

• #patient_project_location_dataset_fhir_store_fhir_everything(name, _count: nil, _page_token: nil, _since: nil, _type: nil, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::HttpBody

  Retrieves a Patient resource and resources related to that patient.

• #query_consent_store_accessible_data(consent_store, query_accessible_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation

  Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination.

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

  Gets the contents of a FHIR resource.

• #reject_consent(name, reject_consent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

  Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED.

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

  Deletes all the historical versions of a resource (excluding the current version) from the FHIR store.

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

  RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed.

• #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::HealthcareV1::HttpBody

  RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers.

• #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::HealthcareV1::HttpBody

  RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type.

• #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::HealthcareV1::HttpBody

  RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID.

• #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::HealthcareV1::HttpBody

  RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed.

• #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::HealthcareV1::HttpBody

  RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type.

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

  RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed.

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

  RetrieveSeries returns all instances within the given study and series.

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

  RetrieveStudy returns all instances within the given study.

• #revoke_consent(name, revoke_consent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

  Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED.

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

  Searches for resources in the given FHIR store according to criteria specified as query parameters.

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

  SearchForInstances returns a list of matching instances.

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

  SearchForSeries returns a list of matching series.

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

  SearchForStudies returns a list of matching studies.

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

  SearchForInstances returns a list of matching instances.

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

  SearchForSeries returns a list of matching series.

• #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::HealthcareV1::HttpBody

  SearchForInstances returns a list of matching instances.

• #search_project_location_dataset_fhir_store_fhir_type(parent, resource_type, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::HttpBody

  Searches for resources in the given FHIR store according to criteria specified as query parameters.

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

  Sets the access control policy on the specified resource.

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

  Sets the access control policy on the specified resource.

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

  Sets the access control policy on the specified resource.

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

  Sets the access control policy on the specified resource.

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

  Sets the access control policy on the specified resource.

• #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::HealthcareV1::HttpBody

  StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID).

• #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::HealthcareV1::HttpBody

  StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID).

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

  Returns permissions that a caller has on the specified resource.

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

  Returns permissions that a caller has on the specified resource.

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

  Returns permissions that a caller has on the specified resource.

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

  Returns permissions that a caller has on the specified resource.

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

  Returns permissions that a caller has on the specified resource.

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

  Updates the entire contents of a resource.

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

  Gets the contents of a version (current or historical) of a FHIR resource by version ID.

Constructor Details

#initialize ⇒ CloudHealthcareService

Returns a new instance of CloudHealthcareService.

# File 'lib/google/apis/healthcare_v1/service.rb', line 45

def initialize
  super('https://healthcare.googleapis.com/', '',
        client_name: 'google-apis-healthcare_v1',
        client_version: Google::Apis::HealthcareV1::GEM_VERSION)
  @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.

# File 'lib/google/apis/healthcare_v1/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.

# File 'lib/google/apis/healthcare_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#activate_consent(name, activate_consent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. If the latest revision of the specified Consent is in the ACTIVE state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the REJECTED or REVOKED state.

Parameters:

• name (String) —

  Required. The resource name of the Consent to activate, of the form projects/ project_id/locations/location_id/datasets/dataset_id/consentStores/ consent_store_id/consents/consent_id`. An INVALID_ARGUMENT error occurs if revision_id` is specified in the name.

• activate_consent_request_object (Google::Apis::HealthcareV1::ActivateConsentRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Consent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Consent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1257

def activate_consent(name, activate_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:activate', options)
  command.request_representation = Google::Apis::HealthcareV1::ActivateConsentRequest::Representation
  command.request_object = activate_consent_request_object
  command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
  command.response_class = Google::Apis::HealthcareV1::Consent
  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

#archive_user_data_mapping(name, archive_user_data_mapping_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse

Archives the specified User data mapping.

Parameters:

• name (String) —

  Required. The resource name of the User data mapping to archive.

• archive_user_data_mapping_request_object (Google::Apis::HealthcareV1::ArchiveUserDataMappingRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1681

def archive_user_data_mapping(name, archive_user_data_mapping_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:archive', options)
  command.request_representation = Google::Apis::HealthcareV1::ArchiveUserDataMappingRequest::Representation
  command.request_object = archive_user_data_mapping_request_object
  command.response_representation = Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse
  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

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

• name (String) —

  The name of the operation resource to be cancelled.

• cancel_operation_request_object (Google::Apis::HealthcareV1::CancelOperationRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4994

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::HealthcareV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1::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

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

Gets the FHIR capability statement (STU3, R4), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction (STU3, R4), or the conformance interaction in the DSTU2 case. 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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3813

def capabilities_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/fhir/metadata', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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

#check_consent_store_data_access(consent_store, check_data_access_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::CheckDataAccessResponse

Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.

Parameters:

• consent_store (String) —

  Required. Name of the consent store where the requested data_id is stored, of the form projects/project_id/locations/location_id/datasets/dataset_id/ consentStores/consent_store_id``.

• check_data_access_request_object (Google::Apis::HealthcareV1::CheckDataAccessRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::CheckDataAccessResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::CheckDataAccessResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 482

def check_consent_store_data_access(consent_store, check_data_access_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+consentStore}:checkDataAccess', options)
  command.request_representation = Google::Apis::HealthcareV1::CheckDataAccessRequest::Representation
  command.request_object = check_data_access_request_object
  command.response_representation = Google::Apis::HealthcareV1::CheckDataAccessResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::CheckDataAccessResponse
  command.params['consentStore'] = consent_store unless consent_store.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::HealthcareV1::Message

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Cloud Pub/Sub topic configured in projects.locations. datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received.

Parameters:

• parent (String) —

  The name of the dataset this message belongs to.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Message) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Message)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4715

def create_message(parent, create_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/messages', options)
  command.request_representation = Google::Apis::HealthcareV1::CreateMessageRequest::Representation
  command.request_object = create_message_request_object
  command.response_representation = Google::Apis::HealthcareV1::Message::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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.

Parameters:

• parent (String) —

  The name of the project where the server creates the dataset. For example, projects/project_id/locations/location_id``.

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

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 148

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, 'v1/{+parent}/datasets', options)
  command.request_representation = Google::Apis::HealthcareV1::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store(parent, consent_store_object = nil, consent_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentStore

Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error.

Parameters:

• parent (String) —

  Required. The name of the dataset this consent store belongs to.

• consent_store_object (Google::Apis::HealthcareV1::ConsentStore) (defaults to: nil)
• consent_store_id (String) (defaults to: nil) —

  Required. The ID of the consent store to create. The string must match the following regex: [\pL\pN_\-\.]1,256``. Cannot be changed after creation.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ConsentStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ConsentStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 520

def create_project_location_dataset_consent_store(parent, consent_store_object = nil, consent_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/consentStores', options)
  command.request_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
  command.request_object = consent_store_object
  command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
  command.response_class = Google::Apis::HealthcareV1::ConsentStore
  command.params['parent'] = parent unless parent.nil?
  command.query['consentStoreId'] = consent_store_id unless consent_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_consent_store_attribute_definition(parent, attribute_definition_object = nil, attribute_definition_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::AttributeDefinition

Creates a new Attribute definition in the parent consent store.

Parameters:

• parent (String) —

  Required. The name of the consent store that this Attribute definition belongs to.

• attribute_definition_object (Google::Apis::HealthcareV1::AttributeDefinition) (defaults to: nil)
• attribute_definition_id (String) (defaults to: nil) —

  Required. The ID of the Attribute definition to create. The string must match the following regex: _a-zA-Z0,255`` and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/ cel-spec/blob/master/doc/langdef.md.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::AttributeDefinition) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::AttributeDefinition)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 906

def create_project_location_dataset_consent_store_attribute_definition(parent, attribute_definition_object = nil, attribute_definition_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/attributeDefinitions', options)
  command.request_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
  command.request_object = attribute_definition_object
  command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
  command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
  command.params['parent'] = parent unless parent.nil?
  command.query['attributeDefinitionId'] = attribute_definition_id unless attribute_definition_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_consent_store_consent(parent, consent_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

Creates a new Consent in the parent consent store.

Parameters:

• parent (String) —

  Required. Name of the consent store.

• consent_object (Google::Apis::HealthcareV1::Consent) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Consent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Consent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1290

def create_project_location_dataset_consent_store_consent(parent, consent_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/consents', options)
  command.request_representation = Google::Apis::HealthcareV1::Consent::Representation
  command.request_object = consent_object
  command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
  command.response_class = Google::Apis::HealthcareV1::Consent
  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_consent_store_consent_artifact(parent, consent_artifact_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentArtifact

Creates a new Consent artifact in the parent consent store.

Parameters:

• parent (String) —

  Required. The name of the consent store this Consent artifact belongs to.

• consent_artifact_object (Google::Apis::HealthcareV1::ConsentArtifact) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ConsentArtifact) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ConsentArtifact)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1090

def create_project_location_dataset_consent_store_consent_artifact(parent, consent_artifact_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/consentArtifacts', options)
  command.request_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
  command.request_object = consent_artifact_object
  command.response_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
  command.response_class = Google::Apis::HealthcareV1::ConsentArtifact
  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_consent_store_user_data_mapping(parent, user_data_mapping_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::UserDataMapping

Creates a new User data mapping in the parent consent store.

Parameters:

• parent (String) —

  Required. Name of the consent store.

• user_data_mapping_object (Google::Apis::HealthcareV1::UserDataMapping) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::UserDataMapping) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::UserDataMapping)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1714

def create_project_location_dataset_consent_store_user_data_mapping(parent, user_data_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userDataMappings', options)
  command.request_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
  command.request_object = user_data_mapping_object
  command.response_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
  command.response_class = Google::Apis::HealthcareV1::UserDataMapping
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset_dicom_store(parent, dicom_store_object = nil, dicom_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::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::HealthcareV1::DicomStore) (defaults to: nil)
• dicom_store_id (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::DicomStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::DicomStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1914

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, 'v1/{+parent}/dicomStores', options)
  command.request_representation = Google::Apis::HealthcareV1::DicomStore::Representation
  command.request_object = dicom_store_object
  command.response_representation = Google::Apis::HealthcareV1::DicomStore::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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::HealthcareV1::FhirStore) (defaults to: nil)
• fhir_store_id (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::FhirStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::FhirStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3215

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

Creates a FHIR resource. Implements the FHIR standard create interaction ( DSTU2, STU3, R4), which creates a new resource with a server-assigned resource ID. 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. For samples that show how to call create, see Creating a FHIR resource.

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 (DSTU2, STU3, R4). Must match the resource type in the provided content.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3864

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, 'v1/{+parent}/fhir/{+type}', options)
  command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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::HealthcareV1::Hl7V2Store) (defaults to: nil)
• hl7_v2_store_id (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Hl7V2Store) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Hl7V2Store)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4402

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, 'v1/{+parent}/hl7V2Stores', options)
  command.request_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation
  command.request_object = hl7_v2_store_object
  command.response_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see Viewing logs.

Parameters:

• source_dataset (String) —

  Source dataset resource name. For example, projects/project_id/locations/ location_id/datasets/dataset_id``.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 190

def deidentify_dataset(source_dataset, deidentify_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+sourceDataset}:deidentify', options)
  command.request_representation = Google::Apis::HealthcareV1::DeidentifyDatasetRequest::Representation
  command.request_object = deidentify_dataset_request_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::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

#deidentify_dicom_store(source_store, deidentify_dicom_store_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation

De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de- identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see Viewing logs).

Parameters:

• source_store (String) —

  Source DICOM store resource name. For example, projects/project_id/ locations/location_id/datasets/dataset_id/dicomStores/dicom_store_id``.

• deidentify_dicom_store_request_object (Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1956

def deidentify_dicom_store(source_store, deidentify_dicom_store_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+sourceStore}:deidentify', options)
  command.request_representation = Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest::Representation
  command.request_object = deidentify_dicom_store_request_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::Operation
  command.params['sourceStore'] = source_store unless source_store.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_fhir_store(source_store, deidentify_fhir_store_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation

De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see Viewing logs).

Parameters:

• source_store (String) —

  Source FHIR store resource name. For example, projects/project_id/locations/ location_id/datasets/dataset_id/fhirStores/fhir_store_id``.

• deidentify_fhir_store_request_object (Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3254

def deidentify_fhir_store(source_store, deidentify_fhir_store_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+sourceStore}:deidentify', options)
  command.request_representation = Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest::Representation
  command.request_object = deidentify_fhir_store_request_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::Operation
  command.params['sourceStore'] = source_store unless source_store.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::HealthcareV1::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. For example, projects/project_id/ locations/location_id/datasets/dataset_id``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 225

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

Deletes the specified consent store and removes all the consent store's data.

Parameters:

• name (String) —

  Required. The resource name of the consent store to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 553

def delete_project_location_dataset_consent_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Empty

Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.

Parameters:

• name (String) —

  Required. The resource name of the Attribute definition to delete. To preserve referential integrity, Attribute definitions referenced by a User data mapping or the latest revision of a Consent cannot be deleted.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 942

def delete_project_location_dataset_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store_consent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Empty

Deletes the Consent and its revisions. To keep a record of the Consent but mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [ DeleteConsentRevision]. This operation does not delete the related Consent artifact.

Parameters:

• name (String) —

  Required. The resource name of the Consent to delete, of the form projects/ project_id/locations/location_id/datasets/dataset_id/consentStores/ consent_store_id/consents/consent_id`. An INVALID_ARGUMENT error occurs if revision_id` is specified in the name.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1328

def delete_project_location_dataset_consent_store_consent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Empty

Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.

Parameters:

• name (String) —

  Required. The resource name of the Consent artifact to delete. To preserve referential integrity, Consent artifacts referenced by the latest revision of a Consent cannot be deleted.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1125

def delete_project_location_dataset_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store_consent_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Empty

Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.

Parameters:

• name (String) —

  Required. The resource name of the Consent revision to delete, of the form projects/project_id/locations/location_id/datasets/dataset_id/ consentStores/consent_store_id/consents/consent_id@revision_id`. An INVALID_ARGUMENT error occurs ifrevision_id` is not specified in the name.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1362

def delete_project_location_dataset_consent_store_consent_revision(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:deleteRevision', options)
  command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store_user_data_mapping(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Empty

Deletes the specified User data mapping.

Parameters:

• name (String) —

  Required. The resource name of the User data mapping to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1746

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1989

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

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a study while a delete operation is running for that study could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteStudy, see Deleting a study, series, or instance.

Parameters:

• parent (String)
• dicom_web_path (String) —

  The path of the DeleteStudy request. For example, studies/study_uid``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2523

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::Operation
  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::HealthcareV1::Operation

DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Inserting instances into a series while a delete operation is running for that series could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteSeries, see Deleting a study, series, or instance.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the DeleteSeries request. For example, studies/study_uid/series/ series_uid``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2786

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::Operation
  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::HealthcareV1::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 Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see Deleting a study, series, or instance.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the DeleteInstance request. For example, studies/study_uid/ series/series_uid/instances/instance_uid``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2959

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3286

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

Deletes a FHIR resource. Implements the FHIR standard delete interaction ( DSTU2, STU3, R4). 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. For samples that show how to call delete, see Deleting a FHIR resource.

Parameters:

• name (String) —

  The name of the resource to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3906

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

Deletes the specified HL7v2 store and removes all messages that it contains.

Parameters:

• name (String) —

  The resource name of the HL7v2 store to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4435

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

Deletes an HL7v2 message.

Parameters:

• name (String) —

  The resource name of the HL7v2 message to delete.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4747

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

#evaluate_consent_store_user_consents(consent_store, evaluate_user_consents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::EvaluateUserConsentsResponse

Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results.

Parameters:

• consent_store (String) —

  Required. Name of the consent store to retrieve User data mappings from.

• evaluate_user_consents_request_object (Google::Apis::HealthcareV1::EvaluateUserConsentsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::EvaluateUserConsentsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::EvaluateUserConsentsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 587

def evaluate_consent_store_user_consents(consent_store, evaluate_user_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+consentStore}:evaluateUserConsents', options)
  command.request_representation = Google::Apis::HealthcareV1::EvaluateUserConsentsRequest::Representation
  command.request_object = evaluate_user_consents_request_object
  command.response_representation = Google::Apis::HealthcareV1::EvaluateUserConsentsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::EvaluateUserConsentsResponse
  command.params['consentStore'] = consent_store unless consent_store.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::HealthcareV1::HttpBody

Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction (DSTU2, STU3, R4). 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 (DSTU2, STU3, R4) and transaction processing rules (DSTU2, STU3, R4). 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. For samples that show how to call executeBundle, see Managing FHIR resources using FHIR bundles.

Parameters:

• parent (String) —

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

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3960

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

Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see Viewing logs. The metadata field type is OperationMetadata.

Parameters:

• name (String) —

  The DICOM store resource name from which to export the data. For example, projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2025

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, 'v1/{+name}:export', options)
  command.request_representation = Google::Apis::HealthcareV1::ExportDicomDataRequest::Representation
  command.request_object = export_dicom_data_request_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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, errors are also logged to Cloud Logging (see Viewing logs). 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, in the format of projects/ project_id/locations/location_id/datasets/dataset_id/fhirStores/ fhir_store_id``.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3325

def export_fhir_store_resources(name, export_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:export', options)
  command.request_representation = Google::Apis::HealthcareV1::ExportResourcesRequest::Representation
  command.request_object = export_resources_request_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::Location

Gets information about a location.

Parameters:

• name (String) —

  Resource name for the location.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Location) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Location)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 72

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::Location::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::Dataset

Gets any metadata associated with a dataset.

Parameters:

• name (String) —

  The name of the dataset to read. For example, projects/project_id/locations/ location_id/datasets/dataset_id``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Dataset) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Dataset)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 256

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

Gets the specified consent store.

Parameters:

• name (String) —

  Required. The resource name of the consent store to get.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ConsentStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ConsentStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 619

def get_project_location_dataset_consent_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
  command.response_class = Google::Apis::HealthcareV1::ConsentStore
  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_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::AttributeDefinition

Gets the specified Attribute definition.

Parameters:

• name (String) —

  Required. The resource name of the Attribute definition to get.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::AttributeDefinition) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::AttributeDefinition)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 972

def get_project_location_dataset_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
  command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
  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_consent_store_consent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

Gets the specified revision of a Consent, or the latest revision if revision_id is not specified in the resource name.

Parameters:

• name (String) —

  Required. The resource name of the Consent to retrieve, of the form projects/ project_id/locations/location_id/datasets/dataset_id/consentStores/ consent_store_id/consents/consent_id. In order to retrieve a previous revision of the Consent, also provide the revision ID: `projects/`project_id`/ locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/ consents/`consent_id`@`revision_id

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Consent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Consent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1398

def get_project_location_dataset_consent_store_consent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
  command.response_class = Google::Apis::HealthcareV1::Consent
  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_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentArtifact

Gets the specified Consent artifact.

Parameters:

• name (String) —

  Required. The resource name of the Consent artifact to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ConsentArtifact) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ConsentArtifact)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1155

def get_project_location_dataset_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
  command.response_class = Google::Apis::HealthcareV1::ConsentArtifact
  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_consent_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::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) (defaults to: nil) —

  Optional. The policy format version to be returned. Valid values are 0, 1, and

  1. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 659

def get_project_location_dataset_consent_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store_user_data_mapping(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::UserDataMapping

Gets the specified User data mapping.

Parameters:

• name (String) —

  Required. The resource name of the User data mapping to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::UserDataMapping) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::UserDataMapping)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1776

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

Gets the specified DICOM store.

Parameters:

• name (String) —

  The resource name of the DICOM store to get.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::DicomStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::DicomStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2057

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

  Optional. The policy format version to be returned. Valid values are 0, 1, and

  1. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2097

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

Gets the configuration of the specified FHIR store.

Parameters:

• name (String) —

  The resource name of the FHIR store to get.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::FhirStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::FhirStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3357

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

  Optional. The policy format version to be returned. Valid values are 0, 1, and

  1. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3397

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

Gets the specified HL7v2 store.

Parameters:

• name (String) —

  The resource name of the HL7v2 store to get.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Hl7V2Store) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Hl7V2Store)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4465

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

  Optional. The policy format version to be returned. Valid values are 0, 1, and

  1. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4505

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

Gets an HL7v2 message.

Parameters:

• name (String) —

  The resource name of the HL7v2 message to retrieve.

• view (String) (defaults to: nil) —

  Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Message) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Message)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4780

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, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::Message::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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) (defaults to: nil) —

  Optional. The policy format version to be returned. Valid values are 0, 1, and

  1. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 296

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, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 5027

def get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::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_token: nil, _since: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::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 (DSTU2, STU3, R4). 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. For samples that show how to call history, see Listing FHIR resource versions.

Parameters:

• name (String) —

  The name of the resource to retrieve.

• _at (String) (defaults to: nil) —

  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) (defaults to: nil) —

  The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000.

• _page_token (String) (defaults to: nil) —

  Used to retrieve the first, previous, next, or last page of resource versions 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.

• _since (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4025

def history_project_location_dataset_fhir_store_fhir(name, _at: nil, _count: nil, _page_token: nil, _since: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/_history', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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_token'] = _page_token unless _page_token.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::HealthcareV1::Operation

Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, 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. For example, projects/project_id/locations/location_id/datasets/dataset_id/ dicomStores/dicom_store_id``.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2133

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, 'v1/{+name}:import', options)
  command.request_representation = Google::Apis::HealthcareV1::ImportDicomDataRequest::Representation
  command.request_object = import_dicom_data_request_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::Operation

Imports 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. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/ Sub notifications. Those IDs can also be contained in reference fields within other resources. 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. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. 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's 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 contains 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 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 in ImportResourcesRequest. 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 that history bundles are rejected, 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. 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, errors are also logged to Cloud Logging (see Viewing logs). 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, in the format of projects/project_id/locations/location_id/datasets/dataset_id/fhirStores/ fhir_store_id``.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3482

def import_fhir_store_resources(name, import_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:import', options)
  command.request_representation = Google::Apis::HealthcareV1::ImportResourcesRequest::Representation
  command.request_object = import_resources_request_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::IngestMessageResponse

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Cloud Pub/Sub topic configured in projects.locations. datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received. This method also generates a response containing an HL7v2 acknowledgement (ACK) message when successful or a negative acknowledgement (NACK) message in case of error, suitable for replying to HL7v2 interface systems that expect these acknowledgements.

Parameters:

• parent (String) —

  The name of the HL7v2 store this message belongs to.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::IngestMessageResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::IngestMessageResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4820

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

Lists the Attribute definitions in the specified consent store.

Parameters:

• parent (String) —

  Required. Name of the consent store to retrieve Attribute definitions from.

• filter (String) (defaults to: nil) —

  Optional. Restricts the attributes returned to those matching a filter. The only field available for filtering is category. For example, filter= category=\"REQUEST\".

• page_size (Fixnum) (defaults to: nil) —

  Optional. Limit on the number of Attribute definitions to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

  Optional. Token to retrieve the next page of results or empty to get the first page.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1012

def list_project_location_dataset_consent_store_attribute_definitions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/attributeDefinitions', options)
  command.response_representation = Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse
  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_consent_store_consent_artifacts(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListConsentArtifactsResponse

Lists the Consent artifacts in the specified consent store.

Parameters:

• parent (String) —

  Required. Name of the consent store to retrieve consent artifacts from.

• filter (String) (defaults to: nil) —

  Optional. Restricts the artifacts returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, " Comment = great" returns messages with great in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (= ), along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it. The fields available for filtering are: - user_id. For example, filter=user_id=\"user123\". - consent_content_version - metadata. For example, filter=Metadata(\"testkey\")= \"value\" or filter=HasMetadata(\"testkey\").

• page_size (Fixnum) (defaults to: nil) —

  Optional. Limit on the number of consent artifacts to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListConsentArtifactsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListConsentArtifactsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1216

def list_project_location_dataset_consent_store_consent_artifacts(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/consentArtifacts', options)
  command.response_representation = Google::Apis::HealthcareV1::ListConsentArtifactsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::ListConsentArtifactsResponse
  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_consent_store_consent_revisions(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListConsentRevisionsResponse

Lists the revisions of the specified Consent in reverse chronological order.

Parameters:

• name (String) —

  Required. The resource name of the Consent to retrieve revisions for.

• filter (String) (defaults to: nil) —

  Optional. Restricts the revisions returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, " Comment = great" returns messages with great in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (= ), along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it. Fields available for filtering are: - user_id. For example, filter='user_id="user123"'. - consent_artifact - state - revision_create_time - metadata. For example, filter=Metadata(\"testkey\")=\"value\" or filter=HasMetadata(\"testkey\").

• page_size (Fixnum) (defaults to: nil) —

  Optional. Limit on the number of revisions to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

  Optional. Token to retrieve the next page of results or empty if there are no more results in the list.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListConsentRevisionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListConsentRevisionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1524

def list_project_location_dataset_consent_store_consent_revisions(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:listRevisions', options)
  command.response_representation = Google::Apis::HealthcareV1::ListConsentRevisionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::ListConsentRevisionsResponse
  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_dataset_consent_store_consents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListConsentsResponse

Lists the Consent in the given consent store, returning each Consent's latest revision.

Parameters:

• parent (String) —

  Required. Name of the consent store to retrieve Consents from.

• filter (String) (defaults to: nil) —

  Optional. Restricts the Consents returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, " Comment = great" returns messages with great in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (= ), along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it. The fields available for filtering are: - user_id. For example, filter='user_id="user123"'. - consent_artifact - state - revision_create_time - metadata. For example, filter=Metadata(\"testkey\")=\"value\" or filter=HasMetadata(\"testkey\").

• page_size (Fixnum) (defaults to: nil) —

  Optional. Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListConsentsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListConsentsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1460

def list_project_location_dataset_consent_store_consents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/consents', options)
  command.response_representation = Google::Apis::HealthcareV1::ListConsentsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::ListConsentsResponse
  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_consent_store_user_data_mappings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListUserDataMappingsResponse

Lists the User data mappings in the specified consent store.

Parameters:

• parent (String) —

  Required. Name of the consent store to retrieve User data mappings from.

• filter (String) (defaults to: nil) —

  Optional. Restricts the User data mappings returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with great in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (=), along with the less than/greater than operators (<, <=, > , >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it. The fields available for filtering are: - data_id - user_id. For example, filter=user_id=\"user123\".

  • archived - archive_time
• page_size (Fixnum) (defaults to: nil) —

  Optional. Limit on the number of User data mappings to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

  Optional. Token to retrieve the next page of results, or empty to get the first page.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListUserDataMappingsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListUserDataMappingsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1836

def list_project_location_dataset_consent_store_user_data_mappings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/userDataMappings', options)
  command.response_representation = Google::Apis::HealthcareV1::ListUserDataMappingsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::ListUserDataMappingsResponse
  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_consent_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ListConsentStoresResponse

Lists the consent stores in the specified dataset.

Parameters:

• parent (String) —

  Required. Name of the dataset.

• filter (String) (defaults to: nil) —

  Optional. Restricts the stores returned to those matching a filter. Only filtering on labels is supported. For example, filter=labels.key=value.

• page_size (Fixnum) (defaults to: nil) —

  Optional. Limit on the number of consent stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

  Optional. Token to retrieve the next page of results, or empty to get the first page.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListConsentStoresResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListConsentStoresResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 699

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

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

Lists the DICOM stores in the given dataset.

Parameters:

• parent (String) —

  Name of the dataset.

• filter (String) (defaults to: nil) —

  Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with great in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (=), along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it. Only filtering on labels is supported. For example, labels.key=value.

• page_size (Fixnum) (defaults to: nil) —

  Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListDicomStoresResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListDicomStoresResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2193

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

Lists the FHIR stores in the given dataset.

Parameters:

• parent (String) —

  Name of the dataset.

• filter (String) (defaults to: nil) —

  Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with great in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (=), along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it. Only filtering on labels is supported, for example labels.key=value.

• page_size (Fixnum) (defaults to: nil) —

  Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListFhirStoresResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListFhirStoresResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3542

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, 'v1/{+parent}/fhirStores', options)
  command.response_representation = Google::Apis::HealthcareV1::ListFhirStoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::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) (defaults to: nil) —

  Restricts messages returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with great in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (=), along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it. Fields/functions available for filtering are: * message_type, from the MSH-9.1 field. 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". * create_time, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, create_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". * 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":*.
• order_by (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

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

• view (String) (defaults to: nil) —

  Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a page_size larger than the default can generate a large response, which impacts the performance of this method.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListMessagesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListMessagesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4907

def list_project_location_dataset_hl7_v2_store_messages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/messages', options)
  command.response_representation = Google::Apis::HealthcareV1::ListMessagesResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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['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

#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::HealthcareV1::ListHl7V2StoresResponse

Lists the HL7v2 stores in the given dataset.

Parameters:

• parent (String) —

  Name of the dataset.

• filter (String) (defaults to: nil) —

  Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with great in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (=), along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it. Only filtering on labels is supported. For example, labels.key=value.

• page_size (Fixnum) (defaults to: nil) —

  Limit on the number of HL7v2 stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListHl7V2StoresResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListHl7V2StoresResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4564

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, 'v1/{+parent}/hl7V2Stores', options)
  command.response_representation = Google::Apis::HealthcareV1::ListHl7V2StoresResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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) (defaults to: nil) —

  The standard list filter.

• page_size (Fixnum) (defaults to: nil) —

  The standard list page size.

• page_token (String) (defaults to: nil) —

  The standard list page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListOperationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListOperationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 5070

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, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::HealthcareV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::ListDatasetsResponse

Lists the health datasets in the current project.

Parameters:

• parent (String) —

  The name of the project whose datasets should be listed. For example, projects/project_id/locations/location_id``.

• page_size (Fixnum) (defaults to: nil) —

  The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000.

• page_token (String) (defaults to: nil) —

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

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListDatasetsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListDatasetsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 333

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, 'v1/{+parent}/datasets', options)
  command.response_representation = Google::Apis::HealthcareV1::ListDatasetsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

• name (String) —

  The resource that owns the locations collection, if applicable.

• filter (String) (defaults to: nil) —

  The standard list filter.

• page_size (Fixnum) (defaults to: nil) —

  The standard list page size.

• page_token (String) (defaults to: nil) —

  The standard list page token.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ListLocationsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ListLocationsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 108

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, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::HealthcareV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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

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

Updates dataset metadata.

Parameters:

• name (String) —

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

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

  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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Dataset) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Dataset)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 371

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, 'v1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::HealthcareV1::Dataset::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store(name, consent_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::ConsentStore

Updates the specified consent store.

Parameters:

• name (String) —

  Resource name of the consent store, of the form projects/project_id/ locations/location_id/datasets/dataset_id/consentStores/consent_store_id`` . Cannot be changed after creation.

• consent_store_object (Google::Apis::HealthcareV1::ConsentStore) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The update mask that applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask. Only the labels, default_consent_ttl, and enable_consent_create_on_update fields are allowed to be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::ConsentStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::ConsentStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 740

def patch_project_location_dataset_consent_store(name, consent_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
  command.request_object = consent_store_object
  command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
  command.response_class = Google::Apis::HealthcareV1::ConsentStore
  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_consent_store_attribute_definition(name, attribute_definition_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::AttributeDefinition

Updates the specified Attribute definition.

Parameters:

• name (String) —

  Resource name of the Attribute definition, of the form projects/project_id/ locations/location_id/datasets/dataset_id/consentStores/consent_store_id/ attributeDefinitions/attribute_definition_id``. Cannot be changed after creation.

• attribute_definition_object (Google::Apis::HealthcareV1::AttributeDefinition) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The update mask that applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask. Only the description, allowed_values, consent_default_values and data_mapping_default_value fields can be updated. The updated allowed_values must contain all values from the previous allowed_values.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::AttributeDefinition) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::AttributeDefinition)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1056

def patch_project_location_dataset_consent_store_attribute_definition(name, attribute_definition_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
  command.request_object = attribute_definition_object
  command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
  command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
  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_consent_store_consent(name, consent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the REJECTED or REVOKED state.

Parameters:

• name (String) —

  Resource name of the Consent, of the form projects/project_id/locations/ location_id/datasets/dataset_id/consentStores/consent_store_id/consents/ consent_id``. Cannot be changed after creation.

• consent_object (Google::Apis::HealthcareV1::Consent) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The update mask to apply to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask. Only the user_id, policies, consent_artifact, and metadata fields can be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Consent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Consent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1567

def patch_project_location_dataset_consent_store_consent(name, consent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1::Consent::Representation
  command.request_object = consent_object
  command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
  command.response_class = Google::Apis::HealthcareV1::Consent
  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_consent_store_user_data_mapping(name, user_data_mapping_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::UserDataMapping

Updates the specified User data mapping.

Parameters:

• name (String) —

  Resource name of the User data mapping, of the form projects/project_id/ locations/location_id/datasets/dataset_id/consentStores/consent_store_id/ userDataMappings/user_data_mapping_id``.

• user_data_mapping_object (Google::Apis::HealthcareV1::UserDataMapping) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. The update mask that applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask. Only the data_id, user_id and resource_attributes fields can be updated.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::UserDataMapping) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::UserDataMapping)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1877

def patch_project_location_dataset_consent_store_user_data_mapping(name, user_data_mapping_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
  command.request_object = user_data_mapping_object
  command.response_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
  command.response_class = Google::Apis::HealthcareV1::UserDataMapping
  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::HealthcareV1::DicomStore

Updates the specified DICOM store.

Parameters:

• name (String) —

  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::HealthcareV1::DicomStore) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::DicomStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::DicomStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2232

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, 'v1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1::DicomStore::Representation
  command.request_object = dicom_store_object
  command.response_representation = Google::Apis::HealthcareV1::DicomStore::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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::HealthcareV1::FhirStore) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::FhirStore) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::FhirStore)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3581

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

Updates part of an existing resource by applying the operations specified in a JSON Patch document. Implements the FHIR standard patch interaction (STU3, R4). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. 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. For samples that show how to call patch, see Patching a FHIR resource.

Parameters:

• name (String) —

  The name of the resource to update.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4073

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

Updates the HL7v2 store.

Parameters:

• name (String) —

  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::HealthcareV1::Hl7V2Store) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Hl7V2Store) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Hl7V2Store)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4603

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

Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.

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::HealthcareV1::Message) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Message) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Message)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4953

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, 'v1/{+name}', options)
  command.request_representation = Google::Apis::HealthcareV1::Message::Representation
  command.request_object = message_object
  command.response_representation = Google::Apis::HealthcareV1::Message::Representation
  command.response_class = Google::Apis::HealthcareV1::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, _page_token: nil, _since: nil, _type: nil, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::HttpBody

Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2, STU3, R4). 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. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ( DSTU2, STU3, R4), which details the eligible resource types and referencing search parameters. For samples that show how to call Patient-everything, see Getting all patient compartment resources.

Parameters:

• name (String) —

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

• _count (Fixnum) (defaults to: nil) —

  Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.

• _page_token (String) (defaults to: nil) —

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

• _since (String) (defaults to: nil) —

  If provided, only resources updated after this time are returned. The 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.

• _type (String) (defaults to: nil) —

  String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned.

• end_ (String) (defaults to: nil) —

  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.

• start (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3732

def patient_project_location_dataset_fhir_store_fhir_everything(name, _count: nil, _page_token: nil, _since: nil, _type: nil, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/$everything', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['_count'] = _count unless _count.nil?
  command.query['_page_token'] = _page_token unless _page_token.nil?
  command.query['_since'] = _since unless _since.nil?
  command.query['_type'] = _type unless _type.nil?
  command.query['end'] = end_ unless end_.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

#query_consent_store_accessible_data(consent_store, query_accessible_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation

Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. Errors are logged to Cloud Logging (see Viewing logs). For example, the following sample log entry shows a failed to evaluate consent policy error that occurred during a QueryAccessibleData call to consent store projects/ project_id/locations/location_id/datasets/dataset_id/consentStores/ consent_store_id.json jsonPayload: @type: "type.googleapis.com/google. cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: code: 9 message: "failed to evaluate consent policy" resourceName: "projects/project_id/ locations/location_id/datasets/dataset_id/consentStores/consent_store_id/ consents/consent_id" logName: "projects/project_id/logs/healthcare. googleapis.com%2Fquery_accessible_data" operation: id: "projects/project_id /locations/location_id/datasets/dataset_id/operations/operation_id" producer: "healthcare.googleapis.com/QueryAccessibleData" receiveTimestamp: " TIMESTAMP" resource: labels: consent_store_id: "consent_store_id" dataset_id: "dataset_id" location: "location_id" project_id: "project_id" type: "healthcare_consent_store" ` severity: "ERROR" timestamp: "TIMESTAMP"

</code>

Parameters:

• consent_store (String) —

  Required. Name of the consent store to retrieve User data mappings from.

• query_accessible_data_request_object (Google::Apis::HealthcareV1::QueryAccessibleDataRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Operation) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Operation)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 793

def query_consent_store_accessible_data(consent_store, query_accessible_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+consentStore}:queryAccessibleData', options)
  command.request_representation = Google::Apis::HealthcareV1::QueryAccessibleDataRequest::Representation
  command.request_object = query_accessible_data_request_object
  command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
  command.response_class = Google::Apis::HealthcareV1::Operation
  command.params['consentStore'] = consent_store unless consent_store.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::HealthcareV1::HttpBody

Gets the contents of a FHIR resource. Implements the FHIR standard read interaction (DSTU2, STU3, R4). Also supports the FHIR standard conditional read interaction (DSTU2, STU3, R4) 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. For samples that show how to call read, see Getting a FHIR resource.

Parameters:

• name (String) —

  The name of the resource to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4120

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

#reject_consent(name, reject_consent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the specified Consent is in the REJECTED state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the ACTIVE or REVOKED state.

Parameters:

• name (String) —

  Required. The resource name of the Consent to reject, of the form projects/ project_id/locations/location_id/datasets/dataset_id/consentStores/ consent_store_id/consents/consent_id`. An INVALID_ARGUMENT error occurs if revision_id` is specified in the name.

• reject_consent_request_object (Google::Apis::HealthcareV1::RejectConsentRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Consent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Consent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1608

def reject_consent(name, reject_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:reject', options)
  command.request_representation = Google::Apis::HealthcareV1::RejectConsentRequest::Representation
  command.request_object = reject_consent_request_object
  command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
  command.response_class = Google::Apis::HealthcareV1::Consent
  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::HealthcareV1::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. For samples that show how to call Resource-purge, see Deleting historical versions of a FHIR resource.

Parameters:

• name (String) —

  The name of the resource to purge.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Empty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Empty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3773

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

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See RetrieveTransaction. For details on the implementation of RetrieveStudyMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see Retrieving metadata.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveStudyMetadata DICOMweb request. For example, studies/ study_uid/metadata.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2566

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema. org/medical/dicom/current/output/html/part18.html#sect_10.4`. For details on the implementation of RetrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieving DICOM data.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveFrames DICOMweb request. For example, studies/ study_uid/series/series_uid/instances/instance_uid/frames/frame_list``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3135

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See RetrieveTransaction. For details on the implementation of RetrieveRenderedFrames, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieving consumer image formats.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveRenderedFrames DICOMweb request. For example, studies/ study_uid/series/series_uid/instances/instance_uid/frames/frame_list/ rendered.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3180

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See RetrieveTransaction. For details on the implementation of RetrieveInstance, see DICOM study/series/instances and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieving an instance.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveInstance DICOMweb request. For example, studies/ study_uid/series/series_uid/instances/instance_uid``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3003

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See RetrieveTransaction. For details on the implementation of RetrieveInstanceMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieving metadata.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveInstanceMetadata DICOMweb request. For example, studies/study_uid/series/series_uid/instances/instance_uid/metadata.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3047

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See RetrieveTransaction. For details on the implementation of RetrieveRenderedInstance, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieving consumer image formats.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveRenderedInstance DICOMweb request. For example, studies/study_uid/series/series_uid/instances/instance_uid/rendered.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3092

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See RetrieveTransaction. For details on the implementation of RetrieveSeriesMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieving metadata.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveSeriesMetadata DICOMweb request. For example, studies/ study_uid/series/series_uid/metadata.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2830

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

RetrieveSeries returns all instances within the given study and series. See RetrieveTransaction. For details on the implementation of RetrieveSeries, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieving DICOM data.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveSeries DICOMweb request. For example, studies/ study_uid/series/series_uid``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2873

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

RetrieveStudy returns all instances within the given study. See RetrieveTransaction. For details on the implementation of RetrieveStudy, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see Retrieving DICOM data.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the RetrieveStudy DICOMweb request. For example, studies/ study_uid``.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2609

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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

#revoke_consent(name, revoke_consent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Consent

Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED. If the latest revision of the specified Consent is in the REVOKED state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in DRAFT or REJECTED state.

Parameters:

• name (String) —

  Required. The resource name of the Consent to revoke, of the form projects/ project_id/locations/location_id/datasets/dataset_id/consentStores/ consent_store_id/consents/consent_id`. An INVALID_ARGUMENT error occurs if revision_id` is specified in the name.

• revoke_consent_request_object (Google::Apis::HealthcareV1::RevokeConsentRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Consent) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Consent)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 1648

def revoke_consent(name, revoke_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:revoke', options)
  command.request_representation = Google::Apis::HealthcareV1::RevokeConsentRequest::Representation
  command.request_object = revoke_consent_request_object
  command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
  command.response_class = Google::Apis::HealthcareV1::Consent
  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

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

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). Supports four 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]/_search?[ parameters] as an alternate form having the same semantics as the GET method across all resources. * POST [base]/[type]/_search?[parameters] as an alternate form having the same semantics as the GET method for the specified type. The GET and POST 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 (STU3, R4). FHIR search parameters for DSTU2 can be found on each resource's definition page. 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. For samples and detailed information, see Searching for FHIR resources and Advanced FHIR search features.

Parameters:

• parent (String) —

  Name of the FHIR store to retrieve resources from.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4192

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

SearchForInstances returns a list of matching instances. See Search Transaction. For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the SearchForInstancesRequest DICOMweb request. For example, instances, series/series_uid/instances, or studies/study_uid/instances .

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2278

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

SearchForSeries returns a list of matching series. See Search Transaction. For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Searching for studies, series, instances, and frames.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the SearchForSeries DICOMweb request. For example, series or studies/study_uid/series.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2321

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

SearchForStudies returns a list of matching studies. See Search Transaction. For details on the implementation of SearchForStudies, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Searching for studies, series, instances, and frames.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the SearchForStudies DICOMweb request. For example, studies.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2363

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

SearchForInstances returns a list of matching instances. See Search Transaction. For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the SearchForInstancesRequest DICOMweb request. For example, instances, series/series_uid/instances, or studies/study_uid/instances .

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2653

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

SearchForSeries returns a list of matching series. See Search Transaction. For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Searching for studies, series, instances, and frames.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the SearchForSeries DICOMweb request. For example, series or studies/study_uid/series.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2696

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::HttpBody

SearchForInstances returns a list of matching instances. See Search Transaction. For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the SearchForInstancesRequest DICOMweb request. For example, instances, series/series_uid/instances, or studies/study_uid/instances .

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2917

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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_fhir_store_fhir_type(parent, resource_type, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::HttpBody

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). Supports four 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]/_search?[ parameters] as an alternate form having the same semantics as the GET method across all resources. * POST [base]/[type]/_search?[parameters] as an alternate form having the same semantics as the GET method for the specified type. The GET and POST 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 (STU3, R4). FHIR search parameters for DSTU2 can be found on each resource's definition page. 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. For samples and detailed information, see Searching for FHIR resources and Advanced FHIR search features.

Parameters:

• parent (String) —

  Name of the FHIR store to retrieve resources from.

• resource_type (String) —

  The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4).

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4272

def search_project_location_dataset_fhir_store_fhir_type(parent, resource_type, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/fhir/{resourceType}/_search', options)
  command.request_representation = Google::Apis::HealthcareV1::SearchResourcesRequest::Representation
  command.request_object = search_resources_request_object
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::HttpBody
  command.params['parent'] = parent unless parent.nil?
  command.params['resourceType'] = resource_type unless resource_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

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

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::HealthcareV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 829

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

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

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::HealthcareV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 408

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

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::HealthcareV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2398

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

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::HealthcareV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3618

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

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::HealthcareV1::SetIamPolicyRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::Policy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::Policy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4640

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

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See Store Transaction. For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Storing DICOM data.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the StoreInstances DICOMweb request. For example, studies/[ study_uid]. Note that the study_uid is optional.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2443

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

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See Store Transaction. For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Storing DICOM data.

Parameters:

• parent (String) —

  The name of the DICOM store that is being accessed. For example, projects/ project_id/locations/location_id/datasets/dataset_id/dicomStores/ dicom_store_id``.

• dicom_web_path (String) —

  The path of the StoreInstances DICOMweb request. For example, studies/[ study_uid]. Note that the study_uid is optional.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2740

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, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
  command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.request_object = http_body_object
  command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
  command.response_class = Google::Apis::HealthcareV1::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_consent_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::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::HealthcareV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 867

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

#test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::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::HealthcareV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 446

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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::HealthcareV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 2482

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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::HealthcareV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 3656

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::HealthcareV1::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::HealthcareV1::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::HealthcareV1::TestIamPermissionsRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::TestIamPermissionsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::TestIamPermissionsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4678

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

Updates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2, STU3, R4). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. 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. For samples that show how to call update, see Updating a FHIR resource.

Parameters:

• name (String) —

  The name of the resource to update.

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

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4326

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

Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction (DSTU2, STU3, R4). 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. For samples that show how to call vread, see Retrieving a FHIR resource version.

Parameters:

• name (String) —

  The name of the resource version to retrieve.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  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) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::HealthcareV1::HttpBody) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::HealthcareV1::HttpBody)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/healthcare_v1/service.rb', line 4368

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