The DRX Connect API empowers developers with the capability to access and retrieve crucial information
such as patient data, appointment details, and more from a clinic. This documentation outlines the steps
to obtain an API key, enabling seamless integration with the DRX Connect platform. Additionally,
it provides guidelines on essential operations, including record retrieval, updating appointment status,
and applying filters.
Obtaining an API Key
To use the DRX Connect API, you must first obtain an API Key. Follow these steps:
Visit the Admin Portal on
digitalrx.io
:
Navigate to the digitalrx.io admin portal to initiate the API key request process.
Sign in to Your Clinic: Sign in to your clinic account using your credentials to access the necessary settings.
Access 'My Account' Section: Within the 'My Account' section, locate and open the 'Settings' tab.
Navigate to DRX Connect Profile: Look for the DRX Connect card within the 'Settings' tab and click to visit the DRX Connect profile.
Enable DRX Connect Profile: If the DRX Connect profile is not enabled, activate it before proceeding with the API key request.
Request API Key: Once the profile is enabled, you will find an option to request an API key. Click on 'Add API Key' to initiate the process.
Create API Key: Provide essential information, including Site name, Server URL, and Contact email, to create your first API key.
Key Generation: Your API key will be generated within a few minutes. Copy the generated key, as you will need it to authenticate your requests.
Include API Key in Request Header: Append your request header with the API key value using the key name API-KEY to authenticate API requests.
You can also try to open this
Exploring API Functionality
To explore and test the functionality of the DRX Connect API, you can refer to the following
Postman documentation
. This resource provides detailed information on various API endpoints, request parameters, and sample requests.
For any further assistance or inquiries, please contact our support team at [support@email.com].
Note: Ensure that you handle your API key securely and follow best practices for API key management to protect sensitive information.
get doctor list
# Here is a curl example
curl
--location 'https://digitalrx.io/drx-connect/doctor/GetAll' \
--header 'Referer: https://my.first.com/' \
--header 'api-key: E58361E156894EFBBD037A607B6FBD58' \
To get doctor's list you need to make a GET call to the following url : https://digitalrx.io/drx-connect/doctor/getall
Your API key. Follow the top instruction to retrieve an Api Key
QUERY PARAMETERS
Field
Type
Description
pageIndex
Numeric
(optional) Page number you want to fetch. Example: 1, 2, 3. Default value is 1
pageSize
Numeric
(optional) Number of records a page will contain max. Default value is 10
RESPONSE PARAMETERS
Field
Type
Description
results
Array
Contains results object
pageIndex
Numeric
Page number you are currently in.
pageSize
Numeric
Number of records in the current page.
hasNextPage
Boolean
True if there are more records after this collections.
hasPreviousPage
Boolean
True if there are more records before this collections.
totalPages
Numeric
Number of pages available.
totalCount
Numeric
Number of records available in total.
doctorId
String
Unique identifier of a patient.
firstName
String
First name of the patient.
lastName
String
Last name of the patient.
imageUrl
String
Patient image url. Returns Null if there is no image provided
gender
String
Gender of the patient. Null if no gender is selected
designation
String
Designation of the doctor.
specialization
String
Specializations of the doctor.
get a doctor
# Here is a curl example
curl
--location 'https://digitalrx.io/drx-connect/doctor/getbyid' \
--header 'Referer: https://my.first.com/' \
--header 'api-key: E58361E156894EFBBD037A607B6FBD58' \
To get a doctor details you need to make a GET call to the following url : https://digitalrx.io/drx-connect/doctor/getbyid
Your API key. Follow the top instruction to retrieve an Api Key
QUERY PARAMETERS
Field
Type
Description
id
String
Unique idenitfier of the doctor
RESPONSE PARAMETERS
Field
Type
Description
doctorId
String
Unique identifier of a patient.
firstName
String
First name of the patient.
lastName
String
Last name of the patient.
email
String
Doctor's email address
imageUrl
String
Patient image url. Returns Null if there is no image provided
gender
String
Gender of the patient. Null if no gender is selected
designation
String
Designation of the doctor.
specialization
String
Specializations of the doctor.
GET A DOCTOR'S APPOINTMENT SLOTS
# Here is a curl example
curl
--location 'https://digitalrx.io/drx-connect/doctor/getappointmentslots' \
--header 'Referer: https://my.first.com/' \
--header 'api-key: E58361E156894EFBBD037A607B6FBD58' \
To get a doctor details you need to make a GET call to the following url : https://digitalrx.io/drx-connect/doctor/getappointmentslots
Result example :
{
"slots": [
{
"startOnUtc": "2024-01-18T17:00:00Z",
"endOnUtc": "2024-01-18T17:20:00Z"
},
{
"startOnUtc": "2024-01-18T17:25:00Z",
"endOnUtc": "2024-01-18T17:45:00Z"
}
],
"warnings": [
"Doctor has only 2 slots available"
]
}
HEADER PARAMETERS
Field
Type
Description
api-key
String
Your API key. Follow the top instruction to retrieve an Api Key
QUERY PARAMETERS
Field
Type
Description
id
String
Unique idenitfier of the doctor
onLocalDate
DateStamp
Schedule time for the appointment in user local time
timeZoneOffset
Numeric
Time difference of the user local time from UTC
RESPONSE PARAMETERS
Field
Type
Description
slots
Array
Array values of the slot objects.
warning
Array
An array containing warning messages if exists. This warning array can be empty.
startOnUtc
DateTime
UTC DateTime stamp for each slot start time.
endOnUtc
DateTime
UTC DateTime stamp for each slot end time.
get patient list
# Here is a curl example
curl
--location 'https://digitalrx.io/drx-connect/patient/GetAll' \
--header 'Referer: https://my.first.com/' \
--header 'api-key: E58361E156894EFBBD037A607B6FBD58' \
To get patient's list you need to make a GET call to the following url : https://digitalrx.io/drx-connect/patient/getall
Your API key. Follow the top instruction to retrieve an Api Key
QUERY PARAMETERS
Field
Type
Description
pageIndex
Numeric
(optional) Page number you want to fetch. Example: 1, 2, 3. Default value is 1
pageSize
Numeric
(optional) Number of records a page will contain max. Default value is 10
RESPONSE PARAMETERS
Field
Type
Description
results
Array
Contains results object
pageIndex
Numeric
Page number you are currently in.
pageSize
Numeric
Number of records in the current page.
hasNextPage
Boolean
True if there are more records after this collections.
hasPreviousPage
Boolean
True if there are more records before this collections.
totalPages
Numeric
Number of pages available.
totalCount
Numeric
Number of records available in total.
patientId
String
Unique identifier of a patient.
firstName
String
First name of the patient.
lastName
String
Last name of the patient.
imageUrl
String
Patient image url. Returns Null if there is no image provided
gender
String
Gender of the patient. Null if no gender is selected
dateOfBirth
Date
Date of birth in UTC/ISO string.
registeredOn
DateTime
Record creation date and time in UTC/ISO string.
phoneNumber
String
Patient's contact number.
get a patient by id
# Here is a curl example
curl --location 'https://digitalrx.io/drx-connect/patient/getbyid?id=DRX0000002' \
--header 'Referer: https://www.my.first.com/request' \
--header 'api-key: E58361E156894EFBBD037A607B6FBD58' \
To get a patient's details by their unique identifier you need to make a GET call to the following url : https://digitalrx.io/drx-connect/patient/getall
Your API key. Follow the top instruction to retrieve an Api Key
QUERY PARAMETERS
Field
Type
Description
id
String
This is the patient's unique id provided by Digital Rx
RESPONSE PARAMETERS
Field
Type
Description
patientId
String
This is the patient's unique id provided by Digital Rx
firstName
String
First name of the patient.
lastName
String
Last name of the patient.
imageUrl
String
Patient image url. Returns Null if there is no image provided
gender
String
Gender of the patient. Null if no gender is selected
dateOfBirth
Date
Date of birth in UTC/ISO string.
registeredOn
DateTime
Record creation date and time in UTC/ISO string.
phoneNumber
String
Patient's contact number.
Get all appointments
# Here is a curl example
curl --location 'https://digitalrx.io/drx-connect/appointment/getall?pageIndex=1&pageSize=3' \
--header 'Referer: https://www.my.first.com/request' \
--header 'api-key: E58361E156894EFBBD037A607B6FBD58' \
To get a clinic's all appointments you need to make a GET call to the following url : https://digitalrx.io/drx-connect/appointment/getall
# Here is a curl example
curl --location 'https://digitalrx.io/drx-connect/appointment/getbyuniqueid?uid=4fd22d0d' \
--header 'Referer: https://www.my.first.com/request' \
--header 'api-key: E58361E156894EFBBD037A607B6FBD58' \
To get an appointment details you need to make a GET call to the following url : https://digitalrx.io/drx-connect/appointment/getbyuniqueid
Your API key. Follow the top instruction to retrieve an Api Key
QUERY PARAMETERS
Field
Type
Description
uid
String
This is the appointment unique identifier provided by Digital Rx
RESPONSE PARAMETERS
Field
Type
Description
comment
String
Comments provided by the patient. A patient can specify the reason to book appointment
callDurations
Numeric
A numeric value to total minutes a patient and doctor is connected to a session. This value is
"Null" if the appointment is not completed or cancelled or even not the type of "VideoCall"
completed
Boolean
Returns True if the appointment is completed
cancelled
Boolean
Returns True if the appointment is cancelled
cancelledBy
String
Indicates who has cancelled the appointment. Possible values: "Doctor", "Patient"
or "Clinic"
cancellationReason
String
Reason why a patient cancelled the appointment. Null if the appointment is not expired or the reason
is not specified by the patient.
Contains patient object with all patient informations.
patient.patientId
String
This is the patient's unique id provided by Digital Rx
patient.firstName
String
First name of the patient.
patient.lastName
String
Last name of the patient.
patient.imageUrl
String
Patient image url. Returns Null if there is no image provided
patient.gender
String
Gender of the patient. Null if no gender is selected
patient.dateOfBirth
Date
Date of birth in UTC/ISO string.
patient.registeredOn
DateTime
Record creation date and time in UTC/ISO string.
patient.phoneNumber
String
Patient's contact number.
doctor
Object
Contains doctor object with the doctor's informations.
doctor.doctorId
String
Doctor's unique idenitfier in DRX Platform.
doctor.gender
String
Doctor's gender.
doctor.email
String
Doctor's email address.
doctor.firstName
String
Doctor's first name.
doctor.lastName
String
Doctor's last name.
doctor.imageUrl
String
Doctor's image source.
doctor.designation
String
Doctor's desigfnation.
doctor.specialization
String
Doctor's specializations.
appointmentUniqueId
String
Unique identifier of this appointment.
createdOn
DateTime
An ISO/UTC stamp for appointment booked time.
scheduledAt
DateTime
An ISO/UTC stamp for appointment scheduled time.
endAt
DateTime
An ISO/UTC stamp for appointment end time.
Get all appointments of a patient
# Here is a curl example
curl --location 'https://digitalrx.io/drx-connect/appointment/getbypatientid?id=DRX0000010&pageIndex=1&pageSize=3' \
--header 'Referer: https://www.my.first.com/request' \
--header 'api-key: E58361E156894EFBBD037A607B6FBD58' \
To get all appointments of a patient you need to make a GET call to the following url : https://digitalrx.io/drx-connect/appointment/getbypatientid