ResearchKit /ResearchKit

ResearchKit is an open source software framework that makes it easy to create apps for medical research or for other research projects.

★ 5,757⑂ 1,174👁 282⑃ 774● 838▤ 18
Objective-CNOASSERTIONCreated 2015-03-10www.researchandcare.org
Download: ResearchKit 3.2.03.2.0-stable ↓3.2.0-stable2025-09-19
+1
Daily
5,757
stars
1,174
forks
282
watchers
774
prs
838
issues
18
releases

README

!ResearchKit

ResearchKit Framework
===========

!VCS !Platform 

The ResearchKit™ framework is an open source software framework that makes it easy to create apps
for medical research or for other research projects.

 Table of Contents

 Requirements
 Documentation
 Getting Started
	 Installing
	 ORKCatalog App
 Surveys
 Consent
 Active Tasks
 Getting Help
 License

 Requirements 

The ResearchKit framework codebase supports iOS and requires Xcode 16.0 or newer. The ResearchKit framework has a Base SDK version of 17.0.

 Documentation 



View the ResearchKit framework documentation by setting ResearchKit as your target in Xcode and selecting 'Build Documentation' in the Product menu dropdown.


 Getting Started 

 Website


 Install as an embedded framework 

Download the project source code and drag in ResearchKit.xcodeproj. Then, embed ResearchKit framework in your app by adding it to the "Frameworks, Libraries, and Embedded Content" section for your target as shown in the figure below.



 ORKCatalog App 

The included catalog app demonstrates the different modules that are available in ResearchKit. Find the
project in ResearchKit's samples directory.

|   |   |
|---|---|
| !catalog-home | !catalog-survey |

 Surveys 

The ResearchKit framework provides a pre-built user interface for surveys, which can be presented
modally on an iPhone or iPad. The example below shows the process to present a height question for a participant to answer.

swift
import ResearchKit
import ResearchKitUI
    
let sectionHeaderFormItem = ORKFormItem(sectionTitle: "Your question here.")

let heightQuestionFormItem = ORKFormItem(identifier: "heightQuestionFormItem1", text: nil, answerFormat: ORKAnswerFormat.heightAnswerFormat())
heightQuestionFormItem.placeholder = "Tap here"

let formStep = ORKFormStep(identifier: "HeightQuestionIdentifier", title: "Height", text: "Local system")
formStep.formItems = [sectionHeaderFormItem, heightQuestionFormItem]

return formStep


The height question is presented in the figure below.

|   |   |
|---|---|
| !height-question | !height-question-2 |

 Consent 

The ResearchKit framework provides classes that you can customize to explain the
details of your research study and obtain a signature if needed. Use ResearchKit's provided classes to quickly welcome, and inform your participants of what the study entails.

swift
import ResearchKit
import ResearchKitUI

// Welcome page.
let welcomeStep = ORKInstructionStep(identifier: String(describing: Identifier.consentWelcomeInstructionStep))
welcomeStep.iconImage = UIImage(systemName: "hand.wave")
welcomeStep.title = "Welcome!"
welcomeStep.detailText = "Thank you for joining our study. Tap Next to learn more before signing up."
        
// Before You Join page.
let beforeYouJoinStep = ORKInstructionStep(identifier: String(describing: Identifier.informedConsentInstructionStep))
beforeYouJoinStep.iconImage = UIImage(systemName: "doc.text.magnifyingglass")
beforeYouJoinStep.title = "Before Yo

Top issues

Latest release

ResearchKit 3.2.0 3.2.0-stable 2025-09-19
ResearchKit 3.2.0 Release Notes
 API Changes
- ORKRecorderConfiguration
Deprecated recorder(for:outputDirectory:) method in favor of setting the outputDirectory property when initializing ORKConfiguration, then calling its new recorder(for:) method. 

 General bug fixes
- ORKRecorder
	- Fixed issue where results for active tasks using ORKRecorder did not account for all recorded files.
	- Added file rolling as an API-level setting for ORKRecorder configuration.
	- Added timestampSince1970 for logged CMLogItems for better usability.

- Active Tasks
	- Amsler Grid
		- Fixed issue wh

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON