An array of patient codes from all patients directly owned by you
All Patients
GET
/patients/all
Response:
patients
An array of patient codes from all patients associated with you
Patients From a Team
POST
/patients/teams
Expected body:
teams
REQUIRED - An array of team codes
Response:
Array of Team Project objects:
team_name
Current team project name
code
Current team project code
patients
An array of patient codes from all patients participating in this project
Professionals
Team Members
POST
/professionals/teams
Expected body:
teams: An array of team codes
Response:
Array of Team Project objects:
team_name
Current team project name
code
Current team project code
professionals
An array of all professionals participating in the current project
[
name
The professional's full name
role
The professional's role in the team project (leader or member)
type
The professional's type (medical professional, researcher or caregiver)
]
Team Projects
Your Teams Projects
GET
/teams
Response:
teams
Team project codes from a project in which you participate
Your Organization's Teams
GET
/teams/organization
Response:
teams
Team project codes from your organization
Patient Data
Health Profile
POST
/data/profile
Expected body:
patients
REQUIRED - An array of patient codes
Response:
Array of Patient Profile Data objects:
code
the current patient's code
gender
male, female or "unspecified"
date_of_birth
in yyyy/mm/dd format or "unspecified"
country
in Alpha-2 (ISO 3166) nomenclature or "unspecified"
weight_kg
patient's weight measured in Kg or "unspecified"
blood_type
one of A+, A-, B+, B-, AB+, AB-, O+, O- or "unspecified"
diagnosed_diseases
textual description or "none"
other_conditions
textual description or "none"
Sensor Data Bundle
POST
/data/sensor-bundle
Expected body:
patients
REQUIRED - An array of patient codes
sensor_list
REQUIRED - An array of sensors to obtain data for. Possible values: "adpd", "adxl", "ecg", "eda", "pedometer", "ppg", "syncppg", "temperature", "bcm", "sqi"
start_date
OPTIONAL - Defines a minimum timestamp to request data for in yyyy-mm-dd hh:mm:ss format
end_date
OPTIONAL - Defines a maximum timestamp to request data for in yyyy-mm-dd hh:mm:ss format
Response:
Array of Data Collection objects:
patient
sequential number given to each patient that has their data downloaded
data
array of all sensor data collections for the patient where each collection is an array of sensor data
Prescribe Medication
POST
/medication/add
Expected body:
patient
REQUIRED - string value with the patient's code
medication_name
REQUIRED - string value with the medication name
medication_dosage
REQUIRED - numeric value with the medication's dosage per pill in mg
medication_type
REQUIRED - string value defining the type of medication. Possible values: "capsule", "pill", "syrup","supository","other"
periodicity
OPTIONAL - numeric value of periodicity in days of the intakes
start_timestamp
REQUIRED - defines the starting timestamp of the treatment in yyyy-mm-dd hh:mm:ss format
treatment_duration
OPTIONAL - numeric value of the treatment duration in days
scheduled_intakes
REQUIRED - array with the medication schedule for a day defined as:
[
intake_time
REQUIRED - string with time value in the format "hh:mm"
pills_per_intake
REQUIRED - numeric value of the number of pills to take at the defined time
]
Get Medication Schedule By Day
POST
/medication/view/day
Expected body:
patients
REQUIRED - An array of patient codes
date
REQUIRED - Date value in yyyy-mm-dd format to obtain the medication schedule for
Response:
Array of Medication prescription objects:
prescription_id
string value of the prescription's id
skin_temperature
numeric value of the skin temperature
patient
string value defining the patient which the prescription refers to
start_date
treatment start date in yyyy-mm-dd hh:mm:ss format
medication
description of the medication scheduled for intake
intake_time
time defined for an intake in hh:mm format
intake_amount
numeric value of the number of pills defined for an intake
End Treatment
POST
/medication/end-treatment
Expected body:
prescription_id
REQUIRED - String value of the prescription id
Add Medication Intake
POST
/medication-intake/add
Expected body:
prescription_id
REQUIRED - String value of the prescription id
date
REQUIRED - Date value in yyyy-mm-dd format
daily_intake_number
REQUIRED - Numeric value for the intake of the day
Remove Medication Intake
POST
/medication-intake/remove
Expected body:
prescription_id
REQUIRED - String value of the prescription id
date
REQUIRED - Date value in yyyy-mm-dd format
daily_intake_number
REQUIRED - Numeric value for the intake of the day
Add Crisis Event
POST
/crisis-event/add
Expected body:
patient
REQUIRED - string value with the patient's code
timestamp
REQUIRED - timestamp of the crisis event start in yyyy-mm-dd hh:mm:ss format
duration
REQUIRED - numeric value of the crisis event's duration in seconds
crisis_event
REQUIRED - string value with the crisis event name. Possible values: "ep_absence_seizure", "ep_seizure", "loss_balance", "loss_consciousness", "fall", "other"
notes
OPTIONAL - string value with a brief description of the crisis event
Get Crisis Event List
POST
/crisis-event/view
Expected body:
patients
REQUIRED - An array of patient codes
start_date
OPTIONAL - Defines a minimum timestamp to request data for in yyyy-mm-dd hh:mm:ss format
end_date
OPTIONAL - Defines a maximum timestamp to request data for in yyyy-mm-dd hh:mm:ss format
Response:
Array of Crisis Event objects:
crisis_date
date value of the crisis event in yyyy-mm-dd format
crisis_time
time value of the crisis event in hh:mm format
duration_in_seconds
numeric value of the duration in seconds of the crisis event
patient
the current patient's code
submitted_by_doctor
boolean value which defines if a crisis event was added by a professional or a patient