This module provides sampling data type constants and data models.
Since: 5.0.0(12)
Modules to Import
import { healthStore } from '@kit.HealthServiceKit'; 
This module is a sub-module of healthStore and needs to be used in healthStore.samplePointHelper mode.
bloodOxygenSaturation
SpO2 constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | SpO2 data type. |
[h2]Model
type Model = healthModels.BloodOxygenSaturation
Data model for SpO2 sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.BloodOxygenSaturation | Data model for SpO2 sampling. |
[h2]Fields
type Fields = healthFields.BloodOxygenSaturation
List of SpO2 sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.BloodOxygenSaturation | List of SpO2 sampling data fields. |
[h2]AggregateResult
type AggregateResult = healthModels.BloodOxygenSaturationAggregateResult
Model for SpO2 sampling data aggregation results.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.BloodOxygenSaturationAggregateResult | Model for SpO2 sampling data aggregation results. |
[h2]AggregateRequest
type AggregateRequest = healthModels.BloodOxygenSaturationAggregateRequest
Model for requesting aggregation of SpO2 sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.BloodOxygenSaturationAggregateRequest | Model for requesting aggregation of SpO2 sampling data. |
[h2]AggregateFields
type AggregateFields = healthFields.BloodOxygenSaturationAggregation
List of aggregate fields supported by SpO2 sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.BloodOxygenSaturationAggregation | List of aggregate fields supported by SpO2 sampling data. |
bloodPressure
Blood pressure constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Blood pressure data type. |
[h2]Model
type Model = healthModels.BloodPressure
Data model for blood pressure sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.BloodPressure | Data model for blood pressure sampling. |
[h2]Fields
type Fields = healthFields.BloodPressure
List of blood pressure sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.BloodPressure | List of blood pressure sampling data fields. |
bodyTemperature
Body temperature constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Body temperature data type. |
[h2]Model
type Model = healthModels.BodyTemperature
Data model for body temperature sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.BodyTemperature | Data model for body temperature sampling. |
[h2]Fields
type Fields = healthFields.BodyTemperature
List of body temperature sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.BodyTemperature | List of body temperature sampling data fields. |
[h2]AggregateResult
type AggregateResult = healthModels.BodyTemperatureAggregateResult
Model for body temperature sampling data aggregation results.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.BodyTemperatureAggregateResult | Model for body temperature sampling data aggregation results. |
[h2]AggregateRequest
type AggregateRequest = healthModels.BodyTemperatureAggregateRequest
Model for requesting aggregation of body temperature sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.BodyTemperatureAggregateRequest | Model for requesting aggregation of body temperature sampling data. |
[h2]AggregateFields
type AggregateFields = healthFields.BodyTemperatureAggregation
List of aggregate fields supported by body temperature sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.BodyTemperatureAggregation | List of aggregate fields supported by body temperature sampling data. |
dailyActivities
Daily activity constant and data model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Daily activity data type. |
[h2]Model
type Model = healthModels.DailyActivities
Data model for daily activity sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.DailyActivities | Data model for daily activity sampling. |
[h2]Fields
type Fields = healthFields.DailyActivities
List of daily activity sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.DailyActivities | List of daily activity sampling data fields. |
[h2]AggregateResult
type AggregateResult = healthModels.DailyActivitiesAggregateResult
Model for daily activity sampling data aggregation results.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.DailyActivitiesAggregateResult | Model for daily activity sampling data aggregation results. |
[h2]AggregateRequest
type AggregateRequest = healthModels.DailyActivitiesAggregateRequest
Model for requesting aggregation of daily activity sampling data.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.DailyActivitiesAggregateRequest | Model for requesting aggregation of daily activity sampling data. |
[h2]AggregateFields
type AggregateFields = healthFields.DailyActivitiesAggregation
List of aggregate fields supported by daily activity sampling data.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.DailyActivitiesAggregation | List of aggregate fields supported by daily activity sampling data. |
emotion
Emotion constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.1.0(18)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.1.0(18)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Emotion data type. |
[h2]Model
type Model = healthModels.Emotion
Data model for emotion sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.1.0(18)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.Emotion | Data model for emotion sampling. |
[h2]Fields
type Fields = healthFields.Emotion
List of emotion sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.1.0(18)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.Emotion | List of emotion sampling data fields. |
heartRate
Dynamic heart rate constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Dynamic heart rate data type. |
[h2]Model
type Model = healthModels.HeartRate
Data model for dynamic heart rate sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.HeartRate | Data model for dynamic heart rate sampling. |
[h2]Fields
type Fields = healthFields.HeartRate
List of dynamic heart rate sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.HeartRate | List of dynamic heart rate sampling data fields. |
[h2]AggregateResult
type AggregateResult = healthModels.HeartRateAggregateResult
Model for dynamic heart rate sampling data aggregation results.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.HeartRateAggregateResult | Model for dynamic heart rate sampling data aggregation results. |
[h2]AggregateRequest
type AggregateRequest = healthModels.HeartRateAggregateRequest
Model for requesting aggregation of dynamic heart rate sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.HeartRateAggregateRequest | Model for requesting aggregation of dynamic heart rate sampling data. |
[h2]AggregateFields
type AggregateFields = healthFields.HeartRateAggregation
List of aggregate fields supported by dynamic heart rate sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.HeartRateAggregation | List of aggregate fields supported by dynamic heart rate sampling data. |
heartRateVariability
Heart rate variability constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.1.0(18)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.1.0(18)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Heart rate variability data type. |
[h2]Model
type Model = healthModels.HeartRateVariability
Data model for heart rate variability sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.1.0(18)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.HeartRateVariability | Data model for heart rate variability sampling. |
[h2]Fields
type Fields = healthFields.HeartRateVariability
List of heart rate variability sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.1.0(18)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.HeartRateVariability | List of heart rate variability sampling data fields. |
height
Height constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Height data type. |
[h2]Model
type Model = healthModels.Height
Data model for height sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.Height | Data model for height sampling. |
[h2]Fields
type Fields = healthFields.Height
List of height sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.Height | List of height sampling data fields. |
restingHeartRate
Resting heart rate constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Resting heart rate data type. |
[h2]Model
type Model = healthModels.RestingHeartRate
Data model for resting heart rate sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.RestingHeartRate | Data model for resting heart rate sampling. |
[h2]Fields
type Fields = healthFields.RestingHeartRate
List of resting heart rate sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.RestingHeartRate | List of resting heart rate sampling data fields. |
[h2]AggregateResult
type AggregateResult = healthModels.RestingHeartRateAggregateResult
Model for resting heart rate sampling data aggregation results.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.RestingHeartRateAggregateResult | Model for resting heart rate sampling data aggregation results. |
[h2]AggregateRequest
type AggregateRequest = healthModels.RestingHeartRateAggregateRequest
Model for requesting aggregation of resting heart rate sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.RestingHeartRateAggregateRequest | Model for requesting aggregation of resting heart rate sampling data. |
[h2]AggregateFields
type AggregateFields = healthFields.RestingHeartRateAggregation
List of aggregate fields supported by resting heart rate sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.RestingHeartRateAggregation | List of aggregate fields supported by resting heart rate sampling data. |
skinTemperature
Skin temperature constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Skin temperature data type. |
[h2]Model
type Model = healthModels.SkinTemperature
Data model for skin temperature sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.SkinTemperature | Data model for skin temperature sampling. |
[h2]Fields
type Fields = healthFields.SkinTemperature
List of skin temperature sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.SkinTemperature | List of skin temperature sampling data fields. |
[h2]AggregateResult
type AggregateResult = healthModels.SkinTemperatureAggregateResult
Model for skin temperature sampling data aggregation results.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.SkinTemperatureAggregateResult | Model for skin temperature sampling data aggregation results. |
[h2]AggregateRequest
type AggregateRequest = healthModels.SkinTemperatureAggregateRequest
Model for requesting aggregation of skin temperature sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.SkinTemperatureAggregateRequest | Model for requesting aggregation of skin temperature sampling data. |
[h2]AggregateFields
type AggregateFields = healthFields.SkinTemperatureAggregation
List of aggregate fields supported by skin temperature sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.SkinTemperatureAggregation | List of aggregate fields supported by skin temperature sampling data. |
stress
Stress constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Stress data type. |
[h2]Model
type Model = healthModels.Stress
Data model for stress sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.Stress | Data model for stress sampling. |
[h2]Fields
type Fields = healthFields.Stress
List of stress sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.Stress | List of stress sampling data fields. |
[h2]AggregateResult
type AggregateResult = healthModels.StressAggregateResult
Model for stress sampling data aggregation results.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.StressAggregateResult | Model for stress sampling data aggregation results. |
[h2]AggregateRequest
type AggregateRequest = healthModels.StressAggregateRequest
Model for requesting aggregation of stress sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.StressAggregateRequest | Model for requesting aggregation of stress sampling data. |
[h2]AggregateFields
type AggregateFields = healthFields.StressAggregation
List of aggregate fields supported by stress sampling data.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.StressAggregation | List of aggregate fields supported by stress sampling data. |
weight
Weight constant and data model.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
[h2]Constant
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Name | Type | Description |
|---|---|---|
| DATA_TYPE | healthStore.DataType | Weight data type. |
[h2]Model
type Model = healthModels.Weight
Data model for weight sampling.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthModels.Weight | Data model for weight sampling. |
[h2]Fields
type Fields = healthFields.Weight
List of weight sampling data fields.
System capability: SystemCapability.Health.HealthStore
Since: 5.0.0(12)
Model restriction: This API can be used only in the stage model.
| Type | Description |
|---|---|
| healthFields.Weight | List of weight sampling data fields. |