class ProjectsLocationsDatasetsDicomStoresStudiesSeries extends Resource (View source)

The "series" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $series = $healthcareService->projects_locations_datasets_dicomStores_studies_series;

Methods

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

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.

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

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

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

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

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.

Details

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

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

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 DeleteSeries request. For example, studies/{study_uid}/series/{series_uid}.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/htm l/part18.html#sect_10.4). 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 Retrieve metadata. (series.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 RetrieveSeriesMetadata DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/metadata.

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

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

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

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 RetrieveSeries DICOMweb request. For example, studies/{study_uid}/series/{series_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. (series.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