faq what are the main features of the samsung privileged health sdk? the main features of the samsung privileged health sdk include: tracking raw and processed health sensor data on galaxy watch getting data for multiple health sensors for information about the available trackers, see what data is provided. some health tracker types are “batching”: accelerometer heart rate ppg green. batching collects measured sensor data and periodically invokes a tracking event listener. for example, every 12 seconds for ppg green. this enables the watch’s sensor data to be tracked continuously and provide more granular results while conserving battery life. how do i get access to the samsung privileged health sdk? to use the samsung privileged health sdk, request for the samsung partner program. when your request is reviewed, you receive information about how to access the sdk content. does the samsung privileged health sdk work on android phones? no. the samsung privileged health sdk supports only galaxy watch4 and later models running wear os powered by samsung. it does not support other mobile devices, such as smartphones. can supported health tracker types of the samsung privileged health sdk differ depending on the galaxy watch model or wear os version? yes. the supported health tracker types can differ depending on the specific galaxy watch model and the watch software version. the samsung privileged health sdk provides a capability check api. it retrieves which tracker types are available on the user’s watch and can therefore be used by your application. can i read data from more than 1 health tracker simultaneously? yes, depending on the tracker type. there are 2 tracker types: on-demand, such as bia (body composition) and ecg (electrocardiogram) batching, such as accelerometer and heart rate only 1 on-demand tracker can be used at a time. multiple batching trackers can be used simultaneously. the measure blood oxygen level and heart rate on galaxy watch code lab demonstrates how to implement running 2 types of trackers concurrently. notethe heart rate and ppg green trackers give invalid results while tracking bia. they return to normal functionality after the bia measurement. is there emulator support for developing applications with the samsung privileged health sdk? no. the samsung privileged health sdk doesn't support the emulator. development with the sdk requires the galaxy watch device. can i detect when users take the galaxy watch off their wrist? yes, depending on the tracker. for the heart rate, spo2, bia (body composition), and sweat loss trackers, you can use the samsung privileged health sdk to monitor the status field with the update listener. for example, a heart rate status value of “-3” means that the wearable is not being worn. for information about other status values and trackers, refer to the documentation. alternatively, you can check the sensor.type_low_latency_offbody_detect value. for more information, see sensorevent. does the samsung privileged health sdk receive its data through samsung health? no. the samsung privileged health sdk does not share data with samsung health. health services also provides heart rate tracking. how is heart rate tracking with the samsung privileged health sdk different? the samsung privileged health sdk provides heart rate data tracking with ibi (inter-beat interval), which can be used to calculate hrv (heart rate variability). this information can be used for more detailed analysis. the android sensor manager also provides accelerometer tracking. how is accelerometer tracking with the samsung privileged health sdk different? the accelerometer tracking provided by the samsung privileged health sdk records data samples with 25hz resolution in batches of 12 seconds (300 samples). batching reduces battery consumption and enables you to track data over longer durations.

development environment check prerequisites first and follow all steps below to create a samsung health’s partner app. prerequisites check following prerequisites before downloading samsung health sdk for android. android version android 8.0 oreo (api level 26) or above available devices android smartphones including non-samsung devices samsung health version a partner app runs with samsung health 4.0 or higher downloading samsung health sdk for android the sdk can be downloaded on the samsung developer site. folder in sdk description docs api reference describes the sdk's health data apis. programming guide contains development information to create a samsung health's partner app with health data access. libs samsung-health-data-va.b.c.aar health data library of samsung health sdk for android. samples simplehealth sample application that demonstrates how to read step count data. stepdiary sample application that demonstrates how to read step count and daily step count trend data. foodnote sample application to check daily calorie intake. tools dataviewer.apk a test tool for the connection between your app and samsung health that works via the samsung health's developer mode. it reads samsung health's saved data.

faq common | what are the benefits of samsung health sdk for android? samsung health app is a most popular health app and has more than 50 million of monthly active users. it works not only on samsung smartphones but also non-samsung phones if the device supports android marshmallow or above. it consists a big ecosystem including various health apps and connected accessory devices. samsung health sdk for android enables your app to manage the user’s health data with the unified interface by connecting to samsung health app. you can have more enhanced chances with a partnership of samsung health. common | i know the sdk needs samsung health installation. can samsung health be installed to all phones? if not, how can i know the samsung health’s availability on the device? even though samsung health is installed in android smartphones with marshmallow or above including samsung and non-samsung smartphones, some phones cannot support samsung health. its check code needs to be added to prevent a relevant situation. the sdk’s health data provides a solution to check it through healthconnectionerrorresult.hasresolution(). if the app meets the following cases, it means that the device is not available for samsung health. healthdatastore.connectservice() gives a failure event. healthconnectionerrorresult.hasresolution() returns false. see an example for failure exception handling. health data | i would like to know data’s common properties. all data type interfaces extend the healthconstants.common interface basically. some data types extend healthconstants.discretemeasurement and others extend healthconstants.sessionmeasurement depending on whether the end measured time exists. for example, healthconstants.sleep extends: healthconstants.common healthconstants.sessionmeasurement you can set healthconstants.sleep's following properties including its own ones. healthconstants.common.device_uuid healthconstants.sessionmeasurement.start_time healthconstants.sessionmeasurement.end_time see the "properties" description of each data type interface in api reference for more information. sleep data can be set as the example shown below. public class healthdataexample { // the state of connection private healthdatastore mstore; private void insertsleepdata(long start, long end, long offset) { healthdevice mydevice = new healthdevicemanager(mstore).getlocaldevice(); healthdata data = new healthdata(); data.setsourcedevice(mydevice.getuuid()); // fills all mandatory properties out data.putlong(healthconstants.sleep.start_time, start); data.putfloat(healthconstants.sleep.end_time, end); data.putlong(healthconstants.sleep.time_offset, offset); healthdataresolver resolver = new healthdataresolver(mstore, null); healthdataresolver.insertrequest insrequest = new healthdataresolver.insertrequest.builder() .setdatatype(healthconstants.sleep.health_data_type) .build(); // do something } } health data | there are two data types for steps. which data type is better? handling all use cases for the phone and linked multi-accessory devices is not easy with it because the phone and accessory device like galaxy watch can provide step count data at the same time or not depending on how many devices are carried by the user. samsung health sdk provides the following data types for steps: healthconstants.stepdailytrend healthconstants.stepcount healthconstants.stepdailytrend is used to generally to read the user’s daily steps. especially, its source_type_all provides the day’s total steps simply without excluding duplicated steps when the user carries one more devices at the same time. healthconstants.stepcount is useful for: getting each source device’s step count getting real-time step count of the phone that samsung health is installed. health data | the inserted health data’s measured time looks different. how can i solve it? if new data is inserted to the health data store, created_time, updated_time of healthconstants.common are assigned by the system automatically. so you don’t need to set them separately. data’s start_time or end_time indicates its utc measurement time in milliseconds. be careful not to set start_time or end_time as the device’s current local time. time_offset is indicated by the time zone and daylight saving time in milliseconds and it helps in showing the health data’s measured time properly in the device. the following example shows getting the current device’s time_offset. import java.util.timezone; public class heathdataexample { long gettimeoffset(long intaketime) { return timezone.getdefault().getoffset(intaketime); } }

samsung privileged health sdk the galaxy watch is equipped with samsung’s unique bioactive sensor that drives the next era of digital health monitoring. first introduced on the galaxy watch4 series, the bioactive sensor uses a single unique chip that combines three powerful health sensors — optical heart rate, electrical heart signal, and bioelectrical impedance analysis — to deliver extensive readings that include heart rate and blood oxygen level. what is samsung privileged health sdk the samsung privileged health sdk is specialized for galaxy watch4 devices or later. it provides both raw sensor signal data from the samsung bioactive sensor and processed data with our differentiated features. the sdk supports an improved health tracking capability to allow your applications to track the user's health data accurately with the accelerometer, raw ecg (electrocardiogram), ppg (photoplethysmogram), and heart rate including inter-beat interval. in addition, it provides more advanced health features such as the body composition measurement, to enable compelling use cases for health and fitness applications. the blood oxygen level and sweat loss after a running workout are also useful data to check a user's health status. what you can do a watch application using the samsung privileged health sdk runs on a galaxy watch with wear os powered by samsung. it will help users to monitor their overall health data and to provide an advanced healthy life. the sdk can be utilized in various fields such as fitness, remote patient monitoring, senior care, digital therapy, fatigue risk management, and corporate wellness. what are the advantages let's review more advantages of the samsung privileged health sdk. low watch battery consumption the samsung privileged health sdk's accelerometer data, ppg green data, and heart rate data are all received as a batching event. the sdk's batching operation gathers sensor data in an application processor without waking up the cpu and sends an event at specific periods to a watch application. this minimizes the watch's battery consumption and enables a watch application to track the user's status for the entire day. receiving raw sensor data the accelerometer, ecg, and ppg green data are provided as raw data by the samsung privileged health sdk. this is very useful to conduct various analyses and more in-depth research with your own algorithm. using galaxy watch specific features measuring the user's body composition, blood oxygen level, heart rate including the inter-beat interval, and sweat loss after a running workout is a feature specific to the galaxy watch. using the privileged health sdk, your watch application can easily measure these data. what data is provided the following data types are supported by the samsung privileged health sdk: data type details accelerometer raw x, y, and z axis data. provided as a batching event. bia body composition data. provided as an on-demand event. ecg raw electrocardiogram data. provided as an on-demand event. heart rate heart rate data, including inter-beat interval. provided as a batching event. ppg green raw data from ppg green led. provided as a batching event. ppg ir raw data from ppg infrared led. provided as an on-demand event. ppg red raw data from ppg red led. provided as an on-demand event. skin temperature skin temperature data. provided as a batching and on-demand events. spo2 blood oxygen level. provided as an on-demand event. sweat loss lost water amount after a running workout. provided as an on-demand event. experience samsung privileged health sdk you can practice using the samsung privileged health sdk with our code labs. visit code lab to get started. code labgalaxy watch, health measure blood oxygen level on galaxy watch code labgalaxy watch, health measure blood oxygen level and heart rate on galaxy watch code labgalaxy watch, health measure skin temperature on galaxy watch code labgalaxy watch, health transfer heart rate data from galaxy watch to a mobile device partner app program our partner app program is an exclusive service for the samsung privileged health sdk that allows users to discover engaging health and fitness applications. the samsung privileged health sdk is now available for selected partners and we are reviewing all applications to join. apply for partner app program restrictions the samsung privileged health sdk only works on galaxy watch4 devices or later models running wear os powered by samsung. samsung privileged health sdk does not support an emulator. more content

