Tross
Demo dataBook a demo
EZDERM

Upload document

Upload a document to an existing folder.

POSThttps://preview.ontross.com/api/integrations/ezderm/upload-document

Upload a file

Send multipart/form-data with auth_id, input serialized as JSON text, and exactly one original file in files. Let your HTTP client set the Content-Type boundary. In Try it, select a connection, fill in the input fields and choose the file.

The file must be non-empty and no larger than 50 MiB. Use the provider’s input fields below to select the patient and document destination.

Request Fields
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
input.patient_id
string
required
Patient UUID, resolved from a medical record number by list-patients.
Example
"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93"
input.folder_path
string
required
The slash separated path you asked for, echoed back.
Example
"Questionnaire/Intake"
input.visible_for_patient
boolean
Whether the patient can see this document in their portal.
Example
false
Default
false
files
file
required
Exactly one original document file; send its bytes, not a path or base64 string.
Output Fields
file_id
string
EZDerm document id for the file you just uploaded.
Example
"e8c317a4-6f29-4d05-b782-93a60c1f254e"
patient_id
string
Patient UUID, resolved from a medical record number by list-patients.
Example
"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93"
folder_id
string
EZDerm id of the folder holding the document.
Example
"91a6f302-7db4-49c8-a560-2c18e7fb934d"
folder_path
string
The slash separated path you asked for, echoed back.
Example
"Questionnaire/Intake"
filename
string
Name of the attachment as it was uploaded.
Example
"intake-questionnaire.pdf"
mime_type
string
Content type guessed from the filename, octet-stream when unknown.
Example
"application/pdf"
size
integer
Size of the uploaded file in bytes.
Example
48216
visible_for_patient
boolean
Whether the patient can see this document in their portal.
Example
false
Code
curl 'https://preview.ontross.com/api/integrations/ezderm/upload-document' \
  -H 'X-API-Key: YOUR_API_KEY' \
  --form-string 'auth_id=YOUR_AUTH_ID' \
  --form-string 'input={"patient_id":"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93","folder_path":"Questionnaire/Intake","visible_for_patient":false}' \
  -F 'files=@document.pdf;type=application/pdf'
input form field (JSON)
{
  "patient_id": "3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93",
  "folder_path": "Questionnaire/Intake",
  "visible_for_patient": false
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "file_id": "e8c317a4-6f29-4d05-b782-93a60c1f254e",
    "patient_id": "3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93",
    "folder_id": "91a6f302-7db4-49c8-a560-2c18e7fb934d",
    "folder_path": "Questionnaire/Intake",
    "filename": "intake-questionnaire.pdf",
    "mime_type": "application/pdf",
    "size": 48216,
    "visible_for_patient": false
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}