Field Reference Tables
Genders
Value | Description |
Male | Male |
Female | Female |
Other | Other / Non-binary / Prefer not to say |
Relationship Types
Used in the relationship_type field when creating or updating contacts.
Value | Description |
SPOUSE | Spouse or partner |
PARENT | Parent |
CHILD | Child |
SIBLING | Sibling |
IN_LAW | In-law |
GRANDPARENT | Grandparent |
GRANDCHILD | Grandchild |
FAMILY | Other family member |
FRIEND | Friend |
NEIGHBOR | Neighbor |
MEDICAL | Medical professional |
THERAPY | Therapist |
OTHER | Other |
Care Recipient Absence Reasons
Value | Description |
CANCELLED_BY_CARE_RECIPIENT | Care recipient cancelled |
CANCELLED_BY_CARE_PROVIDER | Care provider cancelled |
HOSPITAL_CARE_FACILITY | Admitted to hospital or care facility |
HOLIDAY | On holiday / vacation |
OTHER | Other reason |
Caregiver Absence Reasons
Value | Description |
PAID_LEAVE | Paid leave / vacation |
UNPAID_LEAVE | Unpaid leave |
PAID_SICK_LEAVE | Paid sick leave |
UNPAID_SICK_LEAVE | Unpaid sick leave |
SICK_CHILD | Sick child (paid) |
UNPAID_SICK_CHILD | Sick child (unpaid) |
TRAINING | Training / professional development |
OTHER | Other reason |
Cancelled Reasons (Visits)
Value | Description |
CANCELLED_BY_CARE_RECIPIENT | Care recipient cancelled the visit |
CANCELLED_BY_CARE_PROVIDER | Care provider cancelled the visit |
HOSPITAL_CARE_FACILITY | Care recipient admitted to hospital/facility |
HOLIDAY | Holiday |
RESCHEDULED | Visit was rescheduled to a different time |
OTHER | Other reason |
Visit Recurrence Types
Value | Description |
NO_REPEAT | One-time visit (default) |
DAILY | Repeats every day |
WEEKLY | Repeats every week on the same day |
EVERY_WEEKDAY | Repeats Monday through Friday |
MONTHLY | Repeats every month on the same date |
CUSTOM | Custom pattern — requires frequency, interval, and weekdays |
Activity Schedule Types
Value | Description |
ONE_OFF | Happens once |
EVERY_VISIT | Repeats on every visit for the care recipient |
FIXED_RECURRENCE | Repeats on a fixed weekly/daily pattern |
EVERY_N_DAYS | Repeats every N days |
VISIT_SERIES | Tied to a specific visit series |
Activity Priorities
Value | Description |
LOW | Low priority |
MEDIUM | Medium priority |
HIGH | High priority |
OPTIONAL | Optional — can be skipped if time is short |
Subject Types
Value | Used For |
CARE_RECIPIENT | Individual receiving home care |
CARE_HOME | A care home / facility |
Billing Types
Value | Description |
FIXED | Flat rate per visit regardless of duration |
HOURLY | Rate calculated per hour of visit duration |