Skip to main content

instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Nameinstances
TypeResource
Idgoogle.healthcare.instances

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
contentTypestringThe HTTP Content-Type header value specifying the content type of the body.
datastring (byte)The HTTP request/response body as raw binary.
extensionsarrayApplication specific response metadata. Must be set in the first response for streaming APIs.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
retrieve_instanceselectprojectsId, locationsId, datasetsId, dicomStoresId, studiesId, seriesId, instancesIdRetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/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.
deletedeleteprojectsId, locationsId, datasetsId, dicomStoresId, studiesId, seriesId, instancesIdDeleteInstance 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.

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.

NameDatatypeDescription
datasetsIdstring
dicomStoresIdstring
instancesIdstring
locationsIdstring
projectsIdstring
seriesIdstring
studiesIdstring

SELECT examples

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/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.

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

DELETE examples

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.

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