react-native-apple-health-kit-with-records v2.0.65
React Native Apple Healthkit with Health Records
A React Native bridge module for interacting with Apple Healthkit's data and Health Records data.
Health Records version
Simply request permission of the corresponding Health Record data you need from the list:"Allergies", "ClinicalVitals", "Conditions", "Immunizations", "Labs", "Medications", "Procedures".
And call the associated function to retrieve the data:getAllergyRecords, getClinicalVitalRecords, getMedicationRecords, getConditionRecords, getImmunizationRecords, getProcedureRecords, getLabRecords
Each response returns an array of arrays for each entry.
Position 0 is the name of entry, position 1 is the FHIR object.
Installation
Install the react-native-apple-health-kit-records package from npm:
- Run
npm install react-native-apple-health-kit-records --save - Run
react-native link react-native-apple-health-kit-records
Update info.plist in your React Native project
<key>NSHealthShareUsageDescription</key>
<string>Read and understand health data.</string>
<key>NSHealthUpdateUsageDescription</key>
<string>Share workout data with other apps.</string>In XCode, turn on HealthKit and ensure Clinical Health Records is enabled under the capabilities tab. Clinical Health records access requires that your account has this feature enabled.
Manual Installation
- Run
npm install react-native-apple-health-kit-records --save - In XCode, in the project navigator, right click
Libraries➜Add Files to [your project's name] - Go to
node_modules➜react-native-apple-health-kit-recordsand addRCTAppleHealthkit.xcodeproj - In XCode, in the project navigator, select your project. Add
libRCTAppleHealthkit.ato your project'sBuild Phases➜Link Binary With Libraries - Click
RCTAppleHealthkit.xcodeprojin the project navigator and go theBuild Settingstab. Make sure 'All' is toggled on (instead of 'Basic'). In theSearch Pathssection, look forHeader Search Pathsand make sure it contains both$(SRCROOT)/../../react-native/Reactand$(SRCROOT)/../../../React- mark both asrecursive. - Enable Healthkit in your application's
Capabilities
- Compile and run
Get Started
Initialize Healthkit. This will show the Healthkit permissions prompt for any read/write permissions set in the required options object.
Due to Apple's privacy model if an app user has previously denied a specific permission then they can not be prompted again for that same permission. The app user would have to go into the Apple Health app and grant the permission to your react-native app under sources tab.
For any data that is read from Healthkit the status/error is the same for both. This privacy restriction results in having no knowledge of whether the permission was denied (make sure it's added to the permissions options object), or the data for the specific request was nil (ex. no steps recorded today).
If new read/write permissions are added to the options object then the app user will see the Healthkit permissions prompt with the new permissions to allow.
initHealthKit requires an options object with Healthkit permission settings
import AppleHealthKit from 'react-native-apple-health-kit-records';
const PERMS = AppleHealthKit.Constants.Permissions;
let options = {
permissions: {
read: ["Height", "Weight", "Allergies", "ClinicalVitals", "Conditions", "Immunizations", "Labs", "Medications", "Procedures", ],
}
};
AppleHealthKit.initHealthKit(options: Object, (err: string, results: Object) => {
if (err) {
console.log("error initializing Healthkit: ", err);
return;
}
// Height Example
AppleHealthKit.getDateOfBirth(null, (err, results) => {
console.log(results)
});
AppleHealthKit.getAllergyRecords(null, (err, allergies) => {
if (this._handleHealthkitError(err, 'allergies')) {
console.log('err', err)
return;
}
console.log(allergies[0])
}
});/* Output for Apple Health example patient with a peanut allergy */
[
displayName: "Peanuts",
FHIRResource:
{
"id": "2",
"resourceType": "AllergyIntolerance",
"substance": {
"text": "Peanuts",
"coding": [{
"system": "http://snomed.info/sct",
"code": "256349002"
}]
},
"recordedDate": "2015-02-18",
"patient": {
"display": "Candace Salinas",
"reference": "Patient/1"
},
"reaction": [{
"manifestation": [{
"text": "Wheezing"
}],
"severity": "severe"
}]
}
]References
- Apple Healthkit Documentation https://developer.apple.com/Healthkit/
Wiki
- Installation
- Documentation
- Permissions
- Units
- Base Methods
- Realtime Methods
- Read Methods
- getActiveEnergyBurned
- getBasalEnergyBurned
- getBiologicalSex
- getBloodGlucoseSamples
- getBloodPressureSamples
- getBodyTemperatureSamples
- getDailyDistanceCyclingSamples
- getDailyDistanceWalkingRunningSamples
- getDailyFlightsClimbedSamples
- getDailyStepCountSamples
- getDateOfBirth
- getDistanceCycling
- getDistanceSwimming
- getDistanceWalkingRunning
- getFlightsClimbed
- getHeartRateSamples
- getHeightSamples
- getLatestBmi
- getLatestBodyFatPercentage
- getBodyFatPercentageSamples
- getLatestHeight
- getLatestLeanBodyMass
- getLeanBodyMassSamples
- getLatestWeight
- getRespiratoryRateSamples
- getSleepSamples
- getStepCount
- getWeightSamples
- getSamples
- getMindfulSession
- Write Methods
- References
Supported Apple Permissions
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago