GET Api/Results/GetByParticipantAndDate?alertId={alertId}&fromDate={fromDate}&toDate={toDate}

This method will return all participant result data for a given participant (alert id) and date range (fromDate to toDate). This method should be used in conjunction with the GetParticipantsWithResultsByDate endpoint which will return a list of alert IDs.

Request Information

URI Parameters

Name	Description	Type	Additional information
alertId	The unique ID of the participant as assigned by TouchPointCare.	integer	Required
fromDate	The beginning date to find participants with results.	date	Required
toDate	The ending date to find participants with results.	date	Required

Body Parameters

None.

Response Information

Resource Description

A "ParticipantResult" object which contains basic participant information along with the "results" collection which is a list of the vitals and telehealth results over the requested date range.

ParticipantResult

Name	Description	Type	Additional 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.
company	The provider/client name	string	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.
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.
participant_name	The full name of the participant	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.
schedule_id	The unique ID of the scheduled TouchPoint.	integer	None.
date_of_birth	The date of birth of the participant in yyyyMMddHHmmss format.	string	None.
gender	The sex/gender of the participant (M for Male, F for Female)	string	None.
address_1	Address Line 1 for the participant	string	None.
address_2	Address Line 2 for the participant	string	None.
city	The city for the participant	string	None.
state	The state/province for the participant	string	None.
zip	Zip/Postal Code for the participant	string	None.
phone	Primary Phone number for the participant	string	None.
time_answered	The date/time the telehealth question was answered or vital was taken in yyyyMMddHHmmss format.	string	None.
doctor_last_name	The last name of the physician assigned to the participant.	string	None.
doctor_first_name	The first name of the physician assigned to the participant.	string	None.
doctor_middle_name	The middle name of the physician assigned to the participant.	string	None.
last_encounter_id	The most recent encounter/episode ID as provided by the EMR.	string	None.
facility_code	A facility identifier specific to the provider account.	string	None.
results	The list of telehealth questions and responses and/or vitals readings.	Collection of QuestionResult	None.

Response Formats

application/json, text/json

Sample:

{
  "participant_id": 1,
  "provider_unique_id": "sample string 2",
  "first_name": "sample string 3",
  "last_name": "sample string 4",
  "middle_name": "sample string 5",
  "series_id": 6,
  "series_name": "sample string 7",
  "company": "sample string 8",
  "group_name": "sample string 9",
  "group_Id": 10,
  "custom_1": "sample string 11",
  "custom_2": "sample string 12",
  "custom_3": "sample string 13",
  "custom_4": "sample string 14",
  "company_id": 15,
  "participant_name": "sample string 16",
  "encouter_id": "sample string 17",
  "task": "sample string 18",
  "duration_seconds": 19,
  "schedule_id": 1,
  "date_of_birth": "sample string 20",
  "gender": "sample string 21",
  "address_1": "sample string 22",
  "address_2": "sample string 23",
  "city": "sample string 24",
  "state": "sample string 25",
  "zip": "sample string 26",
  "phone": "sample string 27",
  "time_answered": "sample string 28",
  "doctor_last_name": "sample string 29",
  "doctor_first_name": "sample string 30",
  "doctor_middle_name": "sample string 31",
  "last_encounter_id": "sample string 32",
  "facility_code": "sample string 33",
  "results": null
}

application/xml, text/xml

Sample:

<ParticipantResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <address_1>sample string 22</address_1>
  <address_2>sample string 23</address_2>
  <city>sample string 24</city>
  <company>sample string 8</company>
  <company_id>15</company_id>
  <custom_1>sample string 11</custom_1>
  <custom_2>sample string 12</custom_2>
  <custom_3>sample string 13</custom_3>
  <custom_4>sample string 14</custom_4>
  <date_of_birth>sample string 20</date_of_birth>
  <doctor_first_name>sample string 30</doctor_first_name>
  <doctor_last_name>sample string 29</doctor_last_name>
  <doctor_middle_name>sample string 31</doctor_middle_name>
  <duration_seconds>19</duration_seconds>
  <encouter_id>sample string 17</encouter_id>
  <facility_code>sample string 33</facility_code>
  <first_name>sample string 3</first_name>
  <gender>sample string 21</gender>
  <group_Id>10</group_Id>
  <group_name>sample string 9</group_name>
  <last_encounter_id>sample string 32</last_encounter_id>
  <last_name>sample string 4</last_name>
  <middle_name>sample string 5</middle_name>
  <participant_id>1</participant_id>
  <participant_name>sample string 16</participant_name>
  <phone>sample string 27</phone>
  <provider_unique_id>sample string 2</provider_unique_id>
  <results i:nil="true" />
  <schedule_id>1</schedule_id>
  <series_id>6</series_id>
  <series_name>sample string 7</series_name>
  <state>sample string 25</state>
  <task>sample string 18</task>
  <time_answered>sample string 28</time_answered>
  <zip>sample string 26</zip>
</ParticipantResult>