COcollectly
patient_forms

Save and sign consent forms for patients.

Changed on

Save and sign consent forms for patients.

Form processing steps for now:
* received POST with consent form
1. save form
2. parse patient data, get or create patient in current company
3. bind form to patient
4. add payment method for patient:
* received POST with consent form signature data
5. update form: add signature, change status (unsigned => signed), enable payment method

We will void old unsigned forms after 1 hour of inactivity (change status to expired + remove card data)
get/patient_forms

Request

  • Base URL
    sandbox.collectly.co/api/api/partners/v1 (relative, and the document’s source URL is not known)
  • URL
    sandbox.collectly.co/api/api/partners/v1/patient_forms
  • Auth
    API key in header Authorization

Query parameters

pageinteger

Page number of dataset

per_pageinteger

Custom page size of dataset

sortstring

String with a comma-separated list of parameters by which to sort the dataset. To specify a descending order, add a "-" character before the parameter. For example, ?sort=-created_at,id

Response

OK

cardunknown
card_idinteger nullable
client_idinteger
companyinteger nullable
created_atunknown
dataunknown
date_of_birthstring date required
emailstring nullable
first_namestring required
form_typestring
guarantor_first_namestring nullable
guarantor_last_namestring nullable
idstring
last_namestring required
modified_atunknown
patient_idinteger
phonestring nullable
statusstring nullable
zip_codestring nullable

Changes