Class ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource

The "studies" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudHealthcare.v1

Assembly: Google.Apis.CloudHealthcare.v1.dll

Syntax

public class ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource

Constructors

StudiesResource(IClientService)

Constructs a new resource.

Declaration

public StudiesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Series

Gets the Series resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource Series { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource

Methods

Delete(string, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.DeleteRequest Delete(string parent, string dicomWebPath)

Parameters

Type	Name	Description
string	parent	`null`
string	dicomWebPath	Required. The path of the DeleteStudy request. For example, `studies/{study_uid}`.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.DeleteRequest

RetrieveMetadata(string, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveMetadataRequest RetrieveMetadata(string parent, string dicomWebPath)

Parameters

Type	Name	Description
string	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_store_id}`.
string	dicomWebPath	Required. The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveMetadataRequest

RetrieveStudy(string, string)

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveStudyRequest RetrieveStudy(string parent, string dicomWebPath)

Parameters

Type	Name	Description
string	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_store_id}`.
string	dicomWebPath	Required. The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveStudyRequest

SearchForInstances(string, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForInstancesRequest SearchForInstances(string parent, string dicomWebPath)

Parameters

Type	Name	Description
string	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_store_id}`.
string	dicomWebPath	Required. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForInstancesRequest

SearchForSeries(string, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForSeriesRequest SearchForSeries(string parent, string dicomWebPath)

Parameters

Type	Name	Description
string	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_store_id}`.
string	dicomWebPath	Required. The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForSeriesRequest

StoreInstances(HttpBody, string, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.StoreInstancesRequest StoreInstances(HttpBody body, string parent, string dicomWebPath)

Parameters

Type	Name	Description
HttpBody	body	The body of the request.
string	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_store_id}`.
string	dicomWebPath	Required. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.StoreInstancesRequest