class ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstances extends Resource (View source)

The "instances" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $instances = $healthcareService->projects_locations_datasets_dicomStores_studies_series_instances;

Methods

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

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

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

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 and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieve an instance. (instances.retrieveInstance)

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

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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieve metadata. (instances.retrieveMetadata)

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

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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieve consumer image formats. (instances.retrieveRendered)

Details

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

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 Delete a study, series, or instance. (instances.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 DeleteInstance request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}.

array $optParams

Optional parameters.

Return Value

HealthcareEmpty

Exceptions

Exception

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

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 and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieve an instance. (instances.retrieveInstance)

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

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

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

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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieve metadata. (instances.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 RetrieveInstanceMetadata DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata.

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

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

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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieve consumer image formats. (instances.retrieveRendered)

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

array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception