series

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

Overview

Name	series
Type	Resource
Id	google.healthcare.series

Fields

The following fields are returned by SELECT queries:

retrieve_series

Successful response

Name	Datatype	Description
contentType	string	The HTTP Content-Type header value specifying the content type of the body.
data	string (byte)	The HTTP request/response body as raw binary.
extensions	array	Application specific response metadata. Must be set in the first response for streaming APIs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
retrieve_series	select	projectsId, locationsId, datasetsId, dicomStoresId, studiesId, seriesId		RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/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.
delete	delete	projectsId, locationsId, datasetsId, dicomStoresId, studiesId, seriesId		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.
search_for_instances	exec	projectsId, locationsId, datasetsId, dicomStoresId, studiesId, seriesId		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
seriesId	string
studiesId	string

SELECT examples

retrieve_series

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

SELECT
contentType,
data,
extensions
FROM google.healthcare.series
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND dicomStoresId = '{{ dicomStoresId }}' -- required
AND studiesId = '{{ studiesId }}' -- required
AND seriesId = '{{ seriesId }}' -- required;

DELETE examples

delete

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.

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

Lifecycle Methods

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.series.search_for_instances 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required, 
@studiesId='{{ studiesId }}' --required, 
@seriesId='{{ seriesId }}' --required;