Documentation

Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsDicomStoresStudiesSeries extends Google_Service_Resource
in package

The "series" collection of methods.

Typical usage is: $healthcareService = new Google_Service_CloudHealthcare(...); $series = $healthcareService->series;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudHealthcare_Operation
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: Inserting instances into a series while a delete operation is running for that series could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#deleting_a_study_series_or_instance). (series.delete)
retrieveMetadata()  : Google_Service_CloudHealthcare_HttpBody
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](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_metadata). (series.retrieveMetadata)
retrieveSeries()  : Google_Service_CloudHealthcare_HttpBody
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](https://cloud.google.com/h ealthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_dicom_data). (series.retrieveSeries)
searchForInstances()  : Google_Service_CloudHealthcare_HttpBody
SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

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: Inserting instances into a series while a delete operation is running for that series could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#deleting_a_study_series_or_instance). (series.delete)

public delete(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Operation
Parameters
$parent : string

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}.

$dicomWebPath : string

The path of the DeleteSeries request. For example, studies/{study_uid}/series/{series_uid}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudHealthcare_Operation —

retrieveMetadata()

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](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_metadata). (series.retrieveMetadata)

public retrieveMetadata(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody
Parameters
$parent : string

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}.

$dicomWebPath : string

The path of the RetrieveSeriesMetadata DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/metadata.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudHealthcare_HttpBody —

retrieveSeries()

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](https://cloud.google.com/h ealthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_dicom_data). (series.retrieveSeries)

public retrieveSeries(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody
Parameters
$parent : string

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}.

$dicomWebPath : string

The path of the RetrieveSeries DICOMweb request. For example, studies/{study_uid}/series/{series_uid}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudHealthcare_HttpBody —

searchForInstances()

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

public searchForInstances(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody

html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_tr ansaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#searching_for_studies_series_instances_and_frames). (series.searchForInstances)

Parameters
$parent : string

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}.

$dicomWebPath : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudHealthcare_HttpBody —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results