Skip to main content
API docs by Redocly

Reminders (3.0.0)

Patient Reminder

Access and Manage Patient Reminders and metadata

Retrieve Patient Reminders

Retrieve a list of patient reminders

query Parameters
required
object (Pageable)

Pageable parameters

location-uuid
string <uuid>
Example: location-uuid=C303E77E-6354-4B98-AE88-62B693A49472
reminder-type-uuid
string <uuid>
Example: reminder-type-uuid=1733F6F1-A0D5-43AF-A3A7-C157D0CCF995
contact-uuid
string <uuid>
Example: contact-uuid=FF4BC87F-E545-46CF-A3DA-4860FAA48B27
patient-uuid
string <uuid>
Example: patient-uuid=FD4B24D1-5780-4574-A91D-B34401B3225B
formulary-uuid
string <uuid>
Example: formulary-uuid=E0C58F76-7D3A-4CA1-9A01-4691AE563734
clinical-history-uuid
string <uuid>
Example: clinical-history-uuid=61319EF2-A54E-48D8-A795-3B6FF9DCD2F1
active
boolean
Example: active=true
due-date-start
string <date>
Example: due-date-start=2021-12-06
due-date-end
string <date>
Example: due-date-end=2021-12-12
modified-start
string <date-time>
Example: modified-start=2021-12-02T00:00:00Z
modified-end
string <date-time>
Example: modified-end=2021-12-03T00:00:00Z

Responses

Response Schema: application/json
Array of objects (PatientReminder)
Array
patient-reminder-uuid
string <uuid>
location-uuid
string <uuid>
reminder-type-uuid
string <uuid>
contact-uuid
string <uuid>
patient-uuid
string <uuid>
treated-date
string <date>
due-date
string <date>
description
string
recall-length
integer
recall-period
string
Enum: "DAY" "WEEK" "MONTH"
active
boolean
formulary-uuid
string <uuid>
clinical-history-uuid
string <uuid>
created-date
string <date-time>
modified-date
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "patient-reminder-uuid": "AD0090FA-E3C2-489A-81E8-7D672BF13008",
      • "location-uuid": "887DEBD8-941C-45B4-BA70-59661DBE5C00",
      • "reminder-type-uuid": "BD15C251-2D7F-4FF3-8EA3-568A31CC1E1F",
      • "contact-uuid": "2B02676F-518D-40A7-855B-32A51ABC3E6F",
      • "patient-uuid": "CFCD812E-80BD-4B30-94CA-EE53F8B2FFC3",
      • "treated-date": "2021-09-01",
      • "due-date": "2021-12-01",
      • "description": "Reminder description",
      • "recall-length": 3,
      • "recall-period": "MONTH",
      • "active": true,
      • "formulary-uuid": "33F8F10D-591E-4F7D-9FB9-0BAA4BFBC53E",
      • "clinical-history-uuid": "F787D8C6-9CAA-4FB9-9AD2-E9D6D65B599A",
      • "created-date": "2024-12-10T13:47:10Z",
      • "modified-date": "2024-12-10T13:47:10Z"
      }
    ]
}

Retrieve Deleted Patient Reminders

Retrieve a list of deleted patient reminders

query Parameters
required
object (Pageable)

Pageable parameters

location-uuid
string <uuid>
Example: location-uuid=C303E77E-6354-4B98-AE88-62B693A49472
contact-uuid
string <uuid>
Example: contact-uuid=FF4BC87F-E545-46CF-A3DA-4860FAA48B27
patient-uuid
string <uuid>
Example: patient-uuid=FD4B24D1-5780-4574-A91D-B34401B3225B
due-date-start
string <date>
Example: due-date-start=2024-12-06
due-date-end
string <date>
Example: due-date-end=2024-12-12
deleted-start
string <date-time>
Example: deleted-start=2024-06-07T15:50:00.00Z
deleted-end
string <date-time>
Example: deleted-end=2024-07-07T15:50:00.00Z

Responses

Response Schema: application/json
Array of objects (PatientReminder)
Array
patient-reminder-uuid
string <uuid>
location-uuid
string <uuid>
reminder-type-uuid
string <uuid>
contact-uuid
string <uuid>
patient-uuid
string <uuid>
treated-date
string <date>
due-date
string <date>
description
string
recall-length
integer
recall-period
string
Enum: "DAY" "WEEK" "MONTH"
active
boolean
formulary-uuid
string <uuid>
clinical-history-uuid
string <uuid>
created-date
string <date-time>
modified-date
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "patient-reminder-uuid": "AD0090FA-E3C2-489A-81E8-7D672BF13008",
      • "location-uuid": "887DEBD8-941C-45B4-BA70-59661DBE5C00",
      • "reminder-type-uuid": "BD15C251-2D7F-4FF3-8EA3-568A31CC1E1F",
      • "contact-uuid": "2B02676F-518D-40A7-855B-32A51ABC3E6F",
      • "patient-uuid": "CFCD812E-80BD-4B30-94CA-EE53F8B2FFC3",
      • "treated-date": "2021-09-01",
      • "due-date": "2021-12-01",
      • "description": "Reminder description",
      • "recall-length": 3,
      • "recall-period": "MONTH",
      • "active": true,
      • "formulary-uuid": "33F8F10D-591E-4F7D-9FB9-0BAA4BFBC53E",
      • "clinical-history-uuid": "F787D8C6-9CAA-4FB9-9AD2-E9D6D65B599A",
      • "created-date": "2024-12-10T13:47:10Z",
      • "modified-date": "2024-12-10T13:47:10Z"
      }
    ]
}

