RXrxfoodapp
patient_report

Get the basic report of patients registered to all clinics this clinician belongs to.

Since this query assembles all nutrients and goal information of the patients in the clinic, this query takes quite a load on the backend. If just listing the patients in the clinic, please use GET /hospitals/{hospital_id}/clinics/{clinic_id}/patients.

get/hospitals/{hospital_id}/clinicians/{clinician_id}/patients_report

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/hospitals/{hospital_id}/clinicians/{clinician_id}/patients_report
  • Auth
    HTTP bearer

Path parameters

hospital_idinteger required
clinician_idinteger required

Query parameters

datestring required

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

Example:2019-01-02
active_patients_onlyboolean

include only active users (logged within 30 days, a future subscription, or has a draft report)

Response

successful operation

Example response

{
  "rows": [
    {
      "goals": [
        {
          "change": "increase, decrease",
          "goal_type": "frequency, nutrient",
          "target_display_name": "vitamin c",
          "target_name": "vitamin_c_mg",
          "target_unit": "mg"
        }
      ],
      "last_meal_date": "2019-01-02"
    }
  ]
}

Changes

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