Set Patient Alert Config

PUT

This endpoint updates your patient specific Alert Configurations for the type provided in the alertConfigurationType attribute of the Alert Configuration object and the patientId specified in the URL.

For more information see the AlertConfiguration Model.

Path parameters

patientIdlongRequired

Request

This endpoint expects an object.

alertConfigurationTypestringOptional

The type of alert configuration

enabledbooleanOptional

Whether this alert is enabled

notifyHealthCoachbooleanOptional

Whether to notify the health coach when the alert is triggered

notifyPatientbooleanOptional

Whether to notify the patient when the alert is triggered

configobjectOptional

Alert configuration rules. Structure varies by alertConfigurationType.

notificationEmailslist of stringsOptional

List of emails to notify when alert is triggered

alertConfigType"bloodPressure"OptionalDefaults to bloodPressure

PUT

1 curl -X PUT https://app.impiloplatform.com/api/v3/alerts/configuration/patient/1000000 \
2      -H "Impilo-API-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "alertConfigurationType": "bloodPressure",
6   "enabled": true,
7   "notifyHealthCoach": true,
8   "notifyPatient": true,
9   "config": {
10     "rules": [
11       {
12         "severity": "MEDIUM",
13         "field": "systolic",
14         "type": "threshold",
15         "value": 140,
16         "operator": "gt"
17       },
18       {
19         "severity": "MEDIUM",
20         "field": "systolic",
21         "type": "relative_change",
22         "value": 20,
23         "direction": "increase"
24       }
25     ]
26   },
27   "notificationEmails": [
28     "notificationEmail1@example.com",
29     "notificationEmail2@example.com"
30   ]
31 }'

Built with

1	curl -X PUT https://app.impiloplatform.com/api/v3/alerts/configuration/patient/1000000 \
2	-H "Impilo-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"alertConfigurationType": "bloodPressure",
6	"enabled": true,
7	"notifyHealthCoach": true,
8	"notifyPatient": true,
9	"config": {
10	"rules": [
11	{
12	"severity": "MEDIUM",
13	"field": "systolic",
14	"type": "threshold",
15	"value": 140,
16	"operator": "gt"
17	},
18	{
19	"severity": "MEDIUM",
20	"field": "systolic",
21	"type": "relative_change",
22	"value": 20,
23	"direction": "increase"
24	}
25	]
26	},
27	"notificationEmails": [
28	"notificationEmail1@example.com",
29	"notificationEmail2@example.com"
30	]
31	}'