CarePass Sync by Aetna

CarePass Sync API is a RESTful service; end-points and operations are accessible via secure HTTP. OAuth 2.0 is used for authenticating partner apps and performing user-based authorization for data sharing. All service operations use JSON message format for data interchange.

CarePass Sync API is organized into logical collections of end-points called “profiles”. When apps connect to CarePass they must specify the desired OAuth SCOPEs (as a comma-separated list), which align with the defined profiles. The Identity profile, which provides demographic and contact information about the user, is granted by default. With the exception of the Identity profile, which supports only read (GET) access, all CarePass profiles support full bi-directional data sharing via POST (create), GET (read), PUT (update) and DELETE operations.

When requesting a CarePass Sync API key, developers must specify the profiles and operations to which they desire access. The profiles and operations which your application can access will be limited based on the authorization settings granted. The OAuth SCOPEs requested at run-time should match the CarePass profiles for which your application has been grated access. If your application requests access to profiles SCOPEs not previously approved, an OAuth user (bearer) token will be issued, but will be limited to the authorized profiles.

CarePass Sync provides a number of APIs that a developer can interface with, namely:

Requirements & Restrictions

  • API Rate Limits: 5000 request per day
  • Oauth Token TTL : 365 days
  • Brand Attribution Requirements: yes
    You agree to follow use of the CarePass Sync brand in accordance with the published CarePass User Experience Branding Guide.
  • Display and Usage Requirements: yes

    You agree to implement the CarePass Sync technology according to the User Experience Guidelines.

    If you import data from a user’s CarePass Sync personal health cloud, you agree to contribute data back to such user's health cloud. You do not need to write data back to the same profiles from which you consume.

    Please re-review the Developer API Agreement (sections 4 and 5.c), for data usage provisions.

  • Additional Display and Usage Restrictions: yes

    Your company and application will be reviewed to determine appropriate scope of access. Scope is defined as the profiles from a user's CarePass Sync personal health cloud which you will be permitted to request permission from the user to access. You will only be provided with the scope required to provide the user with the appropriate experience. Aetna reserves all rights to determine the scope that will be provided to your application if your request is approved.

  • Required Disclaimers: no
  • Additional Terms of Use Agreement: no

CarePass Profiles

The CarePass Sync API bundle allows you to interface with the following CarePass profiles:

Profile

Description

Documentation
Appointments

Manage health-related appointments for the user

/docs/read/carepass/appointments
Body Measurement Report or obtain information related to the user's body measurements /docs/carepass/bodymeasurements_basic
Body Measurement (Restricted) Report or obtain additional information related to the user's body measurements /docs/carepass/bodymeasurements_restricted
Conditions Report or obtain information related to the user's conditions /docs/read/carepass/conditions

Fitness

Report or obtain user's fitness activity and workout data

/docs/carepass/fitness

Identity

Obtain identity, demographic, and contact information about the authenticated CarePass user

/docs/carepass/biography
Insurance Obtain or maintain information about the user's insurance plan /docs/read/carepass/Insurance
Lab Result Report or obtain information related to the user's Lab Result tests /docs/read/carepass/labresult

Lifestyle

Find out about a CarePass user's hobbies, interests, and likes

/docs/carepass/lifestyle

Medications

Find out about a CarePass user's medications, medication activities and adherence reports

/docs/carepass/medications

Mood

Find out about a CarePass user's mood reports

/docs/carepass/mood
Nutrition Report or obtain information related to the user's nutritional intake /docs/read/carepass/nutrition
Sleep Report or obtain information related to the user's sleep episodes /docs/read/carepass/sleep

Docs Navigation