Documentation

Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsDicomStoresStudies extends Google_Service_Resource
in package

Application

The "studies" collection of methods.

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

$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: 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: Inserting instances into a study while a delete operation is running for that study could result in the new instances not appearing in search results until the deletion operation finishes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#deleting_a_study_series_or_instance). (studies.delete)
retrieveMetadata() : Google_Service_CloudHealthcare_HttpBody: 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](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 [Retrieving metadata](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_metadata). (studies.retrieveMetadata)
retrieveStudy() : Google_Service_CloudHealthcare_HttpBody: RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/htm l/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/d icom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_dicom_data). (studies.retrieveStudy)
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.
searchForSeries() : Google_Service_CloudHealthcare_HttpBody: 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 transact ion](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 [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#searching_for_studies_series_instances_and_frames).
storeInstances() : Google_Service_CloudHealthcare_HttpBody: StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/di com/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.googl e.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#storing_dicom_data). (studies.storeInstances)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

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>

Return values

string —

$requestUrl

delete()

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


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

Parameters

$parent : string
$dicomWebPath : string: The path of the DeleteStudy request. For example, studies/{study_uid}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

retrieveMetadata()

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](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 [Retrieving metadata](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_metadata). (studies.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 RetrieveStudyMetadata DICOMweb request. For example, studies/{study_uid}/metadata.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HttpBody —

retrieveStudy()

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/htm l/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/d icom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_dicom_data). (studies.retrieveStudy)


    public
                retrieveStudy(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 RetrieveStudy DICOMweb request. For example, studies/{study_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). (studies.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 —

searchForSeries()

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 transact ion](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 [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#searching_for_studies_series_instances_and_frames).


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

(studies.searchForSeries)

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 SearchForSeries DICOMweb request. For example, series or studies/{study_uid}/series.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HttpBody —

storeInstances()

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/di com/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.googl e.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#storing_dicom_data). (studies.storeInstances)


    public
                storeInstances(string $parent, string $dicomWebPath, Google_Service_CloudHealthcare_HttpBody $postBody[, 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 StoreInstances DICOMweb request. For example, studies/[{study_uid}]. Note that the study_uid is optional.
$postBody : Google_Service_CloudHealthcare_HttpBody
$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 —