# BloodPressureRecord

Artifact: [androidx.health.connect:connect-client](https://developer.android.com/jetpack/androidx/releases/health-connect) [View Source](https://cs.android.com/search?q=file:androidx/health/connect/client/records/BloodPressureRecord.kt+class:androidx.health.connect.client.records.BloodPressureRecord) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
class BloodPressureRecord : Record
```

<br />

*** ** * ** ***

Captures the blood pressure of a user. Each record represents a single instantaneous blood pressure reading.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if one of the values is outside the valid range. |

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#BODY_POSITION_LYING_DOWN() = 3` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#BODY_POSITION_RECLINING() = 4` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#BODY_POSITION_SITTING_DOWN() = 2` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#BODY_POSITION_STANDING_UP() = 1` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#BODY_POSITION_UNKNOWN() = 0` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#MEASUREMENT_LOCATION_LEFT_UPPER_ARM() = 3` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#MEASUREMENT_LOCATION_LEFT_WRIST() = 1` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#MEASUREMENT_LOCATION_RIGHT_UPPER_ARM() = 4` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#MEASUREMENT_LOCATION_RIGHT_WRIST() = 2` |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#MEASUREMENT_LOCATION_UNKNOWN() = 0` |

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#DIASTOLIC_AVG()` Metric identifier to retrieve average diastolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#DIASTOLIC_MAX()` Metric identifier to retrieve maximum diastolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#DIASTOLIC_MIN()` Metric identifier to retrieve minimum diastolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#SYSTOLIC_AVG()` Metric identifier to retrieve average systolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#SYSTOLIC_MAX()` Metric identifier to retrieve maximum systolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#SYSTOLIC_MIN()` Metric identifier to retrieve minimum systolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#BloodPressureRecord(java.time.Instant,java.time.ZoneOffset,androidx.health.connect.client.records.metadata.Metadata,androidx.health.connect.client.units.Pressure,androidx.health.connect.client.units.Pressure,kotlin.Int,kotlin.Int)( time: https://developer.android.com/reference/java/time/Instant.html, zoneOffset: https://developer.android.com/reference/java/time/ZoneOffset.html?, metadata: https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata, systolic: https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure, diastolic: https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure, bodyPosition: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, measurementLocation: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#bodyPosition()` The user's body position when the measurement was taken. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#diastolic()` Diastolic blood pressure measurement, in `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure` unit. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#measurementLocation()` The arm and part of the arm where the measurement was taken. |
| `open https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#metadata()` Set of common metadata associated with the written record. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#systolic()` Systolic blood pressure measurement, in `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure` unit. |
| `open https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#time()` Time the record happened. |
| `open https://developer.android.com/reference/java/time/ZoneOffset.html?` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord#zoneOffset()` User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#time()`, or null if unknown. |

## Constants

### BODY_POSITION_LYING_DOWN

```
const val BODY_POSITION_LYING_DOWN = 3: Int
```

### BODY_POSITION_RECLINING

```
const val BODY_POSITION_RECLINING = 4: Int
```

### BODY_POSITION_SITTING_DOWN

```
const val BODY_POSITION_SITTING_DOWN = 2: Int
```

### BODY_POSITION_STANDING_UP

```
const val BODY_POSITION_STANDING_UP = 1: Int
```

### BODY_POSITION_UNKNOWN

```
const val BODY_POSITION_UNKNOWN = 0: Int
```

### MEASUREMENT_LOCATION_LEFT_UPPER_ARM

```
const val MEASUREMENT_LOCATION_LEFT_UPPER_ARM = 3: Int
```

### MEASUREMENT_LOCATION_LEFT_WRIST

```
const val MEASUREMENT_LOCATION_LEFT_WRIST = 1: Int
```

### MEASUREMENT_LOCATION_RIGHT_UPPER_ARM

```
const val MEASUREMENT_LOCATION_RIGHT_UPPER_ARM = 4: Int
```

### MEASUREMENT_LOCATION_RIGHT_WRIST

```
const val MEASUREMENT_LOCATION_RIGHT_WRIST = 2: Int
```

### MEASUREMENT_LOCATION_UNKNOWN

```
const val MEASUREMENT_LOCATION_UNKNOWN = 0: Int
```

## Public companion properties

### DIASTOLIC_AVG

```
val DIASTOLIC_AVG: AggregateMetric<Pressure>
```

Metric identifier to retrieve average diastolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

### DIASTOLIC_MAX

```
val DIASTOLIC_MAX: AggregateMetric<Pressure>
```

Metric identifier to retrieve maximum diastolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

### DIASTOLIC_MIN

```
val DIASTOLIC_MIN: AggregateMetric<Pressure>
```

Metric identifier to retrieve minimum diastolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

### SYSTOLIC_AVG

```
val SYSTOLIC_AVG: AggregateMetric<Pressure>
```

Metric identifier to retrieve average systolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

### SYSTOLIC_MAX

```
val SYSTOLIC_MAX: AggregateMetric<Pressure>
```

Metric identifier to retrieve maximum systolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

### SYSTOLIC_MIN

```
val SYSTOLIC_MIN: AggregateMetric<Pressure>
```

Metric identifier to retrieve minimum systolic from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

## Public constructors

### BloodPressureRecord

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
BloodPressureRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    metadata: Metadata,
    systolic: Pressure,
    diastolic: Pressure,
    bodyPosition: Int = BODY_POSITION_UNKNOWN,
    measurementLocation: Int = MEASUREMENT_LOCATION_UNKNOWN
)
```

## Public functions

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toString

```
open fun toString(): String
```

## Public properties

### bodyPosition

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val bodyPosition: Int
```

The user's body position when the measurement was taken. Optional field. Allowed values: `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord.BodyPosition`.

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`

<br />

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord.BodyPosition` |   |

### diastolic

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val diastolic: Pressure
```

Diastolic blood pressure measurement, in `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure` unit. Required field. Valid range: 10-180mmHg. For SDK extension 17 or higher, Valid range: 10-300mmHg.

### measurementLocation

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val measurementLocation: Int
```

The arm and part of the arm where the measurement was taken. Optional field. Allowed values: `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord.MeasurementLocation`.

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`

<br />

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BloodPressureRecord.MeasurementLocation` |   |

### metadata

```
open val metadata: Metadata
```

Set of common metadata associated with the written record.

### systolic

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val systolic: Pressure
```

Systolic blood pressure measurement, in `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Pressure` unit. Required field. Valid range: 20-200mmHg. For SDK extension 17 or higher, Valid range: 20-300mmHg.

### time

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open val time: Instant
```

Time the record happened.

### zoneOffset

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open val zoneOffset: ZoneOffset?
```

User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#time()`, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.