com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies

java.lang.Object

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.DicomStores

public class CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies
extends Object

The "studies" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Delete
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.RetrieveMetadata
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.RetrieveStudy
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.SearchForInstances
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.SearchForSeries
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series The "series" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.StoreInstances
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateInstances
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata

Constructor Summary

Constructors

Constructor and Description
Studies()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Delete	delete(String parent, String dicomWebPath) DeleteStudy deletes all instances within the given study using a long running operation.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.RetrieveMetadata	retrieveMetadata(String parent, String dicomWebPath) RetrieveStudyMetadata returns instance associated with the given study presented as metadata.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.RetrieveStudy	retrieveStudy(String parent, String dicomWebPath) RetrieveStudy returns all instances within the given study.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.SearchForInstances	searchForInstances(String parent, String dicomWebPath) SearchForInstances returns a list of matching instances.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.SearchForSeries	searchForSeries(String parent, String dicomWebPath) SearchForSeries returns a list of matching series.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series	series() An accessor for creating requests from the Series collection.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.StoreInstances	storeInstances(String parent, String dicomWebPath, HttpBody content) StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID).
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateInstances	updateInstances(String parent, String dicomWebPath, HttpBody content) UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	updateMetadata(String parent, String dicomWebPath, HttpBody content) UpdateStudyMetadata modifies the metadata of all instances in the given study.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Studies

public Studies()

Method Detail

delete

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Delete delete(String parent,
                                                                                     String dicomWebPath)
                                                                              throws IOException

DeleteStudy deletes all instances within the given study using a long running operation. 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](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). Create a request for the method "studies.delete". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent -

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

Returns:

the request

Throws:

IOException

retrieveMetadata

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.RetrieveMetadata retrieveMetadata(String parent,
                                                                                                         String dicomWebPath)
                                                                                                  throws IOException

RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_1 0.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve- metadata). Create a request for the method "studies.retrieveMetadata". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

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

Returns:

the request

Throws:

IOException

retrieveStudy

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.RetrieveStudy retrieveStudy(String parent,
                                                                                                   String dicomWebPath)
                                                                                            throws IOException

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](https://dic om.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/heal thcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). Create a request for the method "studies.retrieveStudy". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

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

Returns:

the request

Throws:

IOException

searchForInstances

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.SearchForInstances searchForInstances(String parent,
                                                                                                             String dicomWebPath)
                                                                                                      throws IOException

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom. nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). Create a request for the method "studies.searchForInstances". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

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

Returns:

the request

Throws:

IOException

searchForSeries

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.SearchForSeries searchForSeries(String parent,
                                                                                                       String dicomWebPath)
                                                                                                throws IOException

SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.o rg/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). Create a request for the method "studies.searchForSeries". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

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

Returns:

the request

Throws:

IOException

storeInstances

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.StoreInstances storeInstances(String parent,
                                                                                                     String dicomWebPath,
                                                                                                     HttpBody content)
                                                                                              throws IOException

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). Create a request for the method "studies.storeInstances". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

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

content - the HttpBody

Returns:

the request

Throws:

IOException

updateInstances

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateInstances updateInstances(String parent,
                                                                                                       String dicomWebPath,
                                                                                                       HttpBody content)
                                                                                                throws IOException

UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID). Create a request for the method "studies.updateInstances". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

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

content - the HttpBody

Returns:

the request

Throws:

IOException

updateMetadata

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata updateMetadata(String parent,
                                                                                                     String dicomWebPath,
                                                                                                     HttpBody content)
                                                                                              throws IOException

UpdateStudyMetadata modifies the metadata of all instances in the given study. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the study. Create a request for the method "studies.updateMetadata". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`).

dicomWebPath - Required. The path of the UpdateStudyMetadata request (for example, `studies/{study_uid}`).

content - the HttpBody

Returns:

the request

Throws:

IOException

series

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series series()

An accessor for creating requests from the Series collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.Series.List request = healthcare.series().list(parameters ...)
 

Returns:

the resource collection