Sign in
supplement

Post a supplement to a patient

post/patients/{patient_id}/supplement

Path parameters

patient_idinteger required

Request body

commentstring nullable

comments relating to the supplement

frequency'daily' | 'weekly' | 'monthly' | 'hourly' | 'irregular' required
instructionsstring nullable

instructions

namestring required

name of the supplement

prescribed_bystring nullable

who has asked the patient to take the supplement

qty_per_frequencynumber required
qty_unit_of_measure'mcg' | 'g' | 'mg' | 'iu' | 'rae' | 'dfe' | 'ne' | 'tablet' required

Unit of Measure

qty_unit_sizenumber required
reason_for_takingstring nullable

why is the patient taking the supplement?

related_usda_idinteger nullable

if available in the food DB, include the USDA id for the nutrition link

Example request

{
  "comment": "under review by clinician",
  "name": "vitamin c",
  "qty_unit_of_measure": "mcg"
}

Response

successful operation

commentstring nullable

comments relating to the supplement

created_timestring date-time
frequencystring required

daily, weekly, monthly, hourly, irregular

idinteger required
instructionsstring nullable

instructions

namestring required

name of the supplement

patient_idinteger required
prescribed_bystring nullable

who has asked the patient to take the supplement

qty_per_frequencynumber required
qty_unit_of_measurestring required

Unit of Measure

qty_unit_sizenumber required
reason_for_takingstring nullable

why is the patient taking the supplement?

related_usda_idinteger nullable

if available in the food DB, include the USDA id for the nutrition link

updated_timestring date-time

Example response

{
  "comment": "under review by clinician",
  "name": "calcium",
  "qty_unit_of_measure": "mcg"
}

Changes

No recorded changes to this endpoint across all 15 revisions of this API.