We use essential cookies for the website to function, as well as analytics cookies for analyzing and creating statistics of the website performance. To agree to the use of analytics cookies, click "Accept All". You can manage your preferences at any time by clicking "Cookie Settings" on the footer. More Information.

Only Essential Cookies

Accept All

English

Products
Solutions
Events
Programs
Community
Training
Support

Materials Console

Managing Health Records

Last updated: 2026-05-13 08:10

Content overview

Writing Health Records to Health Service Kit

Deleting Health Records from Health Service Kit

Updating Health Records in Health Service Kit

Querying Health Records in Health Service Kit

After integrating Health Service Kit, you can manage users' health records by calling APIs in the HealthRecordController class.

NOTE

Before calling APIs provided by the Health Service Kit SDK for Android, make sure that the phone screen is unlocked and remains on. Otherwise, API calling may fail with the error code DISABLE_DATA_OPERATION. For details, please refer to error codes.
Before calling APIs provided by the Health Service Kit SDK, make sure that your app runs in the foreground, or is bound with a foreground app. Otherwise, API calling may fail with the error code APPLICATION_NOT_FORGROUND. For details, please refer to error codes.
If the Activity object (called in scenarios where app UIs are included) is passed when HuaweiHiHealth.getHealthRecordController is used to obtain the HealthRecordController object, the HMS Core version can be updated forcibly. If the Context object (called in scenarios where app UIs are not included) is passed, the HMS Core version cannot be updated forcibly.
Learn how to call APIs provided by the Health Service Kit SDK for Android by referring to Example of Calling APIs of the Health Service Kit SDK for Android before API calling.

Writing Health Records to Health Service Kit

You can use HealthRecordController to write health records to Health Service Kit as follows:

Check whether your app has the scope to operate on the health record data. For details about the data types, please refer to health record data types.
Create a HealthRecord object and specify the collector, time range, health data statistics, health data details, and other required information.
Create a HealthRecordInsertOptions object using HealthRecord.
Insert HealthRecordInsertOptions into Health Service Kit using the HealthRecordController.addHealthRecord method.

Keep HealthRecordId in the callback of addHealthRecord properly, so that you can use it for later Service updates of health records in Health Service Kit.
NOTE

The start time and end time passed for inserting health records must be later than the UNIX timestamp corresponding to January 1, 2014.

The following is the sample code for inserting the health record of a supported data type, the bradycardia data type.

Collapse
Word wrap
Dark theme
Copy code
// Note:
// 1. this refers to an Activity object.
// 2. Initialize objects of the HealthRecordController class each time before API calling. Otherwise, data reading may fail due to expired Activity or Context.
HealthRecordController healthRecordController = HuaweiHiHealth.getHealthRecordController(this);

// Set the start time and end time of the request body.
Calendar cal = Calendar.getInstance();
Date now = new Date();
cal.setTime(now);
long endTime = cal.getTimeInMillis();
cal.add(Calendar.HOUR_OF_DAY, -1);
long startTime = cal.getTimeInMillis();

// 1. Create a collector that carries heart rate details and sampleSetList that stores heart rate details.
DataCollector dataCollector =
    new com.huawei.hms.hihealth.data.DataCollector.Builder().setDataType(DataType.DT_INSTANTANEOUS_HEART_RATE)
        .setDataGenerateType(DataCollector.DATA_TYPE_RAW)
        .setPackageName(context)
        .setDataStreamName("such as step count")
        .build();
SampleSet sampleSet = SampleSet.create(dataCollector);
// Set the preset time span to 5 minutes, and the heart rate value of the sampling point to 88.
SamplePoint samplePoint =
    sampleSet.createSamplePoint().setTimeInterval(startTime , startTime + 300000L, TimeUnit.MILLISECONDS);
samplePoint.getFieldValue(Field.FIELD_BPM).setDoubleValue(88);
sampleSet.addSample(samplePoint);
// Set sampleSetList for storing health details.
List<SampleSet> sampleSetList = new ArrayList<>();
sampleSetList.add(sampleSet);

// Set samplePointList for storing statistical data points.
List<SamplePoint> samplePointList = new ArrayList<>();
// 2. Build a statistical data point for heart rate.
SamplePoint samplePoint1 = new SamplePoint.Builder(DataType.POLYMERIZE_CONTINUOUS_HEART_RATE_STATISTICS).build();
samplePoint1.getFieldValue(Field.FIELD_AVG).setDoubleValue(90);
samplePoint1.getFieldValue(Field.FIELD_MAX).setDoubleValue(100);
samplePoint1.getFieldValue(Field.FIELD_MIN).setDoubleValue(80);
samplePoint1.getFieldValue(Field.FIELD_LAST).setDoubleValue(80);
samplePoint1.setTimeInterval(startTime + 1L, startTime + 300000L, TimeUnit.MILLISECONDS);
samplePointList.add(samplePoint1);

