reporting

Get a patient report by id

get/reporting/patient_report/{patient_report_id}

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/reporting/patient_report/{patient_report_id}
  • Auth
    HTTP bearer

Path parameters

patient_report_idinteger required

Response

successful operation

clinic_idinteger
clinic_namestring
comp_date_sincestring

comparison calendar date in format YYYY-MM-DD

comp_date_untilstring

comparison calendar date in format YYYY-MM-DD

created_by_user_idinteger nullable
created_timestring date-time
date_sincestring

reference calendar date in format YYYY-MM-DD

date_untilstring

reference calendar date in format YYYY-MM-DD

dates_excludestring[]

calendar dates in format YYYY-MM-DD

hospital_idinteger
ignore_error_flagsboolean
is_archivedboolean
is_deletedboolean
is_read_onlyboolean

true after sent

patient_cgm_entry_idinteger
patient_country_of_residencestring
patient_idinteger required
patient_is_priorityboolean
patient_report_idinteger required
report_datestring date
report_sent_timestring date-time
report_typestring

base template file type

sectionsstring[] nullable
statusstring

status of report

updated_timestring date-time

Example response

{
  "comp_date_since": "2019-01-02",
  "comp_date_until": "2019-01-02",
  "date_since": "2019-01-02",
  "date_until": "2019-01-02",
  "dates_exclude": [
    "2019-01-02"
  ],
  "error_flags": [
    {
      "type": "nutrient"
    }
  ],
  "patient_report_summary_blocks": [
    {
      "report_section": "summary"
    }
  ]
}

Changes

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