Documentation

Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstances extends Google_Service_Resource
in package

The "instances" collection of methods.

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

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_HealthcareEmpty
DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#deleting_a_study_series_or_instance). (instances.delete)
retrieveInstance()  : Google_Service_CloudHealthcare_HttpBody
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medica l/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https: //cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_an_instance). (instances.retrieveInstance)
retrieveMetadata()  : Google_Service_CloudHealthcare_HttpBody
RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/curre nt/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, 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 RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_metadata). (instances.retrieveMetadata)
retrieveRendered()  : Google_Service_CloudHealthcare_HttpBody
RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/htm l/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_consumer_image_formats). (instances.retrieveRendered)
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()

DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#deleting_a_study_series_or_instance). (instances.delete)

public delete(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HealthcareEmpty
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 DeleteInstance request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}.

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

Optional parameters.

Return values
Google_Service_CloudHealthcare_HealthcareEmpty —

retrieveInstance()

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medica l/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https: //cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_an_instance). (instances.retrieveInstance)

public retrieveInstance(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 RetrieveInstance DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}.

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

Optional parameters.

Return values
Google_Service_CloudHealthcare_HttpBody —

retrieveMetadata()

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/curre nt/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, 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 RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_metadata). (instances.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 RetrieveInstanceMetadata DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata.

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

Optional parameters.

Return values
Google_Service_CloudHealthcare_HttpBody —

retrieveRendered()

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/htm l/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieving_consumer_image_formats). (instances.retrieveRendered)

public retrieveRendered(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 RetrieveRenderedInstance DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered.

$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