POST Api/MobileHelp

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

Request Information

URI Parameters

None.

Body Parameters

A result object that contains the following data: account_name - mobilehelp_device_id - question_type - result_value - result_date -

MobileHelpResult

Name	Description	Type	Additional information
account_name	The TouchPointCare Account Name where the MobileHelp vitals should be posted.	string	None.
mobilehelp_device_id	The MobileHelp Device ID assigned to the participant.	string	None.
question_type	The type of question when importing vitals using the following format: weight - weight scale results, bgm - blood glucose measurement, bgmq - blood glucose qualifier (beore breakfast, after dinner, etc), bpm - heart rate (beats per minute), diastolic - blood pressure diastolic, systolic - blood pressure systolic, motion - motion sensor trigger, oxysat - Pulse Oxygen saturation, bloodpressure - blood pressure systolic, diastolic, and heart rate (bpm) in one single call. Format the result value as "systolic=999;diastolic=999;bpm=999", temp - Temperature, rr - Respiratory Rate Spirometry - Spirometry / FEV1 literflow - Liter Flow / PEF a1c - A1C reading	string	None.
result_value	The numeric value/result of the data. Do not inlude the units (i.e. for a 150 lb weight reading, the result_value should only display 150).	string	Required
result_date	The date/time of the result. Value should be in coordinated Universal Time (UTC) in the following format: YYYY-MM-DD HH:MM:DD:SS	date	Required
reading_input_type	The type of reading gathered. Possible Values: Manual: DEFAULT - The reading was manually entered or communicated from the participant. Device: Readings was imported directly from a device such as a bluetooth enabled blood pressure, weight scale, etc. Clinician: Reading was taken directly from a reliable device and oversaw directly by a clinician.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "account_name": "sample string 1",
  "mobilehelp_device_id": "sample string 2",
  "question_type": "sample string 3",
  "result_value": "sample string 4",
  "result_date": "2025-06-14T22:45:37.4996095-05:00",
  "reading_input_type": "sample string 6"
}

application/xml, text/xml

Sample:

<MobileHelpResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <account_name>sample string 1</account_name>
  <mobilehelp_device_id>sample string 2</mobilehelp_device_id>
  <question_type>sample string 3</question_type>
  <reading_input_type>sample string 6</reading_input_type>
  <result_date>2025-06-14T22:45:37.4996095-05:00</result_date>
  <result_value>sample string 4</result_value>
</MobileHelpResult>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MobileHelpResult'.

Response Information

Resource Description

A TPCResponse object. Below is a list of possible error_codes returned: <para> </para> 904 - The question_type does not match a valid type. Check the documentation for valid question type codes. <para> </para> 905 - This account is not properly setup to accept API vital signs of this type.Contact the TouchPointCare <para> </para> 906 - The mobilehelp_device_id is required. Please supply a unique id to lookup the participant. <para> </para> 920 - You are not authorized to use this procedure. <para> </para> 921 - The account name provided is invalid. <para> </para> 100 - (this code is used for unexpected or unknown errors)

TPCResponse

Name	Type	Additional information
result	string	None.
error_code	integer	None.
message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "result": "sample string 1",
  "error_code": 1,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:

<TPCResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <error_code>1</error_code>
  <message>sample string 2</message>
  <result>sample string 1</result>
</TPCResponse>