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/v1/{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\u003eThe \u003ccode\u003eframes.retrieveFrames\u003c/code\u003e method retrieves DICOM instances associated with a specific study, series, SOP Instance UID, and frame numbers, as detailed in the DICOM RetrieveTransaction specification.\u003c/p\u003e\n"],["\u003cp\u003eAccessing this method requires a \u003ccode\u003eGET\u003c/code\u003e request to a specific URL structured using gRPC Transcoding syntax, including parameters for project, location, dataset, DICOM store, study, series, instance, and frame.\u003c/p\u003e\n"],["\u003cp\u003eThe request must include a \u003ccode\u003eparent\u003c/code\u003e path parameter specifying the DICOM store and a \u003ccode\u003edicomWebPath\u003c/code\u003e parameter defining the path to the frames being retrieved.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to use \u003ccode\u003eframes.retrieveFrames\u003c/code\u003e requires either the \u003ccode\u003ehealthcare.dicomStores.dicomWebRead\u003c/code\u003e IAM permission or one of the specified OAuth scopes (\u003ccode\u003ehttps://www.googleapis.com/auth/cloud-healthcare\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this method must be empty, and a successful request will return a generic HTTP response, the format of which is defined by the method.\u003c/p\u003e\n"]]],[],null,[]]
