Patient Photo
Patient Photo feature allows the user to view, add, modify or delete the patient's image record in the system. The image size is limited to 300 kB.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
-
Primary
POSTGETDELETE
Upload patient's photo
POST
/v1/{practiceid}/patients/{patientid}/photo
Create a record of patient's image in the system
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
success
string
Indicates whether the submission was successful.
Example Code
Get patient's photo
GET
/v1/{practiceid}/patients/{patientid}/photo
Retrieves patient's image record
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
jpegoutput
string
If set to true, or if Accept header is image/jpeg, returns the image directly. (The image may be scaled.)
Output Parameters
Expand all
image
string
Base64 encoded image.
Example Code
Update patient's photo
PUT
/v1/{practiceid}/patients/{patientid}/photo
Modifies patient's image record
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
success
string
Indicates whether the submission was successful.
Example Code
Delete patient's photo
DELETE
/v1/{practiceid}/patients/{patientid}/photo
Deletes the patient's image record
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
Output Parameters
Expand all
success
string
Indicates whether the submission was successful.
Example Code
Get patient's photo thumbnail
GET
/v1/{practiceid}/patients/{patientid}/photo/thumbnail
Retrieves patient images in different sizes
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
jpegoutput
string
If set to true, or if Accept header is image/jpeg, returns the image directly. (The image may be scaled.)
Output Parameters
Expand all
image
string
Base64 encoded image.
Example Code