Skip to main content
POST
Create a patient profile

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

client-id
string
required
Example:

"androiddoc"

Body

application/json
fn
string
required

First name (will be converted and stored in lowercase)

Example:

"eka"

dob
string<date>
required
Example:

"2000-01-02"

gen
enum<string>
required

Gender

Available options:
M,
F,
O
Example:

"M"

mn
string

Middle name (will be converted and stored in lowercase)

Example:

"eka"

ln
string

Last name (will be converted and stored in lowercase)

Example:

"user"

fln
string

Full name (will be converted and stored in lowercase)

Example:

"eka user"

s
string

Salutation (optional)

Example:

"Dr"

bloodgroup
enum<string>

Blood group of the patient

Available options:
A+,
A-,
B+,
B-,
AB+,
AB-,
O+,
O-
Example:

"A+"

mobile
string

Mobile number of the patient ( with country code )

Example:

"+916000000000"

email
string<email>

Email address of the patient (will be converted and stored in lowercase)

Example:

"testuser@eka.care"

username
string

Unique UHID| partner id | username for the patient

Example:

"UH0001"

abha
string

ABHA address of the patient

Example:

"xyz@abdm"

extras
object

Additional arbitrary data as a JSON object

Restrictions:

  • Nested lists are NOT allowed
  • Dictionaries inside lists are NOT allowed
  • Only one level of nesting is allowed in dictionaries
  • Keys starting with _ will be ignored
  • Key length must not exceed 16 characters
Example:

Response

Patient created successfully

oid
string

Unique identifier for the patient. Use this ID to retrieve the patient profile.

Example:

"1876816818618681"