API ReferencePre EncounterImagesV1

Get Multi

Beta

Searches for images that match the query parameters.

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

patient_idstringOptional
coverage_idstringOptional

Response

This endpoint returns a list of objects.
deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

display_namestring
file_namestring
file_typestring
idstring

The unique identifier for an Image

organization_idstring

The organization that owns this object.

signed_urlstring

A signed URL to the image. This url can be used to upload an image to GCP storage or to read the image contents.

statusenum
Allowed values:
updated_atdatetime
updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

coverageobjectOptional

An association to a Coverage.

patientobjectOptional

An association to a Patient.