class ProjectsLocationsDatasetsDicomStoresStudies extends Resource (View source)

The "studies" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $studies = $healthcareService->projects_locations_datasets_dicomStores_studies;

Methods

delete(string $parent, string $dicomWebPath, array $optParams = [])

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. (studies.delete)

retrieveMetadata(string $parent, string $dicomWebPath, array $optParams = [])

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] ( http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4 ). 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 Retrieve metadata. (studies.retrieveMetadata)

retrieveStudy(string $parent, string $dicomWebPath, array $optParams = [])

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/htm l/part18.html#sect_10.4). 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 Retrieve DICOM data. (studies.retrieveStudy)

searchForInstances(string $parent, string $dicomWebPath, array $optParams = [])

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.

searchForSeries(string $parent, string $dicomWebPath, array $optParams = [])

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 transact ion in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data. (studies.searchForSeries)

storeInstances(string $parent, string $dicomWebPath, HttpBody $postBody, array $optParams = [])

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/di com/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. (studies.storeInstances)

Details

Operation delete(string $parent, string $dicomWebPath, array $optParams = [])

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. (studies.delete)

Parameters

string $parent
string $dicomWebPath

Required. The path of the DeleteStudy request. For example, studies/{study_uid}.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

HttpBody retrieveMetadata(string $parent, string $dicomWebPath, array $optParams = [])

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] ( http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4 ). 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 Retrieve metadata. (studies.retrieveMetadata)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.

string $dicomWebPath

Required. The path of the RetrieveStudyMetadata DICOMweb request. For example, studies/{study_uid}/metadata.

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

HttpBody retrieveStudy(string $parent, string $dicomWebPath, array $optParams = [])

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/htm l/part18.html#sect_10.4). 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 Retrieve DICOM data. (studies.retrieveStudy)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.

string $dicomWebPath

Required. The path of the RetrieveStudy DICOMweb request. For example, studies/{study_uid}.

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

HttpBody searchForInstances(string $parent, string $dicomWebPath, array $optParams = [])

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. (studies.searchForInstances)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.

string $dicomWebPath

Required. The path of the SearchForInstancesRequest DICOMweb request. For example, instances, series/{series_uid}/instances, or studies/{study_uid}/instances.

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

HttpBody searchForSeries(string $parent, string $dicomWebPath, array $optParams = [])

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 transact ion in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data. (studies.searchForSeries)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.

string $dicomWebPath

Required. The path of the SearchForSeries DICOMweb request. For example, series or studies/{study_uid}/series.

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

HttpBody storeInstances(string $parent, string $dicomWebPath, HttpBody $postBody, array $optParams = [])

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/di com/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. (studies.storeInstances)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.

string $dicomWebPath

Required. The path of the StoreInstances DICOMweb request. For example, studies/[{study_uid}]. Note that the study_uid is optional.

HttpBody $postBody
array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception