WIwithings
user

User v2 - Addtorpm

This API allows you to add an existing user to the Withings Remote Patient Monitoring platform as a patient. Note: A Withings Remote Patient Monitoring contract is required to use this API.

posthttps://wbsapi.withings.net/v2/user

Request

  • Base URL
    https://wbsapi.withings.net
  • Auth
    none declared

Query parameters

actionstring required

Service action name. Must take the string value addtorpm.

signaturestring required

Hash of params (Cf. Signature hash protocol).

client_idstring required

Id of the client

noncestring required

A random token used to prevent replay attacks (Cf. Signature v2 - Getnonce)

useridunknown required

User's identifier.

programidinteger required

The Care team you would like your patient to be created in. You can find the programid in the URL of your withings dashboard when connected to a specific care team /team/{programid}

sms_onboardingboolean

A sequence of SMS text message will be sent to the patient to help them follow shipment and give instructions on the device setup

assistance_onboardingboolean

Withings team will automatically contact patients with issues during their setup after a few days to help them finalize the installation.

icdcodeidsunknown

Should be a json encoded array. Each item should correspond to an id create for your program. Exemple: [66, 307, 4]

external_idsunknown

IDs from your software or EHR (MRN or other external id useful to uniquely identify your patient in the Withings RPM platform). Exemple: [{"type": "MRN", "identifier": "BB8C3P0R2D2"}]

departmentstring

Patient's department identifier in your EHR system (e.g. cardiology, diabetes, 456). Only stored when the care team has a Redox EHR integration configured. Returned in the response department field when applicable.

categoryinteger

The section in which your patient will appear in the Withings RPM platform. Accepted value are: 0 (patient is in the program and doesn't have alert) or -6 (patient need manual validation)

Response

(Click to unfold)

statusinteger

Response status. See <a href='#tag/response_status'>Status</a> section for details.

Example response

{
  "body": {
    "user": {
      "preflang": "fr_FR",
      "height": {
        "value_measure": 180,
        "unit_measure": -2,
        "type_measure": 4
      },
      "sms_reminder": true,
      "sms_onboarding": true,
      "assistance_onboarding": true,
      "category": -6,
      "sms_notification": true,
      "userid": 363
    },
    "program": {
      "id": 50,
      "cohortid": 18035,
      "name": "Glucose Care Team",
      "timezone": "Europe/Paris"
    },
    "department": "cardiology"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.