Get Device Data

cURL

curl --request GET \
  --url https://om-staging.mylifeforce.com/api/m2m/patient/{patientId}/devices \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "name": "Fitbit",
      "slug": "fitbit",
      "logoUrl": "https://picsum.photos/200/300",
      "status": "connected",
      "type": "watch",
      "sleep": [
        {
          "name": "REM Sleep",
          "unit": "hours",
          "data": [
            {
              "date": "2022-04-18T00:00:00Z",
              "value": 2.5
            }
          ],
          "average": 2.5,
          "percentChange": 15.2
        }
      ],
      "activity": [
        {
          "name": "Daily Active Calorie Burn",
          "unit": "Calories",
          "data": [
            {
              "date": "2022-04-18T00:00:00Z",
              "value": 789
            }
          ],
          "average": 456,
          "percentChange": 15.2
        }
      ],
      "body": [
        {
          "name": "Weight",
          "unit": "lbs",
          "data": [
            {
              "date": "2022-04-18T00:00:00Z",
              "value": 150
            }
          ],
          "average": 150,
          "percentChange": 15.2
        }
      ],
      "bloodPressure": {
        "name": "Blood Pressure",
        "unit": "mmHg",
        "data": [
          {
            "date": "2022-04-18T00:00:00Z",
            "systolic": 120,
            "diastolic": 80
          }
        ],
        "average": {
          "systolic": 120,
          "diastolic": 80
        },
        "abnormalInstancePercentage": 0,
        "percentChange": 0
      },
      "activityHeartRate": {
        "name": "Heart Rate",
        "unit": "bpm",
        "data": [
          {
            "date": "2022-04-18T00:00:00Z",
            "averageHeartRate": 80,
            "maximumHeartRate": 200,
            "minimumHeartRate": 55,
            "restingHeartRate": 60
          }
        ],
        "average": 80,
        "abnormalInstances": 0,
        "percentChange": 0
      }
    }
  ],
  "vitalConnectedDevices": [
    {
      "id": 1,
      "name": "Fitbit",
      "slug": "fitbit",
      "logoUrl": "https://picsum.photos/200/300",
      "status": "connected",
      "type": "watch"
    }
  ]
}

GET

patient

{patientId}

devices

cURL

