Name | Description | Type | Additional information |
---|---|---|---|
pillphoto |
The pill photo |
ApiFileUpload |
None. |
labelphoto |
The label photo |
ApiFileUpload |
None. |
RemovePillPhoto |
If true and pillPhoto is null, remove the existing pill photo |
boolean |
None. |
RemoveLabelPhoto |
If true and labelPhoto is null, remove the existing label photo |
boolean |
None. |
Name |
Medication Name |
string |
Required |
Form |
Form of the medication (e.g. pill, tablet, capsule, etc.) |
string |
None. |
StandardDosage |
Standard dosage (from RXTerms API) |
string |
String length: inclusive between 0 and 255 |
CustomDosage |
Custom dosage |
string |
String length: inclusive between 0 and 255 |
Frequency |
Frequency (Legacy free text) |
string |
None. |
Active |
Whether or not this medication is currently being taken |
boolean |
None. |
StartDate |
Date the care recipient started taking the medication |
date |
Data type: Date |
EndDate |
Date the care recipient stopped taking or will stop taking the medication |
date |
Data type: Date |
LastRefillDate |
Date the medication was last filled |
date |
Data type: Date |
RefillsRemaining |
Number of refills remaining |
integer |
None. |
Reason |
Why the medication is being taken |
string |
None. |
Notes |
Additional notes |
string |
Data type: MultilineText String length: inclusive between 0 and 2048 |
RXCUI |
Unique ID for RX APIs |
string |
None. |
LastUpdated |
When the medication was last updated |
date |
None. |
LastUpdatedBy |
Who last updated the medication |
string |
None. |
SendReminders |
Whether or not to send reminders for missed(?) dosages |
boolean |
None. |
MedicationFrequency |
Frequency of dosages |
MedicationFrequency |
None. |
DaysOfWeek |
Which days of the week the medication is taken |
Weekday |
None. |
NextDoseDate |
The "next" dose date (if this is a date in the past, use it to calculate the next date) |
date |
None. |
DailyFrequency |
Daily frequency type |
MedicationDailyFrequency |
None. |
DailyTimesValue |
If DailyFrequency = TimesPerDay, DailyTimesValue = number of times. If DailyFrequency = XHours, DailyTimesValue = X |
integer |
None. |
DoseTimes |
; separated list of times when the doses are taken |
string |
None. |