// 3. Build a health record collector (using the bradycardia data type as an example) and a health record structure.
DataCollector dataCollector2 = new com.huawei.hms.hihealth.data.DataCollector.Builder()
    .setDataType(HealthDataTypes.DT_HEALTH_RECORD_BRADYCARDIA)
    .setDataGenerateType(DataCollector.DATA_TYPE_RAW)
    .setPackageName(context)
    .setDataStreamName("such as step count")
    .build();

HealthRecord.Builder healthRecordBuilder =
    new HealthRecord.Builder(dataCollector2).setSubDataSummary(samplePointList)
        .setSubDataDetails(sampleSetList)
        .setStartTime(startTime, TimeUnit.MILLISECONDS)
        .setEndTime(endTime, TimeUnit.MILLISECONDS);
// Set a value for each field of the bradycardia data type.
healthRecordBuilder.setFieldValue(HealthFields.FIELD_THRESHOLD, 40d);
healthRecordBuilder.setFieldValue(HealthFields.FIELD_AVG_HEART_RATE, 44d);
healthRecordBuilder.setFieldValue(HealthFields.FIELD_MAX_HEART_RATE, 48d);
healthRecordBuilder.setFieldValue(HealthFields.FIELD_MIN_HEART_RATE, 40d);
HealthRecord healthRecord = healthRecordBuilder.build();

HealthRecordInsertOptions insertOptions =
    new HealthRecordInsertOptions.Builder().setHealthRecord(healthRecord).build();

