Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames
frames.retrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See RetrieveTransaction.
For details on the implementation of frames.retrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement.
For samples that show how to call frames.retrieveFrames, see Retrieve DICOM data.
HTTP request
GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/frames/*}
Required. The name of the DICOM store that is being accessed. For example, projects/{projectId}/locations/{locationId}/datasets/{datasetId}/dicomStores/{dicomStoreId}.
Authorization requires the following IAM permission on the specified resource parent:
healthcare.dicomStores.dicomWebRead
dicomWebPath
string
Required. The path of the frames.retrieveFrames DICOMweb request. For example, studies/{studyUid}/series/{seriesUid}/instances/{instanceUid}/frames/{frame_list}.
Request body
The request body must be empty.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003e\u003ccode\u003eframes.retrieveFrames\u003c/code\u003e retrieves instances associated with a specific study, series, SOP Instance UID, and frame numbers, as defined by the DICOM standard's RetrieveTransaction.\u003c/p\u003e\n"],["\u003cp\u003eThe method is accessed via a \u003ccode\u003eGET\u003c/code\u003e HTTP request to a specific URL pattern involving project, location, dataset, and DICOM store IDs.\u003c/p\u003e\n"],["\u003cp\u003eAccessing \u003ccode\u003eframes.retrieveFrames\u003c/code\u003e requires \u003ccode\u003ehealthcare.dicomStores.dicomWebRead\u003c/code\u003e IAM permission on the parent DICOM store.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL includes a \u003ccode\u003edicomWebPath\u003c/code\u003e parameter specifying the study, series, instance, and frame list to retrieve.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and successful requests return a generic HTTP response, and specific OAuth scopes are required for authorization.\u003c/p\u003e\n"]]],[],null,[]]
