User profile

There are two types of profiles that can be created -basic profile and medical profile. Basic profile allows you to store identity and demographic information about the user while the medical record keep track of the patient medical information and basic history (refer to the glossary for more).

The basic profile is the minimum requirement for creating the profile and the ID generated will be used in every API request made for the user. See the details below.

Field

Type

Description

Required

first_name

string

First name of the user

True

last_name

string

Last name of the user

True

dob

string

Date of birth of the user. Required format is dd/MM/yyyy

False

gender

string

Gender of the user. Value must be either male or female

False

email

string

Email address of the user

True

phone

string

Phone number of the user

False

image

file

Image to the uploaded

False

address

object

Address of the user. Refer to Address in the Glossary

False

Medical information are filled and generated on the fly and you can always update the information based using the UPDATE Patient endpoint. The table below shows the information stored in the medical profile of a user. None of these is required and can be left empty.

Field

Type

Description

height

number

Height of the user in ft

weight

number

Weight of the user in kg

family_medical_history

array of objects

allergies

array of strings

A list of the users allergies

vaccinations

array

Refer to the vaccinations in the glossary

medications

array of strings

List of medications the user is currently on

tranfusion_history

array

The list of all transfusions the patient have received in the past

sugeries

array

The list of surgeries undergone by the user in the past. Refer to surgeries in the glossary

All data generated about a patient in your integration is made available to via the GET Patient endpoint.