Create

1 import uuid 2 3 from candid import CandidApiClient 4 from candid.resources.pre_encounter.resources.images.resources.v_1 import ( 5 CoverageAssociation, 6 CoverageImageSide, 7 ImageStatus, 8 MutableImage, 9 PatientAssociation, 10 ) 11 12 client = CandidApiClient( 13 client_id="YOUR_CLIENT_ID", 14 client_secret="YOUR_CLIENT_SECRET", 15 ) 16 client.pre_encounter.images.v_1.create( 17 request=MutableImage( 18 file_name="string", 19 display_name="string", 20 file_type="string", 21 status=ImageStatus.PENDING, 22 coverage=CoverageAssociation( 23 id=uuid.UUID( 24 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 25 ), 26 side=CoverageImageSide.FRONT, 27 ), 28 patient=PatientAssociation( 29 id="string", 30 notes="string", 31 ), 32 ), 33 )

1 { 2 "deactivated": true, 3 "display_name": "string", 4 "file_name": "string", 5 "file_type": "string", 6 "id": "string", 7 "organization_id": "string", 8 "signed_url": "string", 9 "status": "PENDING", 10 "updated_at": "2023-01-01T00:00:00Z", 11 "updating_user_id": "string", 12 "version": 0, 13 "coverage": { 14 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 15 "side": "FRONT" 16 }, 17 "patient": { 18 "id": "string", 19 "notes": "string" 20 } 21 }

Adds an image. VersionConflictError is returned if a front or back of this coverage already exists.

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.