PillReminderService¶
-
public interface
PillReminderService
¶ Pill reminder service supports creating/querying/deleting pill schedule as per prescription.
See also:
org.motechproject.pillreminder.contract.DailyPillRegimenRequest
Methods¶
createNew¶
-
void
createNew
(DailyPillRegimenRequest dailyPillRegimenRequest)¶ Subscribe to a pill reminder.
Parameters: - dailyPillRegimenRequest – the request for a daily pill regimen
See also:
org.motechproject.pillreminder.contract.DailyPillRegimenRequest
dosageStatusKnown¶
-
void
dosageStatusKnown
(Long pillRegimenId, Long dosageId, LocalDate lastCapturedDate)¶ Update the dosage take status. Marking a dosage status as known, will stop the module from sending repeat reminders.
Parameters: - pillRegimenId – subscription id
- dosageId – Dosage id
- lastCapturedDate – Dosage confirmation captured date.
getPillRegimen¶
-
PillRegimenResponse
getPillRegimen
(String externalId)¶ Get pill regimen for given subscriber (externalId).
Parameters: - externalId – the external ID set from regimen
Returns: Dosage details along with reminder config
See also:
org.motechproject.pillreminder.contract.PillRegimenResponse
remove¶
renew¶
-
void
renew
(DailyPillRegimenRequest newDailyScheduleRequest)¶ Update the pill reminder subscription
Parameters: - newDailyScheduleRequest – the request used for updating the subscription.
See also:
org.motechproject.pillreminder.contract.DailyPillRegimenRequest