Create Patient

To add new patient and optionally book an appointment.

Path Variables: None

Query Parameters: None

Body Parameters:

Field	Type	Description
first_name	string	Required. First name of a patient.
middle_name	string	Optional. Middle name of a patient.
last_name	string	Required. Last name of a patient.
date_of_birth	date	Required. In "YYYY-MM-DD" format. Date of birth of a patient.
email	string	Required. Email address of a patient.
email_alt	string	Optional. Alternative email address of a patient.
country_code	string	Required with phone number. Country code for example "+1","+91" etc.
phone_number	string	Required. Phone number of a patient.
country_code_phone2	string	Optional. Required with phone number 2. Country code for example "+1","+91" etc.
phone_number_2	string	Optional. Alternative Phone number of a patient.
gender	string	Optional. If set then must be in "male" OR "female" OR "prefer_not_to_say".
language	string	Optinal. ISO locale code. For English use "en", For Spanish use "es", For Arabic use "ar", For Italian use "it", For Portuguese (Brazil) use "pt-BR", For French Canadian use "fr-ca", For Gujarati use "gu".
addr1	string	Optional. Address line 1.
addr2	string	Optional. Address line 2.
city	string	Optional. City.
state	string	Optional. State.
country	string	Optional. Country.
zip_code	string	Optional. Zip code of a patient.
mrn	string	Optional. MRN number of the patient.
password	string	Optional. Password of the patient. If not specified then system will generate it automatically.
customer_code	string	Optional. If specified then patient will be created for that specific practice. If not then patient will be created in the default practice.
service	string	Optional. Service of a patient. Must be from appointment services available in configurations.
height	decimal	Optional. Height of the patient.
height_unit	string	Optional. Required with "height". Must be in "cm" (i.e. centimeter) or "inch" (i.e. inches" or "ft" (i.e. foot).
primary_provider_email	string	Optional. Required if service_id is present. Email Address of Primary Provider. A provider must be exists in selected practice (using `customer_code` parameter), else it will return error.
devices	array	Optional. Multi-dimensional array of the devices to be attached with the patient. Contains keys "device_key", "serial_number", "shipment_date" and "shipment_number". Number of supported devices (Device Key along with device name) are as below: 1) ANDESFIT_ARM_BP_ADF_B19_BLOOD_PRESSURE: Andesfit Blood Pressure Arm ADF-B19 OR Wrist ADF-B102W 2) ANDESFIT_PULSE_OXIMETER_ADF_B06_OXIMETER: Andesfit Pulse Oximeter ADF-B06 3) ANDESFIT_NON_CONTACT_THERMOMETER_ADF_B38A_BODY_TEMPERATURE: Andesfit non-contact Thermometer ADF-B38A 4) A&D_MEDICAL_BP_BLOOD_PRESSURE_UA_651BLE: A&D Medical BP UA 651BLE 5) WELLUE_OXIMETER_OXYSMART: OxySmart Wellue Oximeter 6) A&D_MEDICAL_THERMOMETER_UT_201BLE_A : A&D Medical Thermometer UT 201BLE A 7) A&D Medical Weight UC 352BLE: A&D_MEDICAL_WEIGHT_UC_352BLE 8) ANDESFIT_WRIST_BP_ADF_102W_BLOOD_PRESSURE: Andesfit Blood Pressure Wrist ADF-102W 9) SMARTMETER_IBLOODPRESSURE: SmartMeter iBlood Pressure 10) DUO_ECG: Duo ECG 11) TELLIHEALTH_SPO2: TelliHealth spO2 12) TELLIHEALTH_BLOOD_PRESSURE: TelliHealth Blood Pressure 13) TELLIHEALTH_BLOOD_GLUCOSE: TelliHealth Blood Glucose 14) TELLIHEALTH_WEIGHT_SCALE: TelliHealth Weight Scale 15) TELLIHEALTH_THERMOMETER: TelliHealth Thermometer 16) OMRON_BCM_HBF_222T: OMRON Weight Scale HBF-222T 17) SMARTMETER_IBLOODGLUCOSE: SmartMeter iBlood Glucose 18) SMARTMETER_IWEIGHTSCALE: SmartMeter iWeight Scale 19) ACCUCHECK_GLUCOMETER: Accu-Chek Glucometer 20) SMARTMETER_ISPO2: SmartMeter iPulse-Ox Description of array keys are as given below.
devices.device_key	string	Required. Must be the key of device.
devices.serial_number	string	Required. Must be unique serial number of device.
devices.shipment_date	date	Optional. Must be in "YYYY-MM-DD" format. Shipment date of the device if any.
devices.shipment_number	string	Optional. Shipment number of the device if any.
custom_fields	array	Optional. Array of the custom fields to be attached with the patient. Custom fields can be of type textbox, single select drop-down, multi-select drop-down, numeric and date. You need to specify slug of a custom field as a key and value you want to add for that specific custom field. Custom field you specify in request body must be present on the Portal's Patients -> Custom fields menu, otherwise it will be neglected.
custom_fields.{{slug}}	string / number / date	Here, {{slug}} must be the slug of the custom fields created in Patients -> Custom Fields menu on Provider portal. The types of custom fields are: 1) Textbox 2) Number 3) Date 4) Drop-down (Single Select) 5) Drop-down (Multi Select)
service_id	number	Optional. Appointment Service Id. Required only while booking an appointment along with registering a new patient. The ID of the service. You can get it from Provider Portal -> Configurations Menu -> Appointment Config -> Appointment Services Tab -> Service ID column.
date	date	Optional. Appointment date. Must be in YYYY-MM-DD format. Required if service_id is present in the request body.
time	string	Optional. Appointment Time. Must be in HH:mm format. Required if service_id is present in the request body.
timezone	string	Optional. Appointment Timezone e.g. Asia/Kolkata.
reason_for_visit	string	Optional. Reason for visit for an appointment.