curl --request GET \
  --url https://om-staging.mylifeforce.com/api/m2m/patient/{patientId}/devices \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "name": "Fitbit",
      "slug": "fitbit",
      "logoUrl": "https://picsum.photos/200/300",
      "status": "connected",
      "type": "watch",
      "sleep": [
        {
          "name": "REM Sleep",
          "unit": "hours",
          "data": [
            {
              "date": "2022-04-18T00:00:00Z",
              "value": 2.5
            }
          ],
          "average": 2.5,
          "percentChange": 15.2
        }
      ],
      "activity": [
        {
          "name": "Daily Active Calorie Burn",
          "unit": "Calories",
          "data": [
            {
              "date": "2022-04-18T00:00:00Z",
              "value": 789
            }
          ],
          "average": 456,
          "percentChange": 15.2
        }
      ],
      "body": [
        {
          "name": "Weight",
          "unit": "lbs",
          "data": [
            {
              "date": "2022-04-18T00:00:00Z",
              "value": 150
            }
          ],
          "average": 150,
          "percentChange": 15.2
        }
      ],
      "bloodPressure": {
        "name": "Blood Pressure",
        "unit": "mmHg",
        "data": [
          {
            "date": "2022-04-18T00:00:00Z",
            "systolic": 120,
            "diastolic": 80
          }
        ],
        "average": {
          "systolic": 120,
          "diastolic": 80
        },
        "abnormalInstancePercentage": 0,
        "percentChange": 0
      },
      "activityHeartRate": {
        "name": "Heart Rate",
        "unit": "bpm",
        "data": [
          {
            "date": "2022-04-18T00:00:00Z",
            "averageHeartRate": 80,
            "maximumHeartRate": 200,
            "minimumHeartRate": 55,
            "restingHeartRate": 60
          }
        ],
        "average": 80,
        "abnormalInstances": 0,
        "percentChange": 0
      }
    }
  ],
  "vitalConnectedDevices": [
    {
      "id": 1,
      "name": "Fitbit",
      "slug": "fitbit",
      "logoUrl": "https://picsum.photos/200/300",
      "status": "connected",
      "type": "watch"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

patientId

string<uuid>

required

The id of the patient in question A universally unique identifier.

Example:

"29ea9012-c622-4851-a57a-9327abd21198"

Query Parameters

time_range

enum<string>

default:last90

Time range for the device data

Available options:

last7,

last90,

last180

Response

Successful response

data

object[]

The data associated with each connected device

Show child attributes

data.id

number

The id of the device

Example:

1

data.name

string

The name of the device

Example:

"Fitbit"

data.slug

string

The slug of the device

Example:

"fitbit"

data.logoUrl

string

The URL of the device's logo

Example:

"https://picsum.photos/200/300"

data.status

string

The status of the device (connected, disconnected, etc.)

Example:

"connected"

data.type

string

The type of device (watch, cuff, etc.)

Example:

"watch"

data.sleep

object[]

Contains all available metrics associated to sleep

Show child attributes

data.sleep.name

string

The name of the metric

Example:

"REM Sleep"

data.sleep.unit

string

The unit of the metric

Example:

"hours"

data.sleep.data

object[]

Show child attributes

data.sleep.data.date

string<date-time>

The date of the data point

Example:

"2022-04-18T00:00:00Z"

data.sleep.data.value

number | null

The value of the metric at this data point

Example:

2.5

data.sleep.average

number

The average value of the metric over the selected time range

Example:

2.5

data.sleep.percentChange

number | null

The percent change in the metric over the selected time range when compared to the same amount of time before

Example:

15.2

data.activity

object[]

Contains all available metrics associated to activity

Show child attributes

data.activity.name

string

The name of the metric

Example:

"Daily Active Calorie Burn"

data.activity.unit

string

The unit of the metric

Example:

"Calories"

data.activity.data

object[]

Show child attributes

data.activity.data.date

string<date-time>

The date of the data point

Example:

"2022-04-18T00:00:00Z"

data.activity.data.value

number | null

The value of the metric at this data point

Example:

789

data.activity.average

number

The average value of the metric over the selected time range

Example:

456

data.activity.percentChange

number | null

The percent change in the metric over the selected time range when compared to the same amount of time before

Example:

15.2

data.body

object[]

Contains all available metrics associated to body composition

Show child attributes

data.body.name

string

The name of the metric

Example:

"Weight"

data.body.unit

string

The unit of the metric

Example:

"lbs"

data.body.data

object[]

Show child attributes

data.body.data.date

string<date-time>

The date of the data point

Example:

"2022-04-18T00:00:00Z"

data.body.data.value

number | null

The value of the metric at this data point

Example:

150

data.body.average

number

The average value of the metric over the selected time range

Example:

150

data.body.percentChange

number | null

The percent change in the metric over the selected time range when compared to the same amount of time before

Example:

15.2

data.bloodPressure

object

Contains blood pressure metrics (systolic and diastolic)

Show child attributes

data.bloodPressure.name

string

The name of the metric

Example:

"Blood Pressure"

data.bloodPressure.unit

string

The unit of the metric

Example:

"mmHg"

data.bloodPressure.data

object[]

Show child attributes

data.bloodPressure.data.date

string<date-time>

The date of the data point

Example:

"2022-04-18T00:00:00Z"

data.bloodPressure.data.systolic

number | null

The systolic value of the metric at this data point

Example:

120

data.bloodPressure.data.diastolic

number | null

The diastolic value of the metric at this data point

Example:

80

data.bloodPressure.average

object

Show child attributes

data.bloodPressure.average.systolic

number

The average systolic value of the metric over the selected time range

Example:

120

data.bloodPressure.average.diastolic

number

The average diastolic value of the metric over the selected time range

Example:

80

data.bloodPressure.abnormalInstancePercentage

number

The percentage of abnormal instances of the metric over the selected time range, an abnormal instance for Blood Pressure is defined as blood pressure being over 140/90 or under 100/60

Example:

0

data.bloodPressure.percentChange

number | null

The percent change in the metric over the selected time range when compared to the same amount of time before

Example:

0

data.activityHeartRate

object

Contains heart rate metrics

Show child attributes

data.activityHeartRate.name

string

The name of the metric

Example:

"Heart Rate"

data.activityHeartRate.unit

string

The unit of the metric

Example:

"bpm"

data.activityHeartRate.data

object[]

Show child attributes

data.activityHeartRate.data.date

string<date-time>

The date of the data point

Example:

"2022-04-18T00:00:00Z"

data.activityHeartRate.data.averageHeartRate

number | null

The average heart rate of the metric at this data point

Example:

80

data.activityHeartRate.data.maximumHeartRate

number | null

The maximum heart rate of the metric at this data point

Example:

200

data.activityHeartRate.data.minimumHeartRate

number | null

The minimum heart rate of the metric at this data point

Example:

55

data.activityHeartRate.data.restingHeartRate

number | null

The resting heart rate of the metric at this data point

Example:

60

data.activityHeartRate.average

number

The average value of the metric over the selected time range, this will use "averageHeartRate" from the data array

Example:

80

data.activityHeartRate.abnormalInstances

number

The number of abnormal instances of the metric over the selected time range, an abnormal instance for Heart Rate is defined as "averageHeartrate" heart rate being over 100 or under 60

Example:

0

data.activityHeartRate.percentChange

number | null

The percent change in the metric over the selected time range when compared to the same amount of time before, uses the "averageHeartRate" from the data array

Example:

0

vitalConnectedDevices

object[]

The connected devices for the member

Show child attributes

vitalConnectedDevices.id

number

The id of the device

Example:

1

vitalConnectedDevices.name

string

The name of the device

Example:

"Fitbit"

vitalConnectedDevices.slug

string

The slug of the device

Example:

"fitbit"

vitalConnectedDevices.logoUrl

string

The URL of the device's logo

Example:

"https://picsum.photos/200/300"

vitalConnectedDevices.status

string

The status of the device (connected, disconnected, etc.)

Example:

"connected"

vitalConnectedDevices.type

string

The type of device (watch, cuff, etc.)

Example:

"watch"

Get Patient PII Get Patient Resources

⌘I

API Documentation

Patient

Biomarkers

Lifescore

Questionnaires

Authorizations

Path Parameters

Query Parameters

Response