RXrxfoodapp
patient_report

Get the goal report of the patient for this week and last week.

get/patients/{patient_id}/goals/extended_weekly_report

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/patients/{patient_id}/goals/extended_weekly_report
  • Auth
    HTTP bearer

Path parameters

patient_idinteger required

Query parameters

date_sincestring required

reference date (today's date) in format YYYY-MM-DD

Example:2020-08-02
date_untilstring required

reference date (today's date) in format YYYY-MM-DD

Example:2020-09-02

Response

successful operation

changestring required
dates_excludestring[] nullable
end_datestring date-time required
goal_idinteger required
goal_image_urlstring nullable
goal_typestring required
missed_logging_opportunitiesinteger
patient_idinteger required
period'day' | 'week' | 'breakfast' | 'lunch' | 'dinner' | 'snack' | 'meal' required
range_success_countinteger required
range_total_countinteger required
range_valuenumber
start_datestring date-time required
statementstring required
target_display_namestring required
target_namestring required
target_unitstring nullable
target_valuenumber required

Example response

[
  {
    "change": "increase, decrease",
    "goal_type": "frequency, nutrient",
    "statement": "you met your goal 5 times out of 6",
    "target_display_name": "vitamin c",
    "target_name": "vitamin_c_mg",
    "target_unit": "mg"
  }
]

Changes

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