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.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#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 toACTIVE
. -
#analyze_nlp_entities(nlp_service, analyze_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::AnalyzeEntitiesResponse
Analyze heathcare entity in a document.
-
#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.
-
#export_hl7_v2_store_messages(name, export_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation
Exports the messages to a 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.
-
#import_hl7_v2_store_messages(name, import_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation
Import messages to the HL7v2 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 toREJECTED
. -
#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.
-
#resource_project_location_dataset_fhir_store_fhir_validate(parent, type, http_body_object = nil, profile: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::HttpBody
Validates an input FHIR resource's conformance to its profiles and the profiles configured on 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 toREVOKED
. -
#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.
45 46 47 48 49 50 |
# 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.
38 39 40 |
# 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.
43 44 45 |
# 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.
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1277 def (name, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:activate', ) command.request_representation = Google::Apis::HealthcareV1::ActivateConsentRequest::Representation command.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 |
#analyze_nlp_entities(nlp_service, analyze_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::AnalyzeEntitiesResponse
Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aware models to detect entities.
5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 5317 def analyze_nlp_entities(nlp_service, analyze_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+nlpService}:analyzeEntities', ) command.request_representation = Google::Apis::HealthcareV1::AnalyzeEntitiesRequest::Representation command.request_object = analyze_entities_request_object command.response_representation = Google::Apis::HealthcareV1::AnalyzeEntitiesResponse::Representation command.response_class = Google::Apis::HealthcareV1::AnalyzeEntitiesResponse command.params['nlpService'] = nlp_service unless nlp_service.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.
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1701 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', ) 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
.
5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 5204 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', ) 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 contains a JSON-
encoded representation of a CapabilityStatement
resource.
3909 3910 3911 3912 3913 3914 3915 3916 3917 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3909 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', ) 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.
493 494 495 496 497 498 499 500 501 502 503 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 493 def (, check_data_access_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+consentStore}:checkDataAccess', ) 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'] = unless .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 Pub/Sub topic configured in Hl7V2Store. Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received.
4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4925 def (parent, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/messages', ) command.request_representation = Google::Apis::HealthcareV1::CreateMessageRequest::Representation command.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.
152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 152 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', ) 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.
531 532 533 534 535 536 537 538 539 540 541 542 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 531 def (parent, = nil, consent_store_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/consentStores', ) command.request_representation = Google::Apis::HealthcareV1::ConsentStore::Representation command.request_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'] = unless .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.
926 927 928 929 930 931 932 933 934 935 936 937 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 926 def (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', ) 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.
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1310 def (parent, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/consents', ) command.request_representation = Google::Apis::HealthcareV1::Consent::Representation command.request_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.
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1110 def (parent, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/consentArtifacts', ) command.request_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation command.request_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.
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1734 def (parent, user_data_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/userDataMappings', ) 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.
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1934 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', ) 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.
3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3240 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', ) 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 contains 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
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.
3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3960 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}', ) 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.
4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4509 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', ) 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 error logs in Cloud Logging.
195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 195 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', ) 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 error logs in Cloud Logging).
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1976 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', ) 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 error logs in Cloud Logging).
3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3280 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', ) 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).
230 231 232 233 234 235 236 237 238 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 230 def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
564 565 566 567 568 569 570 571 572 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 564 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
962 963 964 965 966 967 968 969 970 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 962 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
1348 1349 1350 1351 1352 1353 1354 1355 1356 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1348 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
1145 1146 1147 1148 1149 1150 1151 1152 1153 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1145 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
1382 1383 1384 1385 1386 1387 1388 1389 1390 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1382 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}:deleteRevision', ) 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.
1766 1767 1768 1769 1770 1771 1772 1773 1774 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1766 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
2009 2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2009 def delete_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see Deleting a study, series, or instance.
2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2549 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}', ) 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: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see Deleting a study, series, or instance.
2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2811 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}', ) 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.
2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2984 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}', ) 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.
3312 3313 3314 3315 3316 3317 3318 3319 3320 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3312 def delete_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
4002 4003 4004 4005 4006 4007 4008 4009 4010 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4002 def delete_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
4542 4543 4544 4545 4546 4547 4548 4549 4550 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4542 def delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
4957 4958 4959 4960 4961 4962 4963 4964 4965 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4957 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
598 599 600 601 602 603 604 605 606 607 608 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 598 def (, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+consentStore}:evaluateUserConsents', ) command.request_representation = Google::Apis::HealthcareV1::EvaluateUserConsentsRequest::Representation command.request_object = command.response_representation = Google::Apis::HealthcareV1::EvaluateUserConsentsResponse::Representation command.response_class = Google::Apis::HealthcareV1::EvaluateUserConsentsResponse command.params['consentStore'] = unless .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 contains 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 contains 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. This method checks permissions for each request in the bundle. The
executeBundle
permission is required to call this method, but you must also
grant sufficient permissions to execute the individual requests in the bundle.
For example, if the bundle contains a request to create a FHIR resource, the
caller must also have been granted the healthcare.fhirResources.create
permission. You can use audit logs to view the permissions for executeBundle
and each request in the bundle. For more information, see Viewing Cloud Audit
logs. For
samples that show how to call executeBundle
, see Managing FHIR resources
using FHIR bundles.
4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4064 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', ) 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 error logs in Cloud Logging. The metadata field type is OperationMetadata.
2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2045 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', ) 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 error logs in Cloud Logging). 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.
3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3352 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', ) 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 |
#export_hl7_v2_store_messages(name, export_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation
Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4580 def (name, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:export', ) command.request_representation = Google::Apis::HealthcareV1::ExportMessagesRequest::Representation command.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.
72 73 74 75 76 77 78 79 80 |
# 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}', ) 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.
261 262 263 264 265 266 267 268 269 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 261 def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
630 631 632 633 634 635 636 637 638 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 630 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
992 993 994 995 996 997 998 999 1000 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 992 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
1418 1419 1420 1421 1422 1423 1424 1425 1426 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1418 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
1175 1176 1177 1178 1179 1180 1181 1182 1183 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1175 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
674 675 676 677 678 679 680 681 682 683 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 674 def (resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', ) 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'] = unless .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.
1796 1797 1798 1799 1800 1801 1802 1803 1804 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1796 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2077 def get_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2121 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', ) 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'] = unless .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.
3384 3385 3386 3387 3388 3389 3390 3391 3392 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3384 def get_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3428 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', ) 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'] = unless .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.
4612 4613 4614 4615 4616 4617 4618 4619 4620 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4612 def get_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4656 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', ) 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'] = unless .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.
4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4990 def (name, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
305 306 307 308 309 310 311 312 313 314 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 305 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', ) 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'] = unless .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.
5237 5238 5239 5240 5241 5242 5243 5244 5245 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 5237 def get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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 contains 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 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.
4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4129 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', ) 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 error logs in Cloud Logging. The metadata field type is OperationMetadata.
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2158 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', ) 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 error logs in
Cloud Logging).
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.
3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3514 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', ) 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 |
#import_hl7_v2_store_messages(name, import_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::Operation
Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. 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 error logs in Cloud Logging). Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4712 def (name, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:import', ) command.request_representation = Google::Apis::HealthcareV1::ImportMessagesRequest::Representation command.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 Pub/Sub topic configured in Hl7V2Store.
Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
message when a notification is received. If the method is successful, it
generates a response containing an HL7v2 acknowledgment (ACK
) message. If
the method encounters an error, it returns a negative acknowledgment (NACK
)
message. This behavior is suitable for replying to HL7v2 interface systems
that expect these acknowledgments.
5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 5030 def (parent, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/messages:ingest', ) command.request_representation = Google::Apis::HealthcareV1::IngestMessageRequest::Representation command.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.
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1032 def (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', ) 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.
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1236 def (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', ) 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.
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1544 def (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', ) 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.
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1480 def (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', ) 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.
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1856 def (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', ) 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.
714 715 716 717 718 719 720 721 722 723 724 725 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 714 def (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', ) 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.
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2218 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', ) 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.
3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3574 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', ) 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.
5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 5117 def (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', ) 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.
4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4772 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', ) 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.
5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 5280 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', ) 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.
342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 342 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', ) 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.
112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 112 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', ) 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.
380 381 382 383 384 385 386 387 388 389 390 391 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 380 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}', ) 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.
755 756 757 758 759 760 761 762 763 764 765 766 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 755 def (name, = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::HealthcareV1::ConsentStore::Representation command.request_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.
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1076 def (name, attribute_definition_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) 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.
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1587 def (name, = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::HealthcareV1::Consent::Representation command.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['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.
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1897 def (name, user_data_mapping_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) 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.
2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2257 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}', ) 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.
3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3613 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}', ) 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 contains a JSON-encoded representation of the
updated resource, including the server-assigned version ID. Errors generated
by the FHIR store 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.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4177 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}', ) 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.
4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4811 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}', ) 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.
5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 5163 def (name, = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::HealthcareV1::Message::Representation command.request_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 contains a JSON-
encoded representation of a Bundle
resource of type searchset
, containing
the results of the operation. Errors generated by the FHIR store 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.
3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3768 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', ) 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. If the request is successful, a detailed response is returned of
type QueryAccessibleDataResponse, contained in the response field when the
operation finishes. The metadata field type is OperationMetadata. Errors are
logged to Cloud Logging (see Viewing error logs in Cloud Logging). 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>
811 812 813 814 815 816 817 818 819 820 821 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 811 def (, query_accessible_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+consentStore}:queryAccessibleData', ) 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'] = unless .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 contains a JSON-encoded representation of
the resource. Errors generated by the FHIR store 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.
4224 4225 4226 4227 4228 4229 4230 4231 4232 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4224 def read_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1628 def (name, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:reject', ) command.request_representation = Google::Apis::HealthcareV1::RejectConsentRequest::Representation command.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.
3809 3810 3811 3812 3813 3814 3815 3816 3817 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3809 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', ) 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 |
#resource_project_location_dataset_fhir_store_fhir_validate(parent, type, http_body_object = nil, profile: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::HealthcareV1::HttpBody
Validates an input FHIR resource's conformance to its profiles and the
profiles configured on the FHIR store. Implements the FHIR extended operation $
validate (DSTU2, STU3, or R4). The request body must contain a
JSON-encoded FHIR resource, and the request headers must contain Content-Type:
application/fhir+json
. The Parameters
input syntax is not supported. The
profile
query parameter can be used to request that the resource only be
validated against a specific profile. If a profile with the given URL cannot
be found in the FHIR store then an error is returned. Errors generated by
validation 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.
3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3865 def resource_project_location_dataset_fhir_store_fhir_validate(parent, type, http_body_object = nil, profile: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/fhir/{+type}/$validate', ) 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['profile'] = profile unless profile.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.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2592 def (parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', ) 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.
3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3160 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}', ) 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.
3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3205 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}', ) 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.
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3028 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}', ) 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.
3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3072 def (parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', ) 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.
3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3117 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}', ) 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.
2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2855 def (parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', ) 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.
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2898 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}', ) 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.
2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2635 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}', ) 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.
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 1668 def (name, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:revoke', ) command.request_representation = Google::Apis::HealthcareV1::RevokeConsentRequest::Representation command.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 contains a JSON-encoded
representation of a Bundle
resource of type searchset
, containing the
results of the search. Errors generated by the FHIR store 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
contains a link of relation
"next", which has
a _page_token
parameter for an opaque pagination token that can be used to
retrieve the next page. 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.
4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4298 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', ) 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.
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2303 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}', ) 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.
2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2346 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}', ) 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.
2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2388 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}', ) 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.
2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2679 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}', ) 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.
2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2722 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}', ) 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.
2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2942 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}', ) 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 contains a JSON-encoded
representation of a Bundle
resource of type searchset
, containing the
results of the search. Errors generated by the FHIR store 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
contains a link of relation
"next", which has
a _page_token
parameter for an opaque pagination token that can be used to
retrieve the next page. 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.
4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4380 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', ) 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.
848 849 850 851 852 853 854 855 856 857 858 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 848 def (resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', ) 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.
418 419 420 421 422 423 424 425 426 427 428 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 418 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', ) 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.
2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2424 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', ) 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.
3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3651 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', ) 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.
4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4849 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', ) 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.
2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2469 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}', ) 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.
2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2766 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}', ) 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.
887 888 889 890 891 892 893 894 895 896 897 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 887 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation command.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.
457 458 459 460 461 462 463 464 465 466 467 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 457 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation command.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.
2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 2509 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation command.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.
3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 3690 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation command.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.
4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4888 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation command.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 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 contains a JSON-encoded representation of the
updated resource, including the server-assigned version ID. Errors generated
by the FHIR store 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.
4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4433 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}', ) 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 contains a
JSON-encoded representation of the resource. Errors generated by the FHIR
store 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.
4475 4476 4477 4478 4479 4480 4481 4482 4483 |
# File 'lib/google/apis/healthcare_v1/service.rb', line 4475 def vread_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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 |