API ReferencePre EncounterImagesV1

Update

Beta

Updates an Image. The path must contain the most recent version to prevent races.

Path parameters

idstringRequired

The unique identifier for an Image

versionstringRequired

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Request

This endpoint expects an object.
file_namestringRequired
display_namestringRequired
file_typestringRequired
statusenumRequired
Allowed values:
coverageobjectOptional

An association to a Coverage.

patientobjectOptional

An association to a Patient.

Response

This endpoint returns an object.
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.

Errors