TouchPointCare API Reference

This method will return participant details based on the alert_id.

This method will return participant details based on the provider_unique_id.

This method allows a provider to update an existing participant record using the AlertID (unique id of the participant as assigned by TouchPointCare). All fields other than AlertID are optional. Only provide the fields you would like to update.

This method will return participant details based on the alert_id.

This method will return participant details based on the provider_unique_id.

This method allows a provider to update an existing participant record using the AlertID (unique id of the participant as assigned by TouchPointCare). All fields other than AlertID are optional. Only provide the fields you would like to update.

Create/Update a patient medication.

Create/Update a patient medication.

This method allows a provider to add vitals readings to the TouchPointCare repository. To post a reading to TouchPointCare: (1) Authenticate and get a token as described in the "Getting Started" section of this guide. (2) Post the vitals reading data in the JSON or XML format described below. The provider_unique_id is required in order to find a matching participant in TouchPointCare. This ID must be assigned on the participant profile in TouchPointCare or you will receive an error message. See the list of error numbers below.

This method allows a provider to add vitals readings to the TouchPointCare repository. To post a reading to TouchPointCare: (1) Authenticate and get a token as described in the "Getting Started" section of this guide. (2) Post the vitals reading data in the JSON or XML format described below. The provider_unique_id is required in order to find a matching participant in TouchPointCare. This ID must be assigned on the participant profile in TouchPointCare or you will receive an error message. See the list of error numbers below.

This method allows a provider to assign a device to a participant.

This method allows a provider to assign a device to a participant.

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.

This method will return participant vitals and telelealth data that has not yet been flagged and having been received.

This method will return a list of scheduled TouchPoints that have not yet been flagged as sent to the provider.

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.

This method will return participant vitals and telelealth data that has not yet been flagged and having been received.

This method allows a provider to add data results to the TouchPointCare repository. To post a result to TouchPointCare: (1) Authenticate and get a token as described in the "Getting Started" section of this guide. (2) Post the results data in the JSON or XML format described below. The provider_unique_id OR mobilehelp_device_id is required in order to find a matching participant in TouchPointCare. These IDs must be assigned on the participant profile in TouchPointCare or you will receive an error message. See the list of error numbers below.

This method will return patient response data for the given date range (from/to date).

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.

This method will return participant vitals and telelealth data that has not yet been flagged and having been received.

This method will return a list of scheduled TouchPoints that have not yet been flagged as sent to the provider.

This method will return a list of participant ids (alert ids) that have results data during the given date range. <param name="fromDate">The beginning date to find participants with results.</param><param name="toDate">The ending date to find participants with results.</param>".

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.

This method will return participant vitals and telelealth data that has not yet been flagged and having been received.

This method allows a provider to add data results to the TouchPointCare repository. To post a result to TouchPointCare: (1) Authenticate and get a token as described in the "Getting Started" section of this guide. (2) Post the results data in the JSON or XML format described below. The provider_unique_id OR mobilehelp_device_id is required in order to find a matching participant in TouchPointCare. These IDs must be assigned on the participant profile in TouchPointCare or you will receive an error message. See the list of error numbers below.

This method will return patient response data for the given date range (from/to date).

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

This method allows a provider to insert or update an existing participant record using the Alert ID (unique id assigned by TPC) or the Participant ID (unique id assigned by the provider). You can also add the participant to groups subsequently kicking off any associated TouchPoints.

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

This method allows a provider to insert or update an existing participant record using the Alert ID (unique id assigned by TPC) or the Participant ID (unique id assigned by the provider). You can also add the participant to groups subsequently kicking off any associated TouchPoints.

This method allows MobileHelp to post vitals gathered via MobileHelp devices on behalf of a provider.

This method allows MobileHelp to post vitals gathered via MobileHelp devices on behalf of a provider.

This api method will add or remove a participant from a group.

This api method will add or remove a participant from a group.

This method allows a provider to insert or update an existing participant record using the Alert ID (unique id assigned by TPC) or the Participant ID (unique id assigned by the provider). You can also add the participant to groups subsequently kicking off any associated TouchPoints. Error Codes returned: 901 - Account improperly setup, 902 - Invalid Account Name, 903 - Invalid access level name, 920 - Unauthorized to use this endpoint.

This method allows a provider to insert or update an existing participant record using the Alert ID (unique id assigned by TPC) or the Participant ID (unique id assigned by the provider). You can also add the participant to groups subsequently kicking off any associated TouchPoints. Error Codes returned: 901 - Account improperly setup, 902 - Invalid Account Name, 903 - Invalid access level name, 920 - Unauthorized to use this endpoint.

The api/Contacts method will get a list of all Contacts (case managers) for the specified account. <param name="accountName">The account name matching a child account of the provider. </param>

The api/Contacts method will get a list of all Contacts (case managers) for the provider account.

The api/Contacts method will get a list of all Contacts (case managers) for the specified account. <param name="accountName">The account name matching a child account of the provider. </param>

The api/Contacts method will get a list of all Contacts (case managers) for the provider account.

This method will return post a file to a participant's profile. The file must of the following extensions: .xls, xlsx, .doc, .docx,

This method will return post a file to a participant's profile. The file must of the following extensions: .xls, xlsx, .doc, .docx,

Runs the CM CPT Report.

Runs the CM CPT Report.

This method allows a provider to insert or update an existing participant record using the Alert ID (unique id assigned by TPC) or the Participant ID (unique id assigned by the provider). You can also add the participant to groups subsequently kicking off any associated TouchPoints.

This method allows a provider to insert or update an existing participant record using the Alert ID (unique id assigned by TPC) or the Participant ID (unique id assigned by the provider). You can also add the participant to groups subsequently kicking off any associated TouchPoints.

The api/series method will get a list of all question series for the account.

The api/series method will get a list of all question series for the account.

No documentation available.

No documentation available.

For TESTING ONLY. All data added via this endpoint will be deleted immediately. This method allows a provider to add data results to the TouchPointCare repository. To post a result to TouchPointCare: (1) Authenticate and get a token as described in the "Getting Started" section of this guide. (2) Post the results data in the JSON or XML format described below. The provider_unique_id OR mobilehelp_device_id is required in order to find a matching participant in TouchPointCare. These IDs must be assigned on the participant profile in TouchPointCare or you will receive an error message. See the list of error numbers below.

For TESTING ONLY. All data added via this endpoint will be deleted immediately. This method allows a provider to add data results to the TouchPointCare repository. To post a result to TouchPointCare: (1) Authenticate and get a token as described in the "Getting Started" section of this guide. (2) Post the results data in the JSON or XML format described below. The provider_unique_id OR mobilehelp_device_id is required in order to find a matching participant in TouchPointCare. These IDs must be assigned on the participant profile in TouchPointCare or you will receive an error message. See the list of error numbers below.

This method allows a device provider to transfer device specific extended data. Examples include low battery alerts, steps for the day, etc.

This method allows a device provider to transfer device specific extended data. Examples include low battery alerts, steps for the day, etc.

The api/TouchPoint/GetNextQuestion method will lookup the TouchPoint instance by the schedule_id and return the next question that has not yet been answered.

The api/TouchPoint method will lookup the TouchPoint instance by the schedule_id and return the next question that has not yet been answered. This is the same as api/TouchPoint/GetNextQuestion.

The api/TouchPoint method will lookup the TouchPoint instance by the schedule_id and return the next question that has not yet been answered. This is the same as api/TouchPoint/GetNextQuestion.