Example Request:

{
    "first_name"    : {{first_name}},
    "middle_name"   : {{middle_name}},
    "last_name"     : {{last_name}},
    "date_of_birth" : {{date_of_birth}},
    "email"         : {{email}},
    "email_alt"     : {{email_alt}},
    "country_code"  : {{country_code}},
    "phone_number"  : {{phone_number}},
    "country_code_phone2": {{country_code_phone2}},
    "phone_number2" : {{phone_number2}},
    "gender"        : {{gender}},
    "language"      : {{language}},
    "addr1"         : {{addr1}},
    "addr2"         : {{addr2}},
    "city"          : {{city}},
    "state"         : {{state}},
    "country"       : {{country}},
    "zip_code"      : {{zip_code}},
    "mrn"           : {{mrn}},
    "password"      : {{password}},
    "customer_code" : {{customer_code}},
    "service"       : {{service}},
    "height"        : {{height}},
    "height_unit"   : {{height_unit}},
    "primary_provider_email": {{primary_provider_email}},
    "devices":[
        {
            "device_key"       : {{device_key}},
            "serial_number"    : {{serial_number}},
            "shipment_date"    : {{shipment_date}},
            "shipment_number"  : {{shipment_number}}
        },
        {
            "device_key"       : {{device_key}},
            "serial_number"    : {{serial_number}},
            "shipment_date"    : {{shipment_date}},
            "shipment_number"  : {{shipment_number}}
        }
    ],
    "custom_fields": {
        {{custom-field1-slug}}: {{custom-field1-value}},
        {{custom-field2-slug}}: {{custom-field2-value}},
        {{multi-select-custom-field3-slug}}: {{custom-field3-value1, custom-field3-value2}}
    },
    "service_id": {{service_id}},
    "date": {{appointment_date}},
    "time": {{appointment_time}},
    "timezone": {{appointment_timezone}},
    "reason_for_visit": {{reason_for_visit}}
}

Example Success Response:
Status: 200

{
    "message": "Patient created successfully. A welcome email has been sent to the patient.",
    "patient_id": {{patient_id},
    "first_name": {{first_name}},
    "middle_name": {{middle_name}},
    "last_name": {{last_name}},
    "date_of_birth": {{date_of_birth}},
    "email": {{email}},
    "email_alt": {{email_alt}},
    "country_code": {{country_code}},
    "phone_number": {{phone_number}},
    "country_code_phone2": {{country_code_phone2}},
    "phone_number2": {{phone_number2}},
    "gender": {{gender}},
    "language": {{language}},
    "addr1": {{addr1}},
    "addr2": {{addr2}},
    "city": {{city}},
    "state": {{state}},
    "country": {{country}},
    "zip_code": {{zip_code}},
    "mrn": {{mrn}},
    "service": {{service}},
    "primary_provider_email": {{primary_provider_email}}
}

Example Failure Response:
Status: 400 or 403 or 500

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

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

text/plain

Body

Example

{
    "message": "Patient created successfully. A welcome email has been sent to the patient.",
    "patient_id": {{patient_id},
    "first_name": {{first_name}},
    "middle_name": {{middle_name}},
    "last_name": {{last_name}},
    "date_of_birth": {{date_of_birth}},
    "email": {{email}},
    "email_alt": {{email_alt}},
    "country_code": {{country_code}},
    "phone_number": {{phone_number}},
    "country_code_phone2": {{country_code_phone2}},
    "phone_number2": {{phone_number2}},
    "gender": {{gender}},
    "language": {{language}},
    "addr1": {{addr1}},
    "addr2": {{addr2}},
    "city": {{city}},
    "state": {{state}},
    "country": {{country}},
    "zip_code": {{zip_code}},
    "mrn": {{mrn}},
    "service": {{service}},
    "primary_provider_email": {{primary_provider_email}}
}

Request

Request Code Samples

Responses