Sign in
health_targets

Get the patient's health targets

get/patients/{patient_id}/health-targets

Path parameters

patient_idinteger required

Query parameters

include_archivedboolean

Response

successful operation

archive_reason'changed' | 'deleted' nullable
archived_timestring date-time nullable
categorystring required
created_by_user_idnumber
created_by_user_type'clinician' | 'patient' | 'system'
created_timestring date-time
idinteger nullable
is_pinnedboolean nullable
meal_slotsstring[] nullable
patient_idinteger required
target_aggregator'avg' | 'min' | 'max' | 'sum' | 'count'
target_namestring required
target_periodstring

Allowed values depend on the target category. Nutrient and water targets use week, day, breakfast, lunch, dinner, snack, and meal. Other categories use their category-specific supported periods.

target_range_highnumber nullable

upper end of the range; patient wants to stay below this value

target_range_lownumber nullable

lower end of the range; patient wants to stay above this value

target_range_type'above' | 'below' | 'within'
updated_timestring date-time

Changes