Insurance Card Image

The Insurance Card Image feature allows user to add, delete or modify an insurance card image to an insurance policy for a patient. To add an image associated with the patient but not yet created as an insurance policy, see POST /patients/{patientid}/documents using documentclass - ADMIN_INSURANCECARD.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Upload patient's insurance-card image
POST
/v1/{practiceid}/patients/{patientid}/insurances/{insuranceid}/image

Uploads the patient's insurance card image

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

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

Output Parameters

Expand all
success string Indicates whether the submission was successful.
Example Code
Get patient's insurance-card image
GET
/v1/{practiceid}/patients/{patientid}/insurances/{insuranceid}/image

Retrieve the patient's insurance card image

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
insuranceid integer insuranceid
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 existing patient's insurance-card image
PUT
/v1/{practiceid}/patients/{patientid}/insurances/{insuranceid}/image

Modifies existing patient's insurance-card image

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

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

Output Parameters

Expand all
success string Indicates whether the submission was successful.
Example Code
Delete patient's insurance-card image
DELETE
/v1/{practiceid}/patients/{patientid}/insurances/{insuranceid}/image

Delete the record of the patient's insurance card image

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
insuranceid integer insuranceid

Output Parameters

Expand all
success string Indicates whether the submission was successful.
Example Code