GET Api/ParticipantVitalAlert/Get?alert_id={alert_id}&vital_type={vital_type}

This method finds a particpant level alert for a particpant and vital sign.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
alert_id

The unique id of the participant as assigned by TouchPointCare.

 integer

Required
vital_type

The type of vital: weight, bgm, systolic, diastolic, bpm, oxysat, temp, rr

 string

Required

Body Parameters

None.

Response Information

Resource Description

ParticipantVitalAlert
NameDescriptionTypeAdditional information
alert_id

The unique id of the participant as assigned by TouchPointCare

 integer

None.
vital_type

The type of vital using the following format:

  • weight - weight scale results
  • bgm - blood glucose measurement
  • bgmq - blood glucose qualifier (beore breakfast, after dinner, etc) *Not yet supported via API
  • bpm - heart rate (beats per minute)
  • diastolic - blood pressure diastolic
  • systolic - blood pressure systolic
  • motion - motion sensor trigger *Not yet supported via API
  • oxysat - Pulse Oxygen saturation
  • temp - Temperature
  • rr - Respiratory Rate
  • irreg - Irregular Heartbeat indicator *Not yet supported via API

 string

None.
min_value

The lower bounds of the alert threshold. Results above this value are valid.

 decimal number

None.
max_value

The upper bounds of the alert threshold. Results below this value are valid.

 decimal number

None.
min_value_send_email_alert

True/False flag to determine if an email alert should be sent if result value is below the min_value setting.

 boolean

None.
max_value_send_email_alert

True/False flag to determine if an email alert should be sent if result value is above the max_value setting.

 boolean

None.
min_value_add_to_group

True/False flag to determine if the participant should be added to a group if result value is below the min_value setting.

 boolean

None.
max_value_add_to_group

True/False flag to determine if the participant should be added to a group if result value is above the max_value setting.

 boolean

None.
min_value_group_id

The ID of the group to add the participant to if (a) the min_value_add_to_group flag is set to true and (b) the result value is below the min_value setting.

 integer

None.
max_value_group_id

The ID of the group to add the participant to if (a) the max_value_add_to_group flag is set to true and (b) the result value is above the max_value setting.

 integer

None.
min_value_group_id2

The second ID of the group to add the participant to if (a) the min_value_add_to_group flag is set to true and (b) the result value is below the min_value setting.

 integer

None.
max_value_group_id2

The second ID of the group to add the participant to if (a) the max_value_add_to_group flag is set to true and (b) the result value is above the max_value setting.

 integer

None.
min_value_start_time_delay

The start time delay (in minutes) determines the number of minutes after the alert is triggered to trigger any TouchPoints that result from adding the participant to the group.

 integer

None.
max_value_start_time_delay

The start time delay (in minutes) determines the number of minutes after the alert is triggered to trigger any TouchPoints that result from adding the participant to the group.

 integer

None.
ctl_decrease_by_value

Compared To Last - Resulting values that decrease by this value compared to last response trigger alert.

 decimal number

None.
ctl_increase_by_value

Compared To Last - Resulting values that increase by this value compared to last response trigger alert.

 decimal number

None.
ctl_decrease_send_email_alert

Compared To Last - True/False flag to determine if an email alert should be sent if result value decreases by the ctl_decrease_by_value setting.

 boolean

None.
ctl_increase_send_email_alert

Compared To Last - True/False flag to determine if an email alert should be sent if result value increases by the ctl_increase_by_value setting.

 boolean

None.
ctl_decrease_add_to_group

Compared To Last - True/False flag to determine if the participant should be added to a group if result value is below the ctl_decrease_by_value setting.

 boolean

None.
ctl_increase_add_to_group

Compared To Last - True/False flag to determine if the participant should be added to a group if result value is above the ctl_increase_by_value setting.

 boolean

None.
ctl_decrease_group_id

Compared To Last - The ID of the group to add the participant to if (a) the ctl_decrease_add_to_group flag is set to true and (b) the result value is below the ctl_decrease_by_value setting.

 integer

