Reminders
Reminders are records created to allow the practice to assist their clients with calls-to-action, an example is Annual Vaccinations where a reminder is created for 12 months later; alternatively a client has 3 months of treatment and the practice send treatment reminders to remind the client of compliance with the prescription, e.g. A reminder once a month for flea treatment.
Reminders within this domain come in 2 flavours:
- Patient Reminders - Used for single future reminder states and can be overwritten by more recent activity. Only 1 reminder per Category is active at any time.
- Treatment Reminders - Used for a series of reminders usually related to prescription compliance, each reminder is a record with it's own status.
Reminders in Merlin?
Treatment Reminders are called Compliance Reminders in the Merlin UI.
Patient Reminders remain under the same name.
Absent from this API are Appointment Reminders, this is because upcoming reminders can be requested from the calendar service.
Location Child Data
Reminders can be created at any time, usually during clinical recording being the trigger point. However this can be added or changed at any time, such as registration or patient sold, etc
The use of Patient and Treatment reminders are slightly different and have different usage rules:
Patient Reminder Rules
- Only 1 reminder is "active" at any one time per patient per reminder category
- Adding a new reminder to the same reminder category will replace the current one if the due date is later.
Treatment Reminder Rules
- Multiple reminders are active at the same time.
- Multiple records from the same clinical entry are possible and likely.
- Adding a new reminder where the formulary-uuid does not exist for the patient will have no additional rules applied.
- Adding a new reminder where the formulary-uuid does exist for the patient and the previous reminder date is less or equal to todays date, no additional rules are applied.
- Adding a new reminders where the formulary-uuid does exist for the patient, and the previous reminder date is more than todays date, the reminder date for the new reminder must be calculated as: last reminders date + formulary date range = submitted date.
Relationships
Reminders have references to Locations, Patients, Formulary, Clinical and Contacts.
Related Limitations
- When considering if a reminder should be used for a communiction activity, the integration must consider metadata within Patients and Contacts such as deceased status, sold status, deleted, etc
Calendar Schema
Cross Domain UUID References
| Reference | Domain | Resource | Note |
|---|---|---|---|
| location-uuid | location-management | /locations | Location that owns the reminder, e.g. work location. |
| contact-uuid | contact-management | /contacts | Identifies who will be contacted about the reminder. |
| patient-uuid | patient-management | /patients | Identifies the specific patient. |
| formulary-uuid | formulary-management | /services, /stock | Identifies the formulary configuration used to create the reminder. |
| clinical-history-uuid | clinical | /history | Identifies the work done which triggered the reminder. |
Security Scopes
The following authorisation scopes are required to access different resources within this domain:
- reminder:patient:read
- reminder:patient:create
- reminder:patient:update
- reminder:patient:remove
- reminder:treat:read
- reminder:treat:create
- reminder:treat:update
- reminder:treat:remove