home api list

Hexostore API Documentation

datatype

/api/datatype/

List methods: get

Detail methods: get

This defines different data types that are used to record data throughout the system.

Rendering datatype.html

List of available datatypes

Name Id Unit Description

acc

[4145, 4146, 4147] g

Acceleration: 3-axis sensors with a 13 bits resolution.

  • Frequency: 64 Hz
  • Resolution 3.90625 mG
  • Dynamic range +- 16G
  • Unit: G
  • Unit (binary download): G/256

activity

49 g

Activity: Signal based on the accelerometer intensity vector.

  • Source data: acc
  • Method of calculation:
    • Highpass at 2.65 Hz on the 3 axis independently
    • Vector of acceleration. (accX^2 + accY^2+accZ^2)^.5
    • Averaged over the last second
  • Frequency: 1 Hz
  • Resolution 3.9 mG.
  • Dynamic range +- 16G
  • unit G
  • Unit (binary download): G/256

ann

271 s

Average of valid rr interval: Average of (nninterval) calculated over the last 5 minutes.

  • Source data: nninterval, rrintervalstatus and rrinterval which are based on ecg
  • method of calculation
    • calculated on server
    • Average calculated on the valid rr interval (nn interval) during the last 5 minutes
  • Frequency 1/300Hz = 1/5min
  • Unit: second
  • Unit (binary download): second/4096

breathingrate

33 rpm

Breathing rate: Calculated over the last 7 respiration cycles.

  • Frequency: 1 Hz
  • Source data: inspiration expiration which are based on respiration
  • Quality score: breathingratestatus
  • Average: last 7 respiration cycles
  • Valid range: (2 to 60 RPM)
    • If BR > 60: Clip to 60
    • If BR < 2: set to 2
  • Value on initialisation: 10 RPM, then average of last 2,3,4,5,6 respirations, then average of last 7 respirations
  • Behavior on invalid detection: keep value of last valid BR
  • Unit: respiration per minute

breathingratestatus

1001 NA

Breathing rate status: Quality of breathing rate signal.

  • Source data: respiration
  • Frequency: 1Hz
  • Bits description:
    • RESP_STATUS_OK (0x00) /!< Resp good quality./
    • RESP_STATUS_NO_A (0x01) /!< Resp channel A (thoracic) is disconnected./
    • RESP_STATUS_NO_B (0x02) /!< Resp channel B (abdominal) is disconnected./
      • Flag is raised if signal is always zero for the last 2 seconds
      • set in des_resp.c -- respsignal_watchdog_exec
    • RESP_STATUS_BASELINE_A (0x04) /!< Resp A baseline has changed. /
    • RESP_STATUS_BASELINE_B (0x08) /!< Resp B baseline has changed. /
      • Flag is raised if a sample of the signal is further away than baseline_threshold from the baseline in the last 2 seconds baseline_threshold* = 500
    • RESP_STATUS_NOISY_A (0x10) /!< Resp A has high frequency content. /
    • RESP_STATUS_NOISY_B (0x20) /!< Resp B has high frequency content. /
      • Flag is raises if we detect more than 20 zero crossing in the last second

cadence

53 spm

Cadence: Averaged over the last 7 strides based on the accelerometer.

  • Frequency: 1 Hz
  • Source data: acc
  • Method of calculation:
    • Average: last 8 steps detected (7 strides) sampled each second
    • Lowpass @ 0.17Hz
  • Valid range: (30 to 240 Steps per minute or SPM)
    • If cadence > 240: Clip to 240
    • If cadence < 30: set to 0
  • Unit: Steps per minute

deviceposition

269 NA

Device position: Give the onset of a position changes.

|Position    |Axis pointing upward  |Device position    |
|:-----------|:--------------------:|:-----------------:|
|Position 1  | y                    |Blue LED upward    |
|Position 2  |-y                    |Blue LED downward  |
|Position 3  | z                    |Face downward      |
|Position 4  |-z                    |Face upward        |
|Position 5  | x                    |Wire downward      |
|Position 6  |-x                    |Wire upward        |
|Position 0  |                      |Undefined          |

Note: For sleep position, see sleepposition

  • Source data: acc
  • Frequency: Async

ecg

[4113, 4114, 4115] 0.0064*mV

Electrocardiogram: 1 to 3 lead ECG channel with a 12 bits resolution.

  • Frequency: 256 Hz
  • Resolution LSB: 0.0064 mV
  • Dynamic range: 26 mV
  • unit: mV * 0.0064
  • Unit (binary download): mV * 0.0064

energyadjusted

42 watt

Total energy based on ECG. We used Mifflin and Keytel equation. The value are adjusted for the weight, height,sex, HRMax, HRMin of the user. - Frequency: 1 Hz - Unit: Watt - Unit (binary download): Watt