None.
ctl_increase_group_id

Compared To Last - The ID of the group to add the participant to if (a) the ctl_increase_send_email_alert flag is set to true and (b) the result value is above the ctl_increase_by_value setting.

 integer

None.
ctl_decrease_group_id2

Compared To Last - The second ID of the group to add the participant to if (a) the ctl_decrease_add_to_group flag is set to true and (b) the result value is below the ctl_decrease_by_value setting.

 integer

None.
ctl_increase_group_id2

Compared To Last - The second ID of the group to add the participant to if (a) the ctl_increase_send_email_alert flag is set to true and (b) the result value is above the ctl_increase_by_value setting.

 integer

None.
ctl_decrease_start_time_delay

Compared To Last - The start time delay (in minutes) determines the number of minutes after the alert is triggered to trigger any TouchPoints that result from adding the participant to the group.

 integer

None.
ctl_increase_start_time_delay

Compared To Last - The start time delay (in minutes) determines the number of minutes after the alert is triggered to trigger any TouchPoints that result from adding the participant to the group.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "alert_id": 1,
  "vital_type": "sample string 2",
  "min_value": 1.0,
  "max_value": 1.0,
  "min_value_send_email_alert": true,
  "max_value_send_email_alert": true,
  "min_value_add_to_group": true,
  "max_value_add_to_group": true,
  "min_value_group_id": 1,
  "max_value_group_id": 1,
  "min_value_group_id2": 1,
  "max_value_group_id2": 1,
  "min_value_start_time_delay": 1,
  "max_value_start_time_delay": 1,
  "ctl_decrease_by_value": 1.0,
  "ctl_increase_by_value": 1.0,
  "ctl_decrease_send_email_alert": true,
  "ctl_increase_send_email_alert": true,
  "ctl_decrease_add_to_group": true,
  "ctl_increase_add_to_group": true,
  "ctl_decrease_group_id": 1,
  "ctl_increase_group_id": 1,
  "ctl_decrease_group_id2": 1,
  "ctl_increase_group_id2": 1,
  "ctl_decrease_start_time_delay": 1,
  "ctl_increase_start_time_delay": 1
}

application/xml, text/xml

Sample: 
<ParticipantVitalAlert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <alert_id>1</alert_id>
  <ctl_decrease_add_to_group>true</ctl_decrease_add_to_group>
  <ctl_decrease_by_value>1</ctl_decrease_by_value>
  <ctl_decrease_group_id>1</ctl_decrease_group_id>
  <ctl_decrease_group_id2>1</ctl_decrease_group_id2>
  <ctl_decrease_send_email_alert>true</ctl_decrease_send_email_alert>
  <ctl_decrease_start_time_delay>1</ctl_decrease_start_time_delay>
  <ctl_increase_add_to_group>true</ctl_increase_add_to_group>
  <ctl_increase_by_value>1</ctl_increase_by_value>
  <ctl_increase_group_id>1</ctl_increase_group_id>
  <ctl_increase_group_id2>1</ctl_increase_group_id2>
  <ctl_increase_send_email_alert>true</ctl_increase_send_email_alert>
  <ctl_increase_start_time_delay>1</ctl_increase_start_time_delay>
  <max_value>1</max_value>
  <max_value_add_to_group>true</max_value_add_to_group>
  <max_value_group_id>1</max_value_group_id>
  <max_value_group_id2>1</max_value_group_id2>
  <max_value_send_email_alert>true</max_value_send_email_alert>
  <max_value_start_time_delay>1</max_value_start_time_delay>
  <min_value>1</min_value>
  <min_value_add_to_group>true</min_value_add_to_group>
  <min_value_group_id>1</min_value_group_id>
  <min_value_group_id2>1</min_value_group_id2>
  <min_value_send_email_alert>true</min_value_send_email_alert>
  <min_value_start_time_delay>1</min_value_start_time_delay>
  <vital_type>sample string 2</vital_type>
</ParticipantVitalAlert>