Skip to main content

Definitions

This section clarifies important terms and concepts used in ROOK’s documentation and products, facilitating a better understanding of the language associated with ROOK.

Actors​

Rookeries Development Corp (RookDev)​

RookDev is the company behind the ROOK platform. It is responsible for the design, development, and continuous improvement of ROOK, ensuring its innovation, scalability, and reliability across all its products.

ROOK​

ROOK is a suite of tools that includes APIs, SDKs, apps, and a portal to aggregate, standardize, and deliver health data. It provides a Health Score and manages user authorizations, enabling seamless integration of secure, high-quality health data into client systems.

Clients​

Clients refer to enterprises or developers integrating the ROOK platform to enhance their applications with health data. Common use cases include fitness apps, research platforms, and healthcare tools.

Users​

Users are individuals who interact with client applications integrated with ROOK. They consent to connect their health data from various devices or apps, enabling comprehensive health data aggregation and analysis.

Health Data Sources​

Health Data Providers​

Health Data Providers are companies that manufacture wearables or develop applications to collect health metrics, such as Polar, Oura, Garmin, Withings, and Whoop. With user consent, data is shared with ROOK and subsequently used by client applications.

Health Data Collectors​

Health Data Collectors are platforms that aggregate and structure health data from various providers while ensuring data quality and integrity. Examples include Google Fit, Health Connect, Apple Health, Samsung Health, and Strava.

ROOK Products​

ROOK Connect​

ROOK Connect facilitates seamless health data collection from multiple sources. It simplifies user authentication and consent, ensuring data synchronization across fitness, sleep, and body metrics.
Learn more about ROOK Connect.

ROOK Portal​

The ROOK Portal provides a centralized interface for managing the ROOK API. Developers can configure wearable device connections, manage API keys, and analyze user activity.

ROOK Score​

ROOK Score provides a comprehensive and quantifiable assessment of user health by analyzing key metrics like physical activity, sleep, and body data.
Learn more about ROOK Score.

ROOK Extraction App​

The ROOK Extraction App is a pre-built, neutrally branded mobile application enabling clients to collect health data from SDK-based sources like Apple Health and Health Connect. Users link via a QR code, eliminating the need for custom app development.
Learn more about the Extraction App.

Health Aspects​

Health Metrics​

Health Metrics are quantifiable indicators of user health, such as step count, calories, glucose levels, and heart rate.

Health Data Pillars​

ROOK organizes data into three pillars for holistic insights:

  • Physical Health: Includes metrics on daily activities, exercise, and movement.
  • Body Health: Captures data on body size, physiological variables, and nutrition.
  • Sleep Health: Provides insights into sleep quality, recovery, and rest.

Events​

Events represent updates in user health data captured over specific time windows, such as daily steps or heart rate measurements.

Summaries​

Summaries are daily collections of user health data organized for easy analysis. Types include Physical, Sleep, and Body Summaries.

Data Types​

Health Data​

Health Data refers to comprehensive information derived from user health metrics, covering physiological and activity-based information.

Unstructured Data​

Unstructured Data consists of raw data collected directly from wearable devices or health applications, unprocessed by ROOK.

Structured Data​

Structured Data is refined health data, processed through harmonization, standardization, cleansing, and normalization for analytics.

Harmonized Data​

Harmonized Data is aligned to consistent units and formats.
Example: Converting distances from miles to kilometers.

Standardized Data​

Standardized Data is adjusted for compatibility across providers.
Example: Formatting heart rate data uniformly.

Clean Data​

Clean Data is free from duplicates or inconsistencies, ensuring accuracy.
Example: Reconciling step counts from multiple sources.

Normalized Data​

Normalized Data is adjusted to consistent scales or measurement ranges for comparability.
Example: Aligning sleep quality ratings across providers.

ROOK Components​

ROOK Webhook​

ROOK Webhook is a real-time mechanism that delivers updates about new user health data, including summaries, events, and health scores, directly to a specified URL. Webhooks eliminate the need for continuous polling, ensuring faster and more efficient data delivery.
Learn more about ROOK Webhooks.

ROOK API​

The ROOK API enables polling for updates and retrieving health data on demand. While this method is flexible, webhooks are the preferred option for greater efficiency and speed.
Learn more about the ROOK API.

ROOK Connections Page​

The ROOK Connections Page is a ready-to-use demo webpage designed for clients to quickly test user connections with data sources. It features ROOK's default format and is intended for testing purposes only, not for production use.
Learn more about the Connections Page.

ROOK SDKs​

ROOK SDKs are available for Android, iOS, Flutter, React Native, and Capacitor, facilitating seamless extraction of data from platforms like Apple Health and Health Connect for client applications.
Learn more about ROOK SDKs.

Environments​

ROOK supports distinct environments for Sandbox and Production:

  • Production: Provides stable and secure resources for live applications.
  • Sandbox: Serves as a testing environment for new features.

Variables​

client_uuid​

A unique identifier in UUID4 format assigned to each client by ROOK for consistent identification across all environments.

secret_key​

A confidential key enabling secure API access. It is essential for API authentication.

user_id​

A unique identifier for users within a client system. It can support numerals, UUID4, emails, or custom formats.

Constraints:

  • Length: 1–50 characters.
  • Characters: Alphanumeric (A-Z, a-z, 0-9) with hyphens (-) for UUIDs and email domains.
  • Email rules:
    • Before @: Letters, numbers, . _ % + -.
    • After @: Letters, numbers, hyphens (-).
    • Domain: Ends with 2–7 letters (e.g., .com, .health).

Examples:

  • Valid: 12345, a8b92c13-d24e-4f56-9a79-b18f2d9a2e33, user.name+alias@email.com, custom-identifier123.
  • Invalid: 123456789012345678901234567890123456789012345678901 (too long), user@invalid_domain (invalid domain).
caution

Avoid using PII like emails in regulated contexts (e.g., HIPAA, GDPR). Use anonymized identifiers instead.

api_url​

Constructed as api + environment domain:

  • Production: api.rook-connect.com
  • Sandbox: api.rook-connect.review.

Units​

ROOK uses UCUM metric units for consistency and precision, supporting both SI and non-SI units common in medicine.
Learn more about UCUM units.