expiration

35 NA

Expiration: Detection of an expiration onset event.

  • Method of calculation:
    • The inspiration and expiration are detected on the ponderate sum of the thoracic and abdominal sensor.
    • A history buffer is created which correspond to a memory of =.75 s.
    • At each sample, check if the oldest point is a maximum. If it's the case and if the signal decrease of more than 10 units since the last inspiration, the expiration is saved.
  • Frequency: Async
  • Source data: respiration
  • Quality score: breathingratestatus

heartrate

19 bpm

Heart rate: Average over the last 16 heart beats.

  • Frequency: 1 Hz
  • Source data: rrintervalstatus and rrinterval which are based on ecg
  • Method of calculation:
    • On a QRS detection, if the ECG_STATUS_UNRELIABLE_RR is set to off, the HR is put in the 32 HR buffer. Then the HR is calculated as the average on the last 16 HR.
    • On initialisation HR is set to 70 BPM.
  • Quality score: heartratestatus
  • Average: last 16 beats
  • Valid range: 30 to 220 BPM.
  • Value on initialisation: 70 BPM
  • Behavior on invalid detection: keep value of last valid HR
  • Unit: BPM

heartratestatus

1000 NA

Heart rate status: Quality of heart rate signal.

  • Source data: ecg
  • Frequency: 1Hz
  • Bits description:
    • ECG_STATUS_OK (0x00) ECG good quality
    • ECG_FOR_FUTURE_USE (0x01) reserved to reach heart ECG
    • ECG_STATUS_DISCONNECTED (0x02) Shirt is disconnected
    • ECG_STATUS_50_60HZ (0x04) 50-60 Hz dominant in ECG.
      • Flag is raises if we detect more than 80 zero crossing in the last second
    • ECG_STATUS_SATURATED (0x08) ECG signal saturated
      • Flag is raised if amplitude is <=0 or amplitude is >=4096 during the last second
    • ECG_STATUS_ARTIFACTS (0x10) Movement artifacts makes RR intervals less precise
    • ECG_STATUS_UNRELIABLE_RR (0x20) ECG ok, but some RR are unreliable
      • Build an histogram with the last 32 rr interval. The bins of the histogram are fixed in __rr_histogram= {0, 70, 77, 83, 93, 106, 121, 138, 157, 184, 219, 262, 315, 378, 453, 544, 653, 768}.
      • The flag is raised one rr is outside the 5 centered bins of the histogram in the last second
      • The flag is raised if outside the outer limits (70/256 = 220 bpm, 768/256 = 30 bpm)

hrvhf

277 ms^2

HRV HF power: (Where: LF=0.04-0.15 Hz and HF= 0.15-0.4 Hz). HF is calculated using the lomb periodogram.

  • Method of calculation:
    • Lomb periodogram is calculated on the last valid nn_interval during the last 300 s If there is not enough e_rr valid, return 0
  • Frequency: 1/300 Hz
  • Source data: nninterval, rrintervalstatus, heartratestatus
  • Unit: ms^2
  • Unit (binary download): ms^2 /10
  • Resolution: ms^2 /10

hrvhfnorm

273

HRV power HF normalized: HF/(LF +HF) (Where: LF=0.04-0.15 Hz and HF= 0.15-0.4 Hz) LF and HF are calculated using the lomb periodogram.

  • Method of calculation:
    • Lomb periodogram is calculated on the last valid nn_interval over the last 300s. If there is not enough valid e_rr, it returns 0.
  • Frequency: 1/300 Hz
  • Source data: nninterval, rrintervalstatus, heartratestatus
  • Unit: None
  • Unit (binary download): 1/10000

hrvlf

276 ms^2

HRV LF power: (Where: LF=0.04-0.15 Hz and HF= 0.15-0.4 Hz). LF is calculated using the lomb periodogram.

  • Method of calculation:
    • Lomb periodogram is calculated on the last valid nn_interval during the last 300 s If there is not enough e_rr valid, return 0
  • Frequency: 1/300 Hz
  • Source data: nninterval, rrintervalstatus, heartratestatus
  • Unit: ms^2
  • Unit (binary download): ms^2 /10
  • Resolution: 1 ms^2 /10

inspiration

34 NA

Inspiration: Detection of an inspiration onset event.

  • Method of calculation:
    • The inspiration is detected on the ponderate sum of the thoracic and abdominal sensor.
    • A history buffer is created which correspond to a memory of =.75 s.
    • At each sample, check if the oldest point is a minimum. If it's the case and if the signal decrease of more than 10 units since the last expiration, the inspiration is saved.
  • Frequency: Async
  • Source data: respiration
  • Quality score: breathingratestatus

minuteventilation

36 mL/min

Minute ventilation: volume of air/minute inspired in the last 7 complete respiration cycles. This value is based on the raw signal, you are probably looking for minuteventilationadjusted.

  • Frequency: 1 Hz
  • Average: last 7 complete respiration cycles
  • Unit: mL/min
  • Unit (binary download): mL/min * 13.28

minuteventilationadjusted

38 mL/min

Minute ventilation: volume of air/minute inspired in the last 7 complete respiration cycles. The value is ajdusted to take into account the user profile, for raw data see minuteventilation.

  • Frequency: 1 Hz
  • Average: last 7 complete respiration cycles
  • Unit: mL/min
  • Unit (binary download): cL/min

nninterval

318 s

NN interval: Time between to heart beat detections, calculated for every QRS event.

  • Method of calculation:
    • The time difference between the QRS and the previous QRS.
    • Range of validity: from eye-closing period 0.265s (68/256 s) to 4s (1023/256 s)
    • The nn interval are based on the rrinterval where unreliable rrintervals are excluded. Moreover a rrinterval differing by more that 150 ms from the 5 adjacent rrintervals is also excluded.
  • Frequency: Async
  • Source data: qrs, rrintervalstatus ecg
  • Unit: second
  • Unit (binary download): second/256

nnoverrr

274

NN/RR: Ratio len(nninterval) / len(rrinterval): over the last 5 minutes. This can give a quality score for the HRV results.

pohr

65 NA

Pulse oximetry derivated HR channel. Available only on the Hexoskin-X model.

  • Frequency: 1 Hz
  • Resolution: 1 BPM
  • Unit: BPM

ppg

64 NA

Photoplethysmography: Signal as returned by A Nonin optic sensor. Available only on the Hexoskin-X model.

  • Frequency: 64 Hz

ptt

97 s

Pulse transit time: Time difference between the peak in ppg and the qrs. Available only on Hexoskin-X model.

  • Source data: qrs, spo2
  • Method of calculation:
    • Time difference between the peak in ppg and the qrs
  • Frequency: Async
  • Unit: second
  • Resolution: 0.00390625 s. 1/256
  • Unit (binary download): second/256

qrs

17 NA

QRS: ECG ventricular contraction (heart beat) event detection centered on the QRS complex. DEPRECATED QRS location should be accessed through rrinterval

  • Method of calculation:

  • Frequency: Async

  • Source data: ecg
  • Range: N-A.
  • Quality: rrintervalstatus Note: the QRS position can have a temporal error bigger than 10 ms. To have QRS more precise, use nninterval channel(datatype 318).

respiration

[4129, 4130] NA

Respiration: 1 to 2 RIP (Respiratory inductance plethysmography) sampled at 128 Hz with a 16 bits resolution.

Note: This is the raw oscillation count and not the volume. A decrease in raw value corresponds to an increase in volume.

  • Frequency: 128 Hz
  • Raw data (oscillation count in 1/128s)
  • Resolution LSB = 128 Hz. i.e. 1 count in 1/128s
  • Estimated resolution 8 mL
  • Unit: mL
  • Unit (binary download): NA

rrinterval

18 s

RR interval: Time between two heart beat detections, calculated for every QRS event. Saved at the center of the QRS complex

  • Method of calculation:
    • The time difference between the QRS and the previous QRS.
    • Range of validity: from eye-closing period 0.265s (68/256 s) to 4s (1023/256 s)
  • Frequency: Async
  • Source data: qrs which is based on ecg
  • Quality: rrintervalstatus
  • Unit: second
  • Unit (binary download): second/256

rrintervalstatus

1004 NA

QRS status: Status of the last QRS.

  • Frequency: Async
  • Method of calculation:
    • Build an histogram with the last 32 rr interval. The bins of the histogram are fixed in __rr_histogram= {0, 70, 77, 83, 93, 106, 121, 138, 157, 184, 219, 262, 315, 378, 453, 544, 653, 768}.
    • The flag is raised if the last rr is outside the 5 centered bins of the histogram
    • The flag is raised if outside the outer limits (70/256 = 220 BPM, 768/256 = 30 BPM)
  • Bits description:
    • RELIABLE_RR (0x00) QRS good quality
    • NOISY_RR (0x01) QRS detected in signal with noise
    • UNRELIABLE_RR (0x80)

sdnn

272 s

Standard deviation of valid rr interval (nninterval) calculated over the last 5 minutes.

  • Source data: nninterval, rrintervalstatus and rrinterval which are based on ecg
  • method of calculation
    • calculated on server
    • Standard deviation calculated on the valid rr interval (nn interval) during the last 5 minutes
  • Frequency 1/300Hz = 1/5 min
  • Unit: second
  • Unit (binary download): second/4096