Retrieve Patient Reminder Types

Retrieve a list of Reminder Type objects

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (PatientReminderType)
Array
reminder-type-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>
always-show-in-summary
boolean
treatment-type-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "reminder-type-uuid": "150AA2D3-5491-4511-96AE-E7E3588C2625",
      • "name": "Visit",
      • "description": "Visit",
      • "view-order": 0,
      • "always-show-in-summary": true,
      • "treatment-type-uuid": "FB9551C7-A47F-429C-B634-0A70DF93C26E"
      }
    ]
}

Treatment Reminder

Access and Manage treatment reminders (compliance reminders)

Retrieve Treatment Reminders

Retrieve a list of treatment reminders

query Parameters
required
object (Pageable)

Pageable parameters

contact-uuid
string <uuid>
Example: contact-uuid=9D18B742-0682-4DF9-8542-8BBCFD481EDC
patient-uuid
string <uuid>
Example: patient-uuid=79BEDCCA-3693-4AAA-B0BB-E20740AB685F
sent-reminder
boolean
reminder-date-start
string <date-time>
Example: reminder-date-start=2021-12-06T00:00:00Z
reminder-date-end
string <date-time>
Example: reminder-date-end=2021-12-07T00:00:00Z
modified-start
string <date-time>
Example: modified-start=2021-12-02T00:00:00Z
modified-end
string <date-time>
Example: modified-end=2021-12-03T00:00:00Z

Responses

Response Schema: application/json
Array of objects (TreatmentReminder)
Array
treatment-reminder-uuid
string <uuid>
contact-uuid
string <uuid>
patient-uuid
string <uuid>
location-uuid
string <uuid>
formulary-uuid
string <uuid>
clinical-history-uuid
string <uuid>
reminder-date
string <date-time>
sent-reminder
boolean
sent-date
string <date-time>
reminder-message
string
created
string <date-time>
created-by
string
modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "treatment-reminder-uuid": "6480F26F-2235-4B10-A7D7-3988D1A387FE",
      • "contact-uuid": "9B3EADDB-3B44-4731-99A1-08A93C3CCF35",
      • "patient-uuid": "657ECF70-A1C6-4965-A835-50DE2370BD78",
      • "location-uuid": "1CBEA286-4C52-4F82-BADA-C2C4FD2D729D",
      • "formulary-uuid": "4619F60A-FA4C-44FF-8BD6-DD252306DA56",
      • "clinical-history-uuid": "DF85D84B-A171-4E80-8C79-E4A4374C888D",
      • "reminder-date": "2021-12-25T00:00:00Z",
      • "sent-reminder": false,
      • "sent-date": "2021-12-10T13:47:10Z",
      • "reminder-message": "Reminder message text",
      • "created": "2021-12-10T13:47:10Z",
      • "created-by": "vet1",
      • "modified": "2021-12-10T13:47:10Z"
      }
    ]
}

Retrieve Deleted Treatment Reminders

Retrieve a list of deleted treatment reminders

query Parameters
required
object (Pageable)

Pageable parameters

contact-uuid
string <uuid>
Example: contact-uuid=9D18B742-0682-4DF9-8542-8BBCFD481EDC
patient-uuid
string <uuid>
Example: patient-uuid=79BEDCCA-3693-4AAA-B0BB-E20740AB685F
reminder-date-start
string <date-time>
Example: reminder-date-start=2021-12-06T00:00:00Z
reminder-date-end
string <date-time>
Example: reminder-date-end=2021-12-07T00:00:00Z
deleted-start
string <date-time>
Example: deleted-start=2021-12-02T00:00:00Z
deleted-end
string <date-time>
Example: deleted-end=2021-12-03T00:00:00Z

Responses

Response Schema: application/json
Array of objects (TreatmentReminder)
Array
treatment-reminder-uuid
string <uuid>
contact-uuid
string <uuid>
patient-uuid
string <uuid>
location-uuid
string <uuid>
formulary-uuid
string <uuid>
clinical-history-uuid
string <uuid>
reminder-date
string <date-time>
sent-reminder
boolean
sent-date
string <date-time>
reminder-message
string
created
string <date-time>
created-by
string
modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "treatment-reminder-uuid": "6480F26F-2235-4B10-A7D7-3988D1A387FE",
      • "contact-uuid": "9B3EADDB-3B44-4731-99A1-08A93C3CCF35",
      • "patient-uuid": "657ECF70-A1C6-4965-A835-50DE2370BD78",
      • "location-uuid": "1CBEA286-4C52-4F82-BADA-C2C4FD2D729D",
      • "formulary-uuid": "4619F60A-FA4C-44FF-8BD6-DD252306DA56",
      • "clinical-history-uuid": "DF85D84B-A171-4E80-8C79-E4A4374C888D",
      • "reminder-date": "2021-12-25T00:00:00Z",
      • "sent-reminder": false,
      • "sent-date": "2021-12-10T13:47:10Z",
      • "reminder-message": "Reminder message text",
      • "created": "2021-12-10T13:47:10Z",
      • "created-by": "vet1",
      • "modified": "2021-12-10T13:47:10Z"
      }
    ]
}