overview package class tree deprecated index com.samsung.android.sdk.healthdata interface healthdataresolver.insertrequest enclosing class: healthdataresolver public static interface healthdataresolver.insertrequest this interface is able to make a request to insert health data for the specific health data type. request for inserting data healthdataresolver.insert() helps that your application saves a new measured data to samsung health. the following information is mandatory to build an insertrequest instance. mandatory information description data type set the data type with: insertrequest.builder.setdatatype() source device the device id that provides health data. set it with: healthdata.setsourcedevice() data's mandatory properties set mandatory properties of the health data type by referring to: data type definition you can make a request instance with insertrequest.builder.build(). inserting data example you can save health data to samsung health with healthdataresolver.insert() after setting detailed property values of the created healthdata instance. the health data framework registers the current device where your application is installed. if the source device is the current device, its id can be checked as shown below. // the state of connection private final healthdatastore mstore; public static final string app_tag = "myapp"; private void insertglucose(long start, long offset, float value) { // set the source device as the current device healthdevice mydevice = new healthdevicemanager(mstore).getlocaldevice(); healthdata data = new healthdata(); data.setsourcedevice(mydevice.getuuid()); and the data instance's properties including mandatory ones needs to be set. // set properties including mandatory ones data.putlong(healthconstants.bloodglucose.start_time, start); data.putlong(healthconstants.bloodglucose.time_offset, offset); data.putint(healthconstants.bloodglucose.measurement_type, healthconstants.bloodglucose.measurement_type_whole_blood); the measured data value needs to be set after checking defined data unit. each property in api reference lets you know it. in this case, see healthconstants.bloodglucose.glucose data.putfloat(healthconstants.bloodglucose.glucose, value); an insertrequest instance is created by insertrequest.builder.build() with setting the data type. it's ready to add data to samsung health if the data is added to the insertrequest. healthdataresolver.insertrequest insrequest = new healthdataresolver.insertrequest.builder() .setdatatype(healthconstants.bloodglucose.health_data_type) .build(); // add health data insrequest.addhealthdata(data); healthdataresolver resolver = new healthdataresolver(mstore, null); try { resolver.insert(insrequest).setresultlistener(mistresult); } catch (exception e) { log.d(app_tag, "resolver.insert() fails."); } } healthdataresolver.insert(com.samsung.android.sdk.healthdata.healthdataresolver.insertrequest) sends a request to samsung health. a data validation exception is received in healthresultholder.baseresult. it gives a request's result state and a number of inserted data. private final healthresultholder.resultlistener<healthresultholder.baseresult> mistresult = new healthresultholder.resultlistener<healthresultholder.baseresult>(){ @override public void onresult(healthresultholder.baseresult result) { if(result.getstatus() != status_successful) { // check the error } else { // check the count of inserted data log.d(app_tag, "count of inserted data: " + result.getcount()); } } }; since: 1.0.0 nested class summary nested classes modifier and type interface and description static class healthdataresolver.insertrequest.builder this class is a builder to configure healthdataresolver.insertrequest. method summary all methods instance methods abstract methods modifier and type method and description void addhealthdata(healthdata object) adds health data to insert. void addhealthdata(list<healthdata> objectlist) adds a health data list to insert. method detail addhealthdata void addhealthdata(healthdata object) adds health data to insert. parameters: object - the health data instance. the source device of object should be valid. throws: illegalargumentexception - if source device is not set or data is null since: 1.0.0 addhealthdata void addhealthdata(list<healthdata> objectlist) adds a health data list to insert. parameters: objectlist - the list of health data objects. the source device for each health data has to be defined in advance. throws: illegalargumentexception - if source device is not set or data list is null since: 1.0.0

overview package class tree deprecated index com.samsung.android.sdk.healthdata class healthdataobserver java.lang.object com.samsung.android.sdk.healthdata.healthdataobserver public abstract class healthdataobserver extends object this class defines a health data observer for health data change. adding an observer you can add an observer for the specific health data type and get notification in onchange(string) if the designated health data is changed. in case that you add an observer for the data type that updates too frequently in short time like step count, it can send too many events to your application and it can bring degradation of your application's performance. check that your application needs to update data with real-time from samsung health again before adding an observer. a health data observer can be defined as below. public class healthdataobserverexample { // the state of connection private healthdatastore mstore; public static final string app_tag = "myapp"; private final healthdataobserver mobserver = new healthdataobserver(null) { // checks notification for changed health data @override public void onchange(string datatypename) { log.d(app_tag, "health data is changed."); readchangeddata(datatypename); } }; when you add an observer for the specific health data type, specify the data type name as below. only data type is allowed to be observed. public void start() { // adds an observer for change of the weight healthdataobserver.addobserver(mstore, healthconstants.weight.health_data_type, mobserver); } the change notification is received in onchange(string) and you can check updated health data as below. private void readchangeddata(string datatypename) { healthdataresolver resolver = new healthdataresolver(mstore, null); healthdataresolver.readrequest rdrequest = new healthdataresolver.readrequest.builder() .setdatatype(datatypename) .build(); try { // make an asynchronous request to read health data resolver.read(rdrequest).setresultlistener(mrdlistener); } catch (exception e) { log.d(app_tag, "healthdataresolver.read() fails."); } } private final healthresultholder.resultlistener<healthdataresolver.readresult> mrdlistener = new healthresultholder.resultlistener<healthdataresolver.readresult>() { @override public void onresult(healthdataresolver.readresult result) { try { iterator<healthdata> iterator = result.iterator(); if (iterator.hasnext()) { healthdata data = iterator.next(); // check the result } } finally { result.close(); } } }; } since: 1.0.0 constructor summary constructors constructor and description healthdataobserver(handler handler) creates a healthdataobserver instance. method summary all methods static methods instance methods abstract methods concrete methods modifier and type method and description static void addobserver(healthdatastore store, string datatypename, healthdataobserver observer) adds an observer that wants to follow data change for the given health data type. abstract void onchange(string datatypename) called if health data registered as an observer is changed. static void removeobserver(healthdatastore store, healthdataobserver observer) removes a registered observer. constructor detail healthdataobserver public healthdataobserver(handler handler) creates a healthdataobserver instance. parameters: handler - the handler to run onchange(string). if it's null, onchange(string) event is run on binder thread which is invoked by samsung health. since: 1.0.0 method detail onchange public abstract void onchange(string datatypename) called if health data registered as an observer is changed. parameters: datatypename - the data type name that health data is changed since: 1.0.0 addobserver public static void addobserver(healthdatastore store, string datatypename, healthdataobserver observer) adds an observer that wants to follow data change for the given health data type. parameters: store - the health data store for connection datatypename - the health data type name to follow change observer - an observer to receive notification if health data is changed throws: illegalargumentexception - if the data type or observer is invalid illegalstateexception - if the instance of health data store is invalid or a remote-invocation error occurs in the connection since: 1.0.0 removeobserver public static void removeobserver(healthdatastore store, healthdataobserver observer) removes a registered observer. parameters: store - health data store for connection observer - the added observer throws: illegalargumentexception - if the observer is invalid illegalstateexception - if the instance of health data store is invalid or a remote-invocation error occurs in the connection since: 1.0.0

release note introduction release date: september 26, 2019 release contents health device specs ble compatible guidelines for following health devices:blood glucose meterblood pressure monitorheart rate monitorweight scalesamsung health specifications for following health devices:exercise monitorenhanced heart rate monitorpedometersleep monitorsamsung health specification for multiple health service devices:handling multiple data typessetting user info verification tool it checks overall implementation of your health device for whole samsung health’s device specs. change history sep 26, 2019 [update] tools testapps_weight.apk and verificationtool.apk are updated. a pop-up displays for a device’s location access if it is not enabled. april 11, 2019 [new feature] weight scale user data service is defined for a multiple user scenario. see its spec 2.0. [update] tools testapps_weight.apk and verificationtool.apk are updated as a weight scale spec update. nov 23, 2017 the following tools to test your health device are added. test apps verification tool oct 17, 2017 samsung health device sdk v1.0.0 a new sdk release

developer mode a partner app can connect with samsung health if its package name and signature (sha256) are same with the registered info in samsung health. the registered app signature is from the partner app's release key. but in many cases, developers use a different app signing key to test or debug the app. to make it easy, samsung health provides a developer mode. the developer mode is not activated by default. activating the developer mode requires an access key from samsung health 6.11. the access key is shared by samsung health team after a partnership approval. how to activate the developer mode you can activate it with the following steps: select the action overflow of samsung health on the top-left. select the settings icon in the action list's top-right. select about samsung health. tap the version line region quickly 10 times or more. the exact region to tap is illustrated with the blue box in the figure below. if it succeeds, a developer mode button displays. select the developer mode button and enter the developer mode page. enter your app package name and access code that samsung health team shared and select the add button. the access code is case-sensitive. if it succeeds, your app package name will be listed up below. it means the developer mode is activated for your app. back to about samsung health with the back button on the top-left and select the info icon on the top-right. now you can test your app with samsung health. if your app package name is not added well please check the entered app package name and access code carefully. they should be matched exactly. a failure can be from entering: a different app package name unmatched case for an access key how long will be maintained the added app's developer mode in the developer mode page is valid until uninstalling samsung health. and it doesn't work for another app that has a different app package name. if samsung health is reinstalled, enter your app package name and its access code. if you remove your app from the developer mode page by selecting the "-" icon, the developer mode will be deactivated for your app.

privacy privacy is a key for handling health data. samsung health sdk for android enables your application to access health data based on the user's consent. permission manager the sdk's supported data types except health document need to gain permission through permissionmanager. an application needs to declare proper permissions for handling required health data types and to consider secureexception when the application didn't gain a user consent. the user can withdraw consent at any time. see permissionmanager for permission declaration and request. samsung health add the partner app's permission info under samsung health > settings > data permissions > [partner app] after a success of healthpermissionmanager.requestpermission() in the partner app. on the other hand, the partner app needs to make a permission setting menu separately. in the menu, the app calls healthpermissionmanager.requestpermission() with required permissions. the samsung health's health data framework pops up the permission ui. a permission result event is retreived after the user's agreement or denial on the permission popup. the app should provide an interface that the user may change data permission at any time. the user consent is limited to the device. even if multiple devices use the same samsung account, the application has to acquire the user consent on each device independently. instant permission a very sensitive data type like a health document requires gaining instant permission. instant permission is created for one-time data access. an app that handles a health document has to call the instant permission api whenever it needs to access data. related apis are: healthdataresolver.insertwithpermission() healthdataresolver.readwithpermission() healthdataresolver.deletewithpermission()

verification tool verification tool download | sep 26, 2019 (211.32 kb) the verification tool of samsung health sdk for device enables you to check the whole sdk specifications on your health device. you can check a verification result with the verification tool and fix your implementation on the health device. prerequisites verification tool downloads the verification tool and install it on an android phone. it runs on android 6.0 marshmallow (api level 23) or above. ble health device turn on the phone’s bluetooth. turn on your ble health device that follows samsung health device specs. how to use verification tool 1. run the verification tool and select one of health devices in the list. 2. allow the location permission. 3. tap start scan button. 4. select your ble health device. if it is not shown up, check the phone’s bluetooth state or your ble health device. 5. select ok. 6. after few seconds, the test is started automatically. select ok. 7. follow a test guide. measure the blood pressure in your ble health device to send the data to the paired phone. the sending time or method can be different for the health device model. select ok after sending the measured data to the phone. 8. this test guide is shown after finishing the test. 9. a test result is shown. 10. select the top-right more menu and save to file for the test result. the saved file’s location is in android/data/shealth.devicesdk. restart helps a re-test without scanning and pairing steps.