GET Api/Results/GetResponses?fromDate={fromDate}&toDate={toDate}&accountName={accountName}

Returns the telehealth question and vitals data for a given date range and (optional) account name. This data is the same as is available via the "Call Data Export" report in TouchPointCare.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fromDate

The start date of the date range to pull.

 date

Required
toDate

The end date of the date range to pull.

 date

Required
accountName

(Optional) The account name if the account associated with the API credentials has access to "child" accounts.

 string

Default value is

Body Parameters

None.

Response Information

Resource Description

ResponseReadingCollection - A collection of telehealth question response and vitals data.

Collection of ResponseReading
NameDescriptionTypeAdditional information
participant_id

Unique ID of the participant as assigned by TouchPointCare

integer

None.
provider_unique_id

Unique ID of the participant as assigned by the provider

string

None.
first_name

The participant's first name

string

None.
last_name

The participant's last name

string

None.
middle_name

The participant's middle name

string

None.
series_id

Unique ID of the series of questions as assigned by TouchPointCare

integer

None.
series_name

The name of the series of questions

string

None.
question_id

Unique ID of the questionas assigned by TouchPointCare

integer

None.
question

The question text

string

None.
question_order_num

The sort order of the question in the series

integer

None.
company

The provider/client name

string

None.
resp_type

The response type id of the question:

  • 1 - Numeric
  • 2 - 10 Pont Value
  • 4 - Text
  • 5 - Yes/No
  • 6 - Multiple Choice - Single Select
  • 7 - Time
  • 8 - Statement
  • 9 - Multi Choie - Multi-Value

 integer

None.
answer

The response or reading value

string

None.
answer_date

The date/time of the response or reading.

date

None.
answer_date_utc

The date/time of the response or reading in utc time.

date

None.
group_name

The name of the group used when creating this TouchPoint.

string

None.
group_Id

The unique ID of the group used when creating this TouchPoint as assigned by TouchPointCare.

integer

None.
b_alert

The alert setting for a yes/no question. "Yes" or "No"

string

None.
n_alert

The alert setting for a numeric response type question

string

None.
num_alerts

If alert is set, the number of alerts before triggering the value as an alert

integer

None.
mc_alert

The alert setting for a multile choice question type

string

None.
comments

Any comments entered by the call agent

string

None.
series_question_id

Unique ID of the series and question combination as assigned by TouchPointCare

integer

None.
custom_1

The custom 1 field of the participant

string

None.
custom_2

The custom 2 field of the participant

string

None.
custom_3

The custom 3 field of the participant

string

None.
custom_4

The custom 4 field of the participant

string

None.
company_id

Unique ID of the provider or client as assigned by TouchPointCare

integer

None.
question_alias

The alias (short name) of a question assigned in TouchPointCare

string

None.
participant_name

The full name of the participant

string

None.
Alert

"1" if the response / reading triggered an alert, "0" otherwise

string

None.
username

The username of the call agent that entered the data (if entered by live agent)

string

None.
encouter_id

Unique ID of the TouchPoint encounter

string

None.
task

The type of task used to gather the reading

  • Inbound Call
  • Outbound Call
  • IVR Inbound Call
  • Internet
  • IVR Outbound Call
  • Internal
  • Text/SMS
  • Email
  • Device Delivered
  • Video Conference

 string

None.
duration_seconds

The duration, in seconds of the TouchPoint instance.

integer

None.
special_type

The type of vital sign or question special type

  • bgm - Blood Glucose
  • bgmq - Blood Glucose Qualifier (before breakfast, after dinner, etc.)
  • bpm - Heart rate
  • diastolic - Blood Pressure Diastolic
  • systolic - Blood Pressure Systolic
  • irreg - Irregular heartbeat indicator
  • irregpo - Irregular heartbeat indicator from pulse ox machine
  • motion - motion sensor count
  • oxysat - Pulse Oxygen saturation
  • rr - Respiratory Rate
  • temp - Temperature
  • weight - Weight

 string

None.
schedule_id

The unique ID of the scheduled TouchPoint.

integer

None.
added_referred_date

Gets or sets the added or referred date.

date

None.
first_activity_date

Gets or sets the first activity date (date of first vital or response to a telehealth question).

date

None.
last_actvity_date

Gets or sets the last activity date (date of most recent vital or response to a telehealth question).

date

None.
triagepro_score

Gets or sets the TriagePro score.

decimal number

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.