23andMe ResearchKit Module
Objective-C
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
TwentyThreeAndMe Handle new/existing flows differently Mar 21, 2016
README.md email address updates Mar 24, 2016

README.md

23andMe logo

23andMe ResearchKit Module

Bring genetic data to your ResearchKit-enabled research app with 23andMe.

Interested? Contact us at geneticsmodule@23andme.com

Introduction

Seamlessly incorporate genetic data collection into your ResearchKit-enabled app. With 23andMe's ResearchKit module you can use 23andMe as a source for collecting genetic data from both existing 23andMe customers as well as other individuals who you'd like to sign up for 23andMe.

23andMe's ResearchKit module makes it easy to either:

  • Request that an existing 23andMe customers agree to share their genetic data with your app
  • Have a non-23andMe customer create a 23andMe account and profile, and agree to share their genetic data with your app, when available.

Supported Configurations

23andMe Customer Types

  • Existing 23andMe customers only

    This configuration allows existing 23andMe customers to share their genotype data with your research study.

  • Existing and new 23andMe customers

    Note that this configuration requires that a researcher has a purchase agreement in place to sponsor the purchase of a 23andMe kit for participants the researcher has deemed eligible.

Contribution of Data

  • Contributing genetic data required
  • Contributing genetic data optional

Retreival of genetic data

The module is designed to make it simple for you to gain permission to access a 23andMe customer's genetic data. While it will provide you with the credentials necessary to access a customer's data, you will need to use the 23andMe API to retreive any genetic inforamtion. Unless you have a need for the information in your app, we recommend that you not download genomewide data directly to a participant's phone.

Getting Started

Requirements

  • ResearchKit 1.3.0 (has not been tested against other versions)
  • iOS Base SDK 8.0+

Contact 23andMe for development environment access

23andMe has created a development environment for researchers looking to include the 23andMe module in their app. Send an email to geneticsmodule@23andme.com for more information on accessing the development environment.

If your app will only accept data from existing 23andMe customers, then you may not need access to the development environment. You can create a development API account here.

Note that development accounts are limited to 20 users. You will need to request an API upgrade before you release your app.

Authenticating with the 23andMe API

Once a user has gone through the 23andMe module, the app will return an authorization code that you can exchange for auth & refresh tokens using the 23andMe API. See the documentation for additional details.

Retrieving genetic data via the API

  • See the genomes endpoint documentation for downloading genomewide data
  • See the genotypes endpoint documentation for retrieving data for selected SNPs

Integrating the 23andMe Module

1. Add the ResearchKit framework to your app

Follow the instructions posted at the ResearchKit repo.

2. Add the 23andMe module to your app's project

Clone the 23andMe module:

git clone https://github.com/23andMe/23andMeResearchKitModule.git

Copy the module inside your ResearchKit project. Copy the "TwentyThreeAndMe" into the ResearchKit project inside of XCode.

3. Update ResearchKit code

See the "OtherEdits.txt" file for a summary of the required modifications.

Researchkit.h Don't forget that when you add the following files to your project, they must have target membership set to "public"

#import <ResearchKit/ORKTwentyThreeAndMeDefines.h>
#import <ResearchKit/ORKTwentyThreeAndMeConnectTaskViewController.h>

Researchkit.private Don't forget that when you add the following files to your project, they must have target membership set to "private"

#import <ResearchKit/ORKOrderedTask+TwentyThreeAndMe.h>
#import <ResearchKit/ORKResult+TwentyThreeAndMe.h>

Researchkit.strings - English

/* 23andMe connect task. */
"TWENTYTHREEANDME_DECLINE_PROMPT_DETAILS" = "Are you sure you want to decline adding your genetic data to %@? Declining may impact your eligibility for this study";
"TWENTYTHREEANDME_DECLINE_PROMPT_ACTION_DECLINE" = "Decline";
"TWENTYTHREEANDME_DECLINE_PROMPT_ACTION_CANCEL" = "Cancel";

"TWENTYTHREEANDME_INTRO_MAIN_SHARE" = "Add Genetic Data";
"TWENTYTHREEANDME_INTRO_MAIN_DECLINE" = "Decline";

"TWENTYTHREEANDME_INTRO_1_DESCRIPTION" = "%@ has selected 23andMe to collect genetic data for the %@ study";

"TWENTYTHREEANDME_INTRO_2_TITLE" = "About this study";
"TWENTYTHREEANDME_INTRO_2_ABOUT_REQUIRED" = "Contributing your genetic data is required for participation in the %@ study. You will need to authorize 23andMe to share that data with %@";
"TWENTYTHREEANDME_INTRO_2_ABOUT_OPTIONAL" = "In order to contribute your genetic data to the %@ study, you will need to authorize 23andMe to share that data with %@";
"TWENTYTHREEANDME_INTRO_2_ELIGIBILITY_HEADER" = "Eligibility";
"TWENTYTHREEANDME_INTRO_2_ELIGIBILITY_EXISTING" = "• Existing 23andMe users";
"TWENTYTHREEANDME_INTRO_2_ELIGIBILITY_NEW" = "• Individuals who agree to receive the 23andMe Personal Genome Service at no cost";

"TWENTYTHREEANDME_INTRO_3_TITLE" = "About 23andMe";
"TWENTYTHREEANDME_INTRO_3_MISSION" = "23andMe is a genetic service available directly to U.S. customers that includes reports that meet FDA standards for being scientifically and clinically valid. 23andMe helps people understand what’s in their DNA. The 23andMe Personal Genome Service includes more than 60 personalized genetic health, trait and ancestry reports.";
"TWENTYTHREEANDME_INTRO_3_LEARN_MORE" = "Learn more about 23andMe";
"TWENTYTHREEANDME_INTRO_3_QUESTIONS" = "Questions?";
"TWENTYTHREEANDME_INTRO_3_CONTACT" = "Contact %@";

"TWENTYTHREEANDME_COMPLETE_TITLE" = "Congratulations";
"TWENTYTHREEANDME_COMPLETE_DONE_BUTTON" = "Done";
"TWENTYTHREEANDME_COMPLETE_EXISTING_DETAIL" = "Congratulations, you’ve successfully enrolled in %@. %@ is now authorized to access your genetic data.";
"TWENTYTHREEANDME_COMPLETE_NEW_DETAIL" = "Congratulations, you’ve successfully enrolled in %@. %@ is now authorized to access your genetic data.";
"TWENTYTHREEANDME_COMPLETE_NEW_NEXT_STEP" = "Next steps";
"TWENTYTHREEANDME_COMPLETE_NEW_NEXT_STEP_DETAIL" = "23andMe will mail you a saliva collection kit. Simply follow the instructions included with the kit, mail the sample back, and we will notify you when your reports are ready.";

"TWENTYTHREEANDME_FAILURE_TITLE" = "Try again";
"TWENTYTHREEANDME_FAILURE_DESCRIPTION" = "Sorry, we weren’t able to enroll you in the genetic component of %@. Please try again, or contact %@ if you have any questions.";
"TWENTYTHREEANDME_FAILURE_CONTACT" = "Contact %@";
"TWENTYTHREEANDME_FAILURE_TRY_AGAIN_BUTTON" = "Try again";
"TWENTYTHREEANDME_FAILURE_DECLINE_BUTTON" = "Decline";

4. Add image assets

The 23andMe module includes a series of assets used to incorporate 23andMe's look and feel. In order to include those in your app, create a "TwentyThreeAndMe" folder inside of the "Artwork.xcassets" item in your project's copy of ResearchKit. Then, copy the contents of the /Assets folder into the folder you've just created.

5. Present the 23andMe Connect Task

In the view controller where you want to present the connect to 23andMe task and receive a user's permission to access her data, include the ResearchKit libraries and set a delegate to receive the task's response:

#import <ResearchKit/ResearchKit.h>

@interface UIViewController () <ORKTwentyThreeAndMeConnectTaskViewControllerDelegate>

Create the 23andMe task's view controller with the following method:

ORKTwentyThreeAndMeConnectTaskViewController *ttamTaskVC =
[ORKTwentyThreeAndMeConnectTaskViewController twentyThreeAndMeTaskViewControllerWithIdentifier:@"connectWithTTAM"
   allowedUserMode:ORKTwentyThreeAndMeAllowedUserModeExistingAndNew
   studyDependency:ORKTwentyThreeAndMeStudyDependencyRequired
   authClientId:@"<client_id>"
   authClientSecret:@"<client_secret>"
   authScopes:@"basic genomes"
   investigatorDisplayName:@"name"
   studyDisplayName:@"study_name"
   studyContactEmail:@"my_email@email.com"
   baseURLOverride:nil];

Parameters:

allowedUserMode: Either ORKTwentyThreeAndMeAllowedUserModeExistingAndNew or ORKTwentyThreeAndMeAllowedUserModeExistingOnly.

studyDependency: Either ORKTwentyThreeAndMeStudyDependencyRequired or ORKTwentyThreeAndMeStudyDependencyOptional.

authClientId: 23andMe API OAuth client ID

authClientSecret: 23andMe API OAuth client secret

authScopes: Space-seperated list of scopes to request from the 23andMe API. See the list of scopes for details on what scopes to request.

investigatorDisplayName: User-facing investigator name.

studyDisplayName: User-facing study name.

studyContactEmail: User-facing contact email address.

baseURLOverride: Either nil or a URL to override the default 23andMe API URL. Use this override URL to access the sandbox environment. For access to the sandbox environment, contact us at geneticsmodule@23andme.com

Set the delegate and present the 23andMe view controller:

ttamTaskVC.twentyThreeAndMeConnectDelegate = self;

[self presentViewController:ttamTaskVC animated:NO completion:nil];

6. Implement the delegate method to receive a response

- (void)twentyThreeAndMeConnectTaskViewController:(ORKTwentyThreeAndMeConnectTaskViewController *)twentyThreeAndMeConnectTaskViewController
                          didFinishWithResults:(NSDictionary *)results
                                         error:(nullable NSError *)error

The results dictionary contains:

completionType: If the user successfully auth'd (and, for new 23andMe users, created an account) this will be set to success. Otherwise, this will be set to cancelled.

authToken: 23andMe Auth Token for the user's 23andMe profile. Only set if completionType == success.

refreshToken: 23andMe Refresh Token for the user's 23andMe profile. Only set if completionType == success.

On access and refresh tokens:

Access tokens expire after 1 day. If you need to access a user's data past that, you can request another token using the last refresh_token that you were issued. Using the refresh token means you don't have to send the user through the "Accept" screen all over again. Requesting a new token set will invalidate your old refresh_token. Be sure to specify the full scope when requesting a new access token.

7. Use the 23andMe API to retrieve user data

Once you've retrieved an access token, you can use the API to access the information that the user agreed to share with you as it is available. Access tokens retrieved via the 23andMe ResearchKit module are only valid for individual profiles, so be sure to keep track of the profile ID that's associated with the token.

Questions?

Questions about 23andMe, the 23andMe API, or interested in setting up a project with us? Contact us at geneticsmodule@23andme.com.

See something in our code or documentation? Create an issue on GitHub and we'll take a look.

License

The source in the 23andMeResearchKitModule repository is made available under the following license unless another license is explicitly identified:

Copyright (c) 2016, 23andMe, Inc. All rights reserved.

 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:

 1.  Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.

 2.  Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation and/or
 other materials provided with the distribution.

 3.  Neither the name of the copyright holder(s) nor the names of any contributors
 may be used to endorse or promote products derived from this software without
 specific prior written permission. No license is granted to the trademarks of
 the copyright holders even if such marks are included in this software.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.