healthRecordController.addHealthRecord(insertOptions).addOnSuccessListener(new OnSuccessListener<String>() {
    @Override
    public void onSuccess(String healthRecordId) {
        // Save the returned healthRecordId, which is used for modification.
        healthRecordIdFromInsertResult = healthRecordId;
        logger("The health record is added successfully,please save the healthRecordId! " + healthRecordId);
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(Exception e) {
        logger(e.toString());
    }
});

NOTE

If you directly copy and use the preceding sample code, the following errors will be reported. The related solutions are provided as follows:

The helper function logger is not defined.

Solution: Define the logger function and do not perform any operation. For details, please refer to the following sample code.

Collapse
Word wrap
Dark theme
Copy code
private static final String TAG = "HealthRecordController";

/** 
 * Also send operation result logs to the logcat.
 * 
 * @param string Log string
 */ 
private void logger(String string) { 
    Log.i(TAG, string); 
}

The character string variable healthRecordIdFromInsertResult is not defined.
Solution: healthRecordIdFromInsertResult is used as the parameter for calling updateHealthRecord. The definition is as follows. Assign a value to healthRecordIdFromInsertResult after addHealthRecord is successfully called.
Collapse
Word wrap
Dark theme
Copy code
```
private String healthRecordIdFromInsertResult  = "";
```

Deleting Health Records from Health Service Kit

You can delete health records through HealthRecordController as follows:

Create a HealthRecordDeleteOptions object based on healthRecordIds, data type, or the start time and end time.
Call HealthRecordController.deleteHealthRecord to delete HealthRecordDeleteOptions from Health Service Kit.
NOTE
1. The start time and end time passed for deleting health records must be later than the UNIX timestamp corresponding to January 1, 2014.
2. If healthRecordIds is not empty, it will be used to delete health records. Otherwise, health records will be deleted based on the data type or the start and end times.

Sample code for deleting health records from Health Service Kit:

Collapse
Word wrap
Dark theme
Copy code
// Note:
// 1. this refers to an Activity object.
// 2. Initialize objects of the HealthRecordController class each time before API calling. Otherwise, data reading may fail due to expired Activity or Context.
HealthRecordController healthRecordController = HuaweiHiHealth.getHealthRecordController(this);

// Build the time range of the request object: start time and end time.
// Note that the start time and end time must be later than the UNIX timestamp corresponding to January 1, 2014.
Calendar cal = Calendar.getInstance();
Date now = new Date();
cal.setTime(now);
long endTime = cal.getTimeInMillis();
cal.add(Calendar.DAY_OF_YEAR, -2);
long startTime = cal.getTimeInMillis();
// Build dataType for the request object.
DataType dataType = HealthDataTypes.DT_HEALTH_RECORD_BRADYCARDIA;
// Build subDataTypeList for the request object.
List<DataType> subDataTypeList = Collections.singletonList(DataType.DT_INSTANTANEOUS_HEART_RATE);
// Build healthRecordIds for the request object.
List<String> healthRecordIds = Collections.singletonList("healthRecordIdFromInsertResult");

// Build the request body with the deletion object.
HealthRecordDeleteOptions deleteRequest = new HealthRecordDeleteOptions.Builder()
    .setHealthRecordIds(healthRecordIds)
    .isDeleteSubData(true)
    .setDataType(dataType)
    .setSubDataTypeList(subDataTypeList)
    .setTimeInterval(startTime, endTime, TimeUnit.MILLISECONDS).build();

// Call deleteHealthRecord to delete the health record.
Task<Void> deleteTask = healthRecordController.deleteHealthRecord(deleteRequest);
deleteTask.addOnSuccessListener(new OnSuccessListener<Void>() {
    @Override
    public void onSuccess(Void aVoid) {
        Log.i("HealthRecords","HealthRecord deleted successfully.!");
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(Exception e) {
        Log.i("HealthRecords","Failed to delete data" + e.getMessage());
    }
});

Updating Health Records in Health Service Kit

You can use HealthRecordController to update health records that have been written to Health Service Kit as follows:

Check whether your app has the scope to operate on the health record data. For details about the data types, please refer to health record data types.
Create a HealthRecord object and specify the collector, time range, health data statistics, health data details, and other required information.
Create a HealthRecordUpdateOptions object using HealthRecord and HealthRecordId that is used in the callback for writing health records to Health Service Kit.
Update health records and related data in Health Service Kit using the HealthRecordController.updateHealthRecord method.

NOTE

1. The start time and end time passed for inserting health records must be later than the UNIX timestamp corresponding to January 1, 2014.

2. If no health record matching HealthRecordId is found, an error code will be thrown.

The following is the sample code for updating the health record of a supported data type, the bradycardia data type.

Collapse
Word wrap
Dark theme
Copy code
// Note:
// 1. this refers to an Activity object.
// 2. Initialize objects of the HealthRecordController class each time before API calling. Otherwise, data reading may fail due to expired Activity or Context.
HealthRecordController healthRecordController = HuaweiHiHealth.getHealthRecordController(this);

// Set the start time and end time of the request body.
Calendar cal = Calendar.getInstance();
Date now = new Date();
cal.setTime(now);
long endTime = cal.getTimeInMillis();
cal.add(Calendar.HOUR_OF_DAY, -1);
long startTime = cal.getTimeInMillis();

// 1. Create a collector that carries heart rate details and sampleSetList that stores heart rate details.
DataCollector dataCollector =
    new com.huawei.hms.hihealth.data.DataCollector.Builder().setDataType(DataType.DT_INSTANTANEOUS_HEART_RATE)
        .setDataGenerateType(DataCollector.DATA_TYPE_RAW)
        .setPackageName(context)
        .setDataStreamName("such as step count")
        .build();
SampleSet sampleSet = SampleSet.create(dataCollector);
// Set the preset time span to 5 minutes, and the heart rate value of the sampling point to 90.
SamplePoint samplePoint =
    sampleSet.createSamplePoint().setTimeInterval(startTime , startTime + 300000L, TimeUnit.MILLISECONDS);
samplePoint.getFieldValue(Field.FIELD_BPM).setDoubleValue(90);
sampleSet.addSample(samplePoint);
// Set sampleSetList for storing health details.
List<SampleSet> sampleSetList = new ArrayList<>();
sampleSetList.add(sampleSet);

// Set samplePointList for storing statistical data points.
List<SamplePoint> samplePointList = new ArrayList<>();
// 2. Build a statistical data point for heart rate.
SamplePoint samplePoint1 = new SamplePoint.Builder(DataType.POLYMERIZE_CONTINUOUS_HEART_RATE_STATISTICS).build();
samplePoint1.getFieldValue(Field.FIELD_AVG).setDoubleValue(90);
samplePoint1.getFieldValue(Field.FIELD_MAX).setDoubleValue(100);
samplePoint1.getFieldValue(Field.FIELD_MIN).setDoubleValue(80);
samplePoint1.getFieldValue(Field.FIELD_LAST).setDoubleValue(80);
samplePoint1.setTimeInterval(startTime + 1L, startTime + 300000L, TimeUnit.MILLISECONDS);
samplePointList.add(samplePoint1);

// 3. Build a health record collector (using the bradycardia data type as an example) and a health record structure.
DataCollector dataCollector2 = new com.huawei.hms.hihealth.data.DataCollector.Builder()
    .setDataType(HealthDataTypes.DT_HEALTH_RECORD_BRADYCARDIA)
    .setDataGenerateType(DataCollector.DATA_TYPE_RAW)
    .setPackageName(context)
    .setDataStreamName("such as step count")
    .build();

HealthRecord.Builder healthRecordBuilder =
    new HealthRecord.Builder(dataCollector2).setSubDataSummary(samplePointList)
        .setSubDataDetails(sampleSetList)
        .setStartTime(startTime, TimeUnit.MILLISECONDS)
        .setEndTime(endTime, TimeUnit.MILLISECONDS);
// Set a value for each field of the bradycardia data type.
healthRecordBuilder.setFieldValue(HealthFields.FIELD_THRESHOLD, 42d);
healthRecordBuilder.setFieldValue(HealthFields.FIELD_AVG_HEART_RATE, 45d);
healthRecordBuilder.setFieldValue(HealthFields.FIELD_MAX_HEART_RATE, 48d);
healthRecordBuilder.setFieldValue(HealthFields.FIELD_MIN_HEART_RATE, 42d);
HealthRecord healthRecord = healthRecordBuilder.build();

// 4. Build updateOptions to be updated. Remember to carry healthRecordId, which will be returned after the insertion is successful.
HealthRecordUpdateOptions updateOptions = new HealthRecordUpdateOptions.Builder().setHealthRecord(healthRecord)
    .setHealthRecordId(healthRecordIdFromInsertResult)
    .build();

healthRecordController.updateHealthRecord(updateOptions).addOnSuccessListener(new OnSuccessListener<Void>() {
    @Override
    public void onSuccess(Void aVoid) {
        logger("Health record updated successfully.");
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(Exception e) {
        logger(e.toString());
    }
});

NOTE

If you directly copy and use the preceding sample code, the following errors will be reported. The related solutions are provided as follows:

healthRecordIdFromInsertResult is not defined.
Solution: Define the string variable using the value of HealthRecordId that is used in the callback for writing health records to Health Service Kit.

The helper function logger is not defined.

Solution: Define the logger function as follows:

Collapse
Word wrap
Dark theme
Copy code
private static final String TAG = "HealthRecordController";

/** 
 * Also send operation result logs to the logcat.
 * 
 * @param string Log string
 */ 
private void logger(String string) { 
    Log.i(TAG, string); 
}

Querying Health Records in Health Service Kit

You can use HealthRecordController to query health records that have been written to Health Service Kit as follows:

Check whether your app has the scope to operate on the health record data. For details about the data types, please refer to health record data types.
Create a HealthRecordReadOptions object based on the query time and related conditions.
Uses the HealthRecordController.getHealthRecord method to query health records in Health Service Kit.
NOTE
1. The start time and end time for querying health records must be later than the UNIX timestamp corresponding to January 1, 2014.
2. The start time and end time for querying cannot span over 31 days.

The following is the sample code for querying the health record of a supported data type, the bradycardia data type.

Collapse
Word wrap
Dark theme
Copy code
// Note:
// 1. this refers to an Activity object.
// 2. Initialize objects of the HealthRecordController class each time before API calling. Otherwise, data reading may fail due to expired Activity or Context.
HealthRecordController healthRecordController = HuaweiHiHealth.getHealthRecordController(this);

// Set the start time and end time of the request body.
Calendar cal = Calendar.getInstance();
Date now = new Date();
cal.setTime(now);
long endTime = cal.getTimeInMillis();
cal.add(Calendar.DAY_OF_YEAR, -1);
long startTime = cal.getTimeInMillis();

// Build the HealthRecordReadOptions parameter for reading health records.
List<DataType> subDataTypeList = new ArrayList<>();
subDataTypeList.add(DataType.DT_INSTANTANEOUS_HEART_RATE);
HealthRecordReadOptions healthRecordReadOptions =
    new HealthRecordReadOptions.Builder().setTimeInterval(startTime, endTime, TimeUnit.MILLISECONDS)
        .readHealthRecordsFromAllApps()
        .readByDataType(HealthDataTypes.DT_HEALTH_RECORD_BRADYCARDIA)
        .setSubDataTypeList(subDataTypeList)
        .build();

// Pass the HealthRecordReadOptions parameter to query the health record.
Task<HealthRecordReply> task = healthRecordController.getHealthRecord(healthRecordReadOptions);
task.addOnSuccessListener(new OnSuccessListener<HealthRecordReply>() {
    @Override
    public void onSuccess(HealthRecordReply readResponse) {
        logger("Get HealthRecord was successful!");
        // Print the obtained health records.
        List<HealthRecord> recordList = readResponse.getHealthRecords();
        for (HealthRecord record : recordList) {
            if (record == null) {
                continue;
            }
            dumpHealthRecord(record);
            logger("Print detailed data points associated with health records");
            for (SampleSet dataSet : record.getSubDataDetails()) {
                dumpDataSet(dataSet);
            }
        }
    }
});
task.addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(Exception e) {
        logger(e.toString());
    }
});

NOTE

If you directly copy and use the preceding sample code, the following errors will be reported. The related solutions are provided as follows:

The helper function logger is not defined.

Solution: Define the logger function as follows:

Collapse
Word wrap
Dark theme
Copy code
private static final String TAG = "HealthRecordController";

/** 
 * Also send operation result logs to the logcat.
 * 
 * @param string Log string
 */ 
private void logger(String string) { 
    Log.i(TAG, string); 
}

The helper function dumpHealthRecord is not defined.

Solution: Define the dumpHealthRecord function as follows:

Collapse
Word wrap
Dark theme
Copy code
/** 
  * Print the information in the HealthRecord object.
 * 
  * @param healthRecord Health record object
 */ 
private void dumpHealthRecord(HealthRecord healthRecord) { 
    logger("Print health record summary information!");
    DateFormat dateFormat = DateFormat.getDateInstance();
    DateFormat timeFormat = DateFormat.getTimeInstance();
    if (healthRecord != null) {
        logger("\tHealthRecordIdentifier: " + healthRecord.getHealthRecordId() + "\n\tpackageName: "
            + healthRecord.getDataCollector().getPackageName() + "\n\tStartTime: "
            + dateFormat.format(healthRecord.getStartTime(TimeUnit.MILLISECONDS)) + " "
            + timeFormat.format(healthRecord.getStartTime(TimeUnit.MILLISECONDS)) + "\n\tEndTime: "
            + dateFormat.format(healthRecord.getEndTime(TimeUnit.MILLISECONDS)) + " "
            + timeFormat.format(healthRecord.getEndTime(TimeUnit.MILLISECONDS)) + "\n\tHealthRecordDataType: "
            + healthRecord.getDataCollector().getDataType().getName() + "\n\tHealthRecordDataCollectorId: "
            + healthRecord.getDataCollector().getDataStreamId() + "\n\tmetaData: " + healthRecord.getMetadata()
            + "\n\tFileValueMap: " + healthRecord.getFieldValues());

        if (healthRecord.getSubDataSummary() != null && !healthRecord.getSubDataSummary().isEmpty()) {
            SimpleDateFormat sDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss", Locale.getDefault());

            for (SamplePoint samplePoint : healthRecord.getSubDataSummary()) {
                logger("Sample point type: " + samplePoint.getDataType().getName());
                logger("Start: " + sDateFormat.format(new Date(samplePoint.getStartTime(TimeUnit.MILLISECONDS))));
                logger("End: " + sDateFormat.format(new Date(samplePoint.getEndTime(TimeUnit.MILLISECONDS))));
                for (Field field : samplePoint.getDataType().getFields()) {
                    logger("Field: " + field.getName() + " Value: " + samplePoint.getFieldValue(field));
                }
                logger(System.lineSeparator());
            }
        }
    }
}

The helper function dumpDataSet is not defined.

Solution: Define the dumpDataSet function as follows:

Collapse
Word wrap
Dark theme
Copy code
/** 
  * Print SamplePoint in the SampleSet object as an output.
  * 
* @param sampleSet Sampling dataset
  */ 
private void dumpDataSet(SampleSet sampleSet) { 
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); 

    for (SamplePoint samplePoint : sampleSet.getSamplePoints()) { 
        logger("Sample point type: " + samplePoint.getDataType().getName()); 
        logger("Start: " + dateFormat.format(new Date(samplePoint.getStartTime(TimeUnit.MILLISECONDS)))); 
        logger("End: " + dateFormat.format(new Date(samplePoint.getEndTime(TimeUnit.MILLISECONDS)))); 
        for (Field field : samplePoint.getDataType().getFields()) { 
            logger("Field: " + field.getName() + " Value: " + samplePoint.getFieldValue(field)); 
        } 
    } 
}

Managing Exercise Records

Reading Real-time Data

Send feedback

Was this page helpful?

Send feedback

Reach out to us through the community for any other questions.

Community Q&A Intelligent Assistant

Search in Guides

Search only in Developing Your AppSearch titles only

Enter a keyword.