Driver's license

Driver's license feature allows the user add, modify, delete and view the patient's driving license image.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Endpoints

Add patient's driver's license document
POST
/v1/{practiceid}/patients/{patientid}/driverslicense

Create a record of patient's driving license document

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
departmentid string The department ID associated with this upload.
image string Base64 encoded image, or, if multipart/form-data, unencoded image. This image may be scaled down after submission. PUT is not recommended when using multipart/form-data. Since POST and PUT have identical functionality, POST is recommended.

Output Parameters

Expand all
success string Indicates whether the submission was successful.
Example Code
Get patient's driver's license document
GET
/v1/{practiceid}/patients/{patientid}/driverslicense

Retrieves patient's driving license documents

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

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 driver's license document
PUT
/v1/{practiceid}/patients/{patientid}/driverslicense

Modifies patient's driving license documents

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
departmentid string The department ID associated with this upload.
image string Base64 encoded image, or, if multipart/form-data, unencoded image. This image may be scaled down after submission. PUT is not recommended when using multipart/form-data. Since POST and PUT have identical functionality, POST is recommended.

Output Parameters

Expand all
success string Indicates whether the submission was successful.
Example Code
Delete patient's driver's license document
DELETE
/v1/{practiceid}/patients/{patientid}/driverslicense

Deletes the record of a patient's driving license

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

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