RXrxfoodapp
subscription

Post a subscription to a patient

post/hospital/{hospital_id}/patients/{patient_id}/subscription

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/hospital/{hospital_id}/patients/{patient_id}/subscription
  • Auth
    HTTP bearer

Path parameters

hospital_idinteger required
patient_idinteger required

Request body

clinic_idinteger nullable

if relevant, provide the clinic id

expiration_datestring required

calendar date in format YYYY-MM-DD

name'three-day' | 'five-day' | 'seven-day' | 'ten-day' | 'one-month' | 'cgm14' | '14-day' | '21-day' | '28-day' | 'custom' required

name of the subscription

report_datestring nullable

calendar date in format YYYY-MM-DD. Must be equal to or greater than the expiration date

start_datestring required

calendar date in format YYYY-MM-DD

type'single' | 'weekly' | 'monthly' | 'bi-weekly' | '4-weeks' | 'custom' required

Example request

{
  "expiration_date": "2019-01-02",
  "name": "three-day",
  "report_date": "2019-01-05",
  "start_date": "2019-01-02"
}

Response

successful operation

clinic_idinteger
completion_timestring date-time
created_by_user_idinteger nullable
created_timestring date-time required
expiration_datestring required

calendar date in format YYYY-MM-DD

hospital_idinteger
idinteger required
is_completeboolean
is_logging_completeboolean
logging_completion_timestring date-time
name'three-day' | 'five-day' | 'seven-day' | 'ten-day' | 'one-month' | 'cgm14' | '14-day' | '21-day' | '28-day' | 'custom' required

name of the subscription

notified_of_logging_completionboolean
notified_of_logging_completion_timestring date-time
patient_idinteger required
report_datestring

calendar date in format YYYY-MM-DD.

start_datestring required

calendar date in format YYYY-MM-DD

subscription_lengthinteger nullable
type'single' | 'weekly' | 'monthly' | 'bi-weekly' | '4-weeks' | 'custom' required
updated_timestring date-time required

Example response

{
  "expiration_date": "2019-01-02",
  "name": "three-day",
  "report_date": "2019-01-05",
  "start_date": "2019-01-02"
}

Changes

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