Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered
frames.retrieveRendered returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See RetrieveTransaction.
For details on the implementation of frames.retrieveRendered, see Rendered resources in the Cloud Healthcare API conformance statement.
GET https://healthcare.googleapis.com/v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/frames/*/rendered}
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.retrieveRendered DICOMweb request. For example, studies/{studyUid}/series/{seriesUid}/instances/{instanceUid}/frames/{frame_list}/rendered.
[[["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\u003eThis webpage details the \u003ccode\u003eframes.retrieveRendered\u003c/code\u003e method, which retrieves instances associated with a specific study, series, SOP Instance UID, and frame numbers in a rendered media type.\u003c/p\u003e\n"],["\u003cp\u003eThe method utilizes HTTP GET requests with a specified URL structure, including required path parameters for \u003ccode\u003eparent\u003c/code\u003e (DICOM store location) and \u003ccode\u003edicomWebPath\u003c/code\u003e (DICOMweb request path).\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003eviewport\u003c/code\u003e query parameter is available for adjusting the display, as defined in the DICOM standard.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this method requires proper authorization through IAM permissions on the \u003ccode\u003eparent\u003c/code\u003e resource (\u003ccode\u003ehealthcare.dicomStores.dicomWebRead\u003c/code\u003e) and one of two 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 \u003ccode\u003eframes.retrieveRendered\u003c/code\u003e must be empty, and the response will be a generic HTTP response whose format is determined by the method's implementation.\u003c/p\u003e\n"]]],[],null,["# Method: frames.retrieveRendered\n\n**Full name**: projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered\n\nframes.retrieveRendered returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).\n\nFor details on the implementation of frames.retrieveRendered, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement.\n\nFor samples that show how to call frames.retrieveRendered, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/frames/*/rendered}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-healthcare`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
