Telehealth Public APIs
  1. General APIs
Telehealth Public APIs
  • Introduction
  • SSO Login
    • Generate SSO token
      POST
    • SSO Login
      GET
  • General APIs
    • Create Patient
      POST
    • Upload Patient File
      POST
    • Submit Patient's Form Response
      POST
    • Lab readings
      POST
    • Assign Service to Patient
      POST
    • Create Patient's Chart Note
      POST
    • Get Provider's Appointment Slots
      POST
    • Provider Sign Up
      POST
    • GraphQL Get Patient(s)
      POST
  1. General APIs

Upload Patient File

POST
/api/service/v1/patient/form/attachment
To initially upload any number of file(s) that the patient has uploaded in response to the questions of type "File". Once uploaded to our server, we shall give our unique id(s) of the file(s) uploaded in this API's response. Please use this unique id(s) of the file(s) while submitting the entire questionnaire's response. Allowed file types are .jpg/.jpeg, .png, .pdf and .heic
Path Variables: None
Query Parameters: None
Body Parameters:
FieldTypeDescription
attachments[]fileRequired. The user provided file(s) to be associated patient forms. The file(s) must be a file of type: jpg, jpeg, pdf, heic
Example Success Response:
Status: 200
[

{
"file_name": "prescription1.jpg",
"uuid": "4405a28c-c4d7-44f1-9546-e59b02f02643"
},
{
"file_name": "prescription2.png",
"uuid": "b7141288-17db-49b6-ba86-262d99e8b685"
},
{
"file_name": "prescription3.pdf",
"uuid": "6fd0b2f3-2b0c-4822-9156-ea12803334f6"
}
]
Example Failure Response:
Status: 400 or 403 or 500
{

"error_message": "Request Failed. {{error_message}}"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params multipart/form-data

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/service/v1/patient/form/attachment' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--form 'attachments[0]=@""' \
--form 'attachments[1]=@""' \
--form 'attachments[2]=@""'

Responses

🟢200Upload Patient File
application/json
Body

Example
[
    {
        "file_name": "prescription1.jpg",
        "uuid": "4405a28c-c4d7-44f1-9546-e59b02f02643"
    },
    {
        "file_name": "prescription2.png",
        "uuid": "b7141288-17db-49b6-ba86-262d99e8b685"
    },
    {
        "file_name": "prescription3.pdf",
        "uuid": "6fd0b2f3-2b0c-4822-9156-ea12803334f6"
    }
]
Modified at 2024-08-01 04:56:14
Previous
Create Patient
Next
Submit Patient's Form Response
Built with