Overview
Onboarding tools manage user profiles and patient information required for consultations.
get_user_profile
Get the current user’s Arlo Health profile and patient information.
Parameters
None required.
Returns
{
"accountId": "acc_abc123",
"status": "ONBOARDED",
"billingMode": "PAY_AS_YOU_GO",
"paymentStatus": "ACTIVE",
"onboardingComplete": true,
"patients": [
{
"patientId": "pat_xyz789",
"firstName": "John",
"lastName": "Doe",
"birthDate": { "year": 1990, "month": 3, "day": 15 },
"gender": "Male",
"province": "ON",
"isDefault": true,
"medications": [],
"conditions": [],
"allergies": []
}
]
}
| Field | Description |
|---|
accountId | The user’s account ID |
status | ONBOARDED, REGISTERED, etc. |
billingMode | NONE, PAY_AS_YOU_GO, SUBSCRIPTION |
paymentStatus | PENDING, ACTIVE, etc. |
onboardingComplete | Whether minimal onboarding is done |
patients | Array of patient profiles (self or dependents) |
Patient Fields
| Field | Description |
|---|
patientId | Unique patient identifier |
firstName, lastName | Patient’s name |
birthDate | Object with year, month, day |
gender | Female, Male, or Other |
province | Canadian province code |
isDefault | Whether this is the primary patient |
medications | List of current medications |
conditions | List of medical conditions |
allergies | List of allergies |
update_patient_info
Update patient information for onboarding or profile changes.
Required Fields for Onboarding
| Parameter | Type | Description |
|---|
firstName | string | Patient’s first name |
lastName | string | Patient’s last name |
birthDate | object | { year, month, day } |
gender | string | Female, Male, or Other |
country | string | CA or US |
province | string | Province/state code |
Completing Onboarding
| Parameter | Type | Description |
|---|
acceptTerms | boolean | Set to true to complete onboarding |
When acceptTerms=true and all required fields are present, the account status changes to ONBOARDED.
Optional Fields
| Parameter | Type | Description |
|---|
patientId | string | Patient ID to update (defaults to primary) |
phone | string | Phone number |
email | string | Email address |
address | string | Street address |
city | string | City |
zip | string | Postal code |
healthNumber | string | Provincial health card number |
Medical History Fields
These arrays replace existing values (not append):
| Parameter | Type | Description |
|---|
medications | array | [{ title, description }] |
conditions | array | [{ title, description }] |
allergies | array | [{ title, severity }] |
Example: Complete Onboarding
{
"firstName": "John",
"lastName": "Doe",
"birthDate": { "year": 1990, "month": 3, "day": 15 },
"gender": "Male",
"country": "CA",
"province": "ON",
"acceptTerms": true
}
Example: Update Medical History
{
"medications": [
{ "title": "Metformin", "description": "500mg twice daily" },
{ "title": "Lisinopril", "description": "10mg daily" }
],
"conditions": [
{ "title": "Type 2 Diabetes", "description": "Diagnosed 2020" },
{ "title": "Hypertension", "description": "Well controlled" }
],
"allergies": [
{ "title": "Penicillin", "severity": "severe" },
{ "title": "Sulfa drugs", "severity": "moderate" }
]
}
Province Codes
Canada: ON, BC, AB, SK, MB, QC, NB, NS, PE, NL, YT, NT, NU
US: AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, DC
validate_beta_code
Validate a beta access code for Arlo Health.
Arlo Health is in private beta. New users must validate a beta code before completing onboarding. Contact +1 (647) 494-0944 or keaton@arlohealth.ai for beta access. Parameters
| Parameter | Type | Required | Description |
|---|
betaCode | string | Yes | The beta access code to validate |
Returns
On success:
{
"valid": true,
"message": "Beta code validated successfully"
}
{
"valid": false,
"error": "Invalid beta code",
"contact": "+1 (647) 494-0944 or keaton@arlohealth.ai"
}
Usage
Call validate_beta_code before update_patient_info for new users:
const validation = await validateBetaCode({ betaCode: "BETA123" });
if (!validation.valid) {
// Prompt user to contact support for a valid code
return;
}
// Proceed with onboarding
await updatePatientInfo({
firstName: "John",
// ...
acceptTerms: true
});