sleepphase

280 NA

Sleep phase: Give the onset of a sleep phase changes - The phases are:

  • 6: Wake
  • 5: REM (rapid eye movement)
  • 2: NREM (Non REM)
  • 0: Non Data
  • 1,3,4: Non REM, stage 1,3,4. Theses stages are not used and are regrouped with #2
  • Frequency: Async
  • Source data: activity, heartrate, breathingrate

sleepposition

270 NA

Sleeper position: Give the onset of a position changes.

|Position    |Axis pointing upward  |Device position       |Sleep position (returned on dashboard)
|:-----------|:--------------------:|:--------------------:|:------------------------------------:
|Position 1  | y                    |Blue LED upward       |Belly (1)
|Position 2  |-y                    |Blue LED downward     |Back (2)
|Position 3  | z                    |Face downward         |Right (3)
|Position 4  |-z                    |Face upward           |Left (4)
|Position 5  | x, -x                |Wire downward/upward  |Standing (5)
|Position 0  |                      |Undefined             |

Notes:

  • The sleep positions are defined when the wire is placed in the pocket with the wire pointing upward and the light pointing outside
  • For device position see deviceposition Source data: acc
  • Frequency: Async

spo2

66 %

SPO2: Oxygen saturation level as returned by A Nonin optic sensor. Available only on the Hexoskin-X model.

  • Frequency: 1 Hz
  • Resolution 1%
  • Unit: percent

spo2status

1002 NA

SPO2 status: Quality of the SPO2 signal. Available only on the Hexoskin-X model.

  • Frequency: 1 Hz

step

52 Step

Step: The number of steps since the beginning of a recording.

  • Method of calculation:
    • Lowpass at 17 Hz
    • Find gravity aligned channel
    • Bandpass 0.466 - 3.782 Hz
    • Step detected if filtered channel goes over 35 units
  • Frequency: Async
  • Source data: acc
  • Unit: step

systolicpressure

98 mmHg

Systolic blood pressure: Blood pressure derived from the ptt value.

  • Source data: ptt and qrs
  • Frequency: 1 Hz
  • Resolution: 1 mmHg
  • Dynamic range: 60-260 mmHg
  • Unit: mmHg

temperature

[80, 81] NA

Temperature. Available only on the Hexoskin-X model.

  • Frequency: 1 Hz
  • Unit: Celcius

temperatureresp

338 C

Temperature of the respiration sensor. Available only on the Hexoskin-smart model.

  • Frequency: 1 Hz
  • Resolution: 0.01 Celcius
  • Unit (binary download): 0.01 Celcius
  • Unit: Celcius

temperaturestatus

1003 NA

Temperature status: Quality of the temperature signal. Available only on the Hexoskin-X model.

  • Frequency: 1 Hz

tidalvolume

37 mL

Tidal volume: Volume of air inspired in the last inspiration. This value is based on the raw signal, you are probably looking for tidalvolumeadjusted.

  • Frequency: 1 Hz
  • Unit: mL (mL / inspiration)
  • Unit (binary download): mL *13.28

tidalvolumeadjusted

39 mL

Tidal volume: Volume of air inspired in the last inspiration. The value is ajdusted to take into account the user profile, for raw data see tidalvolume.

  • Unit: mL (mL / inspiration)
  • Unit (binary download): mL
  • Frequency: 1 Hz

triangular

275

HRV triangular index: HRV triangular index(nninterval) calculated over the last 5 minutes.

  • Source data: nninterval, rrintervalstatus and rrinterval which are based on ecg
  • method of calculation
    • calculated on server
    • Standard deviation calculated on the valid rr interval (nn interval) during the last 5 minutes
  • Frequency 1/300Hz = 1/5 min
  • Resolution: 0.01
  • Unit: None
  • Unit (binary download): percent

Fields

dataid:

DEPRECATED, same as "id"

This field is readonly.

freq:

Signal frequency (in Hz)

This field is readonly.

hexo_freq:

Number of hexotimestamps between samples. DEPRECATED, see hexo_step

This field is readonly.

id:

The primary key for this resource. Integer data. Ex: 2673

This field may be blank

This field will default to: '' (empty string)

info:

Unicode string data. Ex: "Hello World"

This field is required.

name:

Unicode string data. Ex: "Hello World"

resource_uri:

The unique URI where the object resides.

This field is readonly.

unit:

Unit for values returned from the API. Json or csv format

unit_raw:

Unit for values returned in raw format. (.wav)

Filtering Options

freq: exact, in, gt, gte, lt, lte, range, isnull

id: exact, in, gt, gte, lt, lte, range

name: exact, contains, in, startswith, endswith

Sorting Options

No sorting supported

© 2014 by CarrĂ© Technologies Inc.