studies

Creates, updates, deletes, gets or lists a studies resource.

Overview

Name	studies
Type	Resource
Id	google.healthcare.studies

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
delete	delete	projectsId, locationsId, datasetsId, dicomStoresId, studiesId		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 Delete a study, series, or instance.
set_blob_storage_settings	exec	projectsId, locationsId, datasetsId, dicomStoresId, studiesId		SetBlobStorageSettings sets the blob storage settings of the specified resources.
store_instances	exec	projectsId, locationsId, datasetsId, dicomStoresId, studiesId		StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). 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 Store DICOM data.
search_for_series	exec	projectsId, locationsId, datasetsId, dicomStoresId, studiesId		SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). 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 Search for DICOM data.
search_for_instances	exec	projectsId, locationsId, datasetsId, dicomStoresId, studiesId		SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). 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 Search for DICOM data.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
datasetsId	string
dicomStoresId	string
locationsId	string
projectsId	string
studiesId	string

DELETE examples

delete

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 Delete a study, series, or instance.

DELETE FROM google.healthcare.studies
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND dicomStoresId = '{{ dicomStoresId }}' --required
AND studiesId = '{{ studiesId }}' --required;

Lifecycle Methods

set_blob_storage_settings

SetBlobStorageSettings sets the blob storage settings of the specified resources.

EXEC google.healthcare.studies.set_blob_storage_settings 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required, 
@studiesId='{{ studiesId }}' --required 
@@json=
'{
"filterConfig": "{{ filterConfig }}", 
"blobStorageSettings": "{{ blobStorageSettings }}"
}';

store_instances

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). 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 Store DICOM data.

EXEC google.healthcare.studies.store_instances 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required, 
@studiesId='{{ studiesId }}' --required 
@@json=
'{
"contentType": "{{ contentType }}", 
"data": "{{ data }}", 
"extensions": "{{ extensions }}"
}';

search_for_series

SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). 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 Search for DICOM data.

EXEC google.healthcare.studies.search_for_series 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required, 
@studiesId='{{ studiesId }}' --required;

search_for_instances

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). 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 Search for DICOM data.

EXEC google.healthcare.studies.search_for_instances 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required, 
@studiesId='{{ studiesId }}' --required;