RXrxfoodapp
health_targets

Creates or updates a patient's health target

post/patients/{patient_id}/health-targets

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/patients/{patient_id}/health-targets
  • Auth
    HTTP bearer

Path parameters

patient_idinteger required

Request body

archive_reasonstring nullable
categorystring
idinteger nullable
is_pinnedboolean nullable
meal_slotsstring[] nullable

When target_period is meal; default breakfast, lunch, dinner

patient_idinteger
target_aggregator'avg' | 'min' | 'max' | 'sum' | 'count'
target_namestring
target_periodstring

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

target_range_highnumber nullable
target_range_lownumber nullable
target_range_type'above' | 'below' | 'within'

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

No recorded changes to this operation across all 19 revisions of this API.