RXrxfoodapp
metrics

Query the patient's HEI over a time period

get/metrics/patients/{patient_id}/HEI

Request

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

Path parameters

patient_idinteger required

Query parameters

date_sincestring required

calendar date in format YYYY-MM-DD

Example:2019-01-02
date_untilstring required

calendar date in format YYYY-MM-DD

Example:2019-01-02

Response

successful operation

date_sincestring required

calendar date in format YYYY-MM-DD

date_untilstring required

calendar date in format YYYY-MM-DD

patient_idinteger required

Example response

{
  "daily_hei_scores": [
    {
      "log_date": "2020-05-02"
    }
  ],
  "date_since": "2020-05-02",
  "date_until": "2020-05-10"
}

Changes

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