DailyPillRegimenRequest

public class DailyPillRegimenRequest

Daily Pill Regimen Request represents medicine prescription details and reminder configuration.

See also: DosageRequest

Constructors

DailyPillRegimenRequest

public DailyPillRegimenRequest(String externalId, int pillWindowInHours, int reminderRepeatIntervalInMinutes, int bufferTimeForPatientToTakePill, List<DosageRequest> dosageRequests)

Creates Daily Pill prescription for given subscriber id and reminder configuration

Parameters:
  • externalId – unique id for subscriber
  • pillWindowInHours – valid time range to retry the reminder in-case of subscriber unreachable, in hours
  • reminderRepeatIntervalInMinutes – wait time before 2 reminder retries
  • bufferTimeForPatientToTakePill – additional wait time before sending reminder. (Time to take pill typically 5 min) when set to 5, If pill time is 9:00 am then reminder will be set out at 9:05 am.
  • dosageRequests – Dosage detail with dose time and medicine list. DosageRequest

Methods

getBufferOverDosageTimeInMinutes

public int getBufferOverDosageTimeInMinutes()

Returns the buffer over dosage time in minutes. The first reminder will be fired after this time passes from the dosage time if no there was no adherence confirmation.

Returns:the time in minutes after the first reminder will be sent, if no adherence confirmation was received for the regimen

getDosageRequests

public List<DosageRequest> getDosageRequests()
Returns:all dosage requests scheduled for pill reminder

getExternalId

public String getExternalId()
Returns:unique Id representing subscriber

getPillWindowInHours

public int getPillWindowInHours()
Returns:valid time range to retry the reminder in-case of subscriber unreachable, in hours

getReminderRepeatIntervalInMinutes

public int getReminderRepeatIntervalInMinutes()

Repeat interval for dosage reminder in-case not able reach subscriber.

Returns:number of minutes to wait before next retry for the reminder.

setBufferOverDosageTimeInMinutes

public void setBufferOverDosageTimeInMinutes(int bufferOverDosageTimeInMinutes)

Sets the buffer over dosage time in minutes. The first reminder will be fired after this time passes from the dosage time if there was no adherence confirmation.

Parameters:
  • bufferOverDosageTimeInMinutes – the time in minutes after the first reminder will be sent, if no adherence confirmation was received for the regiment