Get Started

API Endpoint

https://api.hellotelemed.com

The Hello Telemed API provides programmatic access to create an appointments. Create or get the patient and doctor's account details alongwith appointment type to create appointments.

To use this API, you need an API Key. Please click Get Key to get your own API key.

Create New Doctor's Account

		
API Endpoint (POST)

https://api.hellotelemed.com/create-new-doctor-account
		
Result Response
		
{
    "status": 1,
    "message": "ok",
    "results": {
        "user": {
            "id": 2,
            "first_name": "Aqeeq",
            "last_name": "Abbas",
            "email": "xxxxx@xxxxx.com",
            "phone": "xxxxxxxxxx",
            "gender": "Male",
            "created_at": "2020-12-26T09:30:20.000000Z"
        }
    }
}

To create new doctor's account you need to make a POST call to the following url :
https://api.hellotelemed.com/create-new-doctor-account

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
email	String	(Required) Email address of doctor.
first_name	String	(Required) First name of doctor.
last_name	String	(Required) Last name of doctor
phone	String	(Optional) Phone number of doctor with country code (e.g +92 334 8088052)
gender	String	(Required) Gender of doctor from the following Male Female Unknown Other
emr_id	String	(Optional) EMR ID of the doctor
npi	String	(Optional) NPI of the doctor
birth_date	String	(Optional) Date of birth of the doctor (format: 1993-11-28)

Get Doctor's Details

		
API Endpoint (GET)

https://api.hellotelemed.com/get-doctor-details
		
Result Response
		
{
    "status": 1,
    "message": "ok",
    "results": {
        "user": {
            "id": 2,
            "first_name": "Aqeeq",
            "last_name": "Abbas",
            "email": "xxxxx@xxxxx.com",
            "phone": "xxxxxxxxxx",
            "gender": "Male",
            "created_at": "2020-12-26T09:30:20.000000Z"
        }
    }
}

To get the details of the doctor's account you need to make a GET call to the following url:
https://api.hellotelemed.com/get-doctor-details

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
user_id	Integer	(Required) ID of doctor.

Create New Patient's Account

		
API Endpoint (POST)

https://api.hellotelemed.com/create-new-patient-account
		
Result Response
		
{
    "status": 1,
    "message": "ok",
    "results": {
        "user": {
            "id": 2,
            "first_name": "Aqeeq",
            "last_name": "Abbas",
            "email": "xxxxx@xxxxx.com",
            "phone": "xxxxxxxxxx",
            "gender": "Male",
            "created_at": "2020-12-26T09:30:20.000000Z"
        }
    }
}

To create new patient's account you need to make a POST call to the following url :
https://api.hellotelemed.com/create-new-patient-account

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
email	String	(Required) Email address of patient.
first_name	String	(Required) First name of patient.
last_name	String	(Required) Last name of patient
phone	String	(Optional) Phone number of patient with country code (e.g +92 334 8088052)
gender	String	(Required) Gender of patient from the following Male Female Unknown Other
birth_date	String	(Optional) Date of birth of the patient (format: 1993-11-28)

Get Patient's Details

		
API Endpoint (GET)

https://api.hellotelemed.com/get-patient-details
		
Result Response
		
{
    "status": 1,
    "message": "ok",
    "results": {
        "user": {
            "id": 2,
            "first_name": "Aqeeq",
            "last_name": "Abbas",
            "email": "xxxxx@xxxxx.com",
            "phone": "xxxxxxxxxx",
            "gender": "Male",
            "created_at": "2020-12-26T09:30:20.000000Z"
        }
    }
}

To get the details of the patient's account you need to make a GET call to the following url:
https://api.hellotelemed.com/get-patient-details

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
user_id	Integer	(Required) ID of patient.

Get Appointment Types

		
API Endpoint (GET)

https://api.hellotelemed.com/get-appointment-type
		
Result Response
		
{
    "status": 1,
    "message": "ok",
    "results": {
        "appointments_types": [
            {
                "id": 1,
                "title": "Adhoc Video",
                "details": "This is the default appointment type created by the system.",
                "price": "0.00",
                "can_pay_at_clinic": 1,
                "created_at": "2020-12-25T15:12:26.000000Z"
            }
        ]
    }
}

To get the appointment types you need to make a GET call to the following url:
https://api.hellotelemed.com/get-appointment-type

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
appointment_type_id	Integer	(Optional) ID of apointment type.

Create New Appointment

		
API Endpoint (POST)

https://api.hellotelemed.com/create-new-appointment
		
Result Response
		
{
    "status": 1,
    "message": "ok",
    "results": {
        "appointment": {
            "id": 51224,
            "symptoms": "Headache",
            "appointment_at": "2020-12-31T09:12:26.000000Z",
            "title": "Adhoc Video",
            "details": "This is the default appointment type created by the system.",
            "video_duration": null,
            "patient_first_name": "Aqeeq",
            "patient_last_name": "Shah",
            "doctor_first_name": "Aqeeq",
            "doctor_last_name": "Shah",
            "created_at": "2020-12-26T22:55:40.000000Z"
        }
    }
}

To create new appointment you need to make a POST call to the following url :
https://api.hellotelemed.com/create-new-appointment

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your API key.
symptoms	String	(Required) Symptoms of the patient.
patient_id	Integer	(Required) ID of patient.
doctor_id	Integer	(Required) ID of doctor
appointment_type_id	Integer	(Required) ID of appointment type
appointment_time	String	(Required) Date of appointment with the doctor (format: 1993-11-28 11:10:00)
paid	Boolean	(Optional) Payment status 1 for paid , 0 for unpaid.
amount_paid	Decimal	(Optional) Total amount paid by patient.
payment_method	Integer	(Optional) Payment method of payment, 0 for pay cash at clinic, 1 for Paypal, 2 for Credit/Debit Card.

Status

The Hello Telemed API uses the following status codes:

Error Code	Meaning
1	Request is ok and successfull.
-1	Request failed and check the message in `message` parameter in response.