instances
Creates, updates, deletes, gets or lists an instances
resource.
Overview
Name | instances |
Type | Resource |
Id | google.healthcare.instances |
Fields
The following fields are returned by SELECT
queries:
- retrieve_instance
Successful response
Name | Datatype | Description |
---|---|---|
contentType | string | The HTTP Content-Type header value specifying the content type of the body. |
data | string (byte) | The HTTP request/response body as raw binary. |
extensions | array | Application specific response metadata. Must be set in the first response for streaming APIs. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
retrieve_instance | select | projectsId , locationsId , datasetsId , dicomStoresId , studiesId , seriesId , instancesId | 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. | |
delete | delete | projectsId , locationsId , datasetsId , dicomStoresId , studiesId , seriesId , instancesId | 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. |
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.
Name | Datatype | Description |
---|---|---|
datasetsId | string | |
dicomStoresId | string | |
instancesId | string | |
locationsId | string | |
projectsId | string | |
seriesId | string | |
studiesId | string |
SELECT
examples
- retrieve_instance
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
- 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 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;