Skip to main content

Definitions

Definitions

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

Actors​

Rookeries Development (RookDev)​

RookDev manages the creation, management, and ongoing maintenance of the ROOK platform, ensuring its continuous evolution and reliability.

ROOK​

ROOK aggregates health data from diverse sources and standardizes, harmonizes, cleanses, and normalizes this data before making it available to client applications. It also provides a health score derived from processed data and manages user authorizations for data access, delivering key health insights that empower clients to enhance their applications.

Clients​

Clients include businesses and developers who integrate the ROOK platform into their applications to utilize health data functionalities. These applications leverage ROOK to collect, process, and analyze health data, enhancing user experience.

Users​

Users include individuals employing client applications where ROOK is integrated, connecting health data from various devices and wearables. This integration enables comprehensive health data aggregation and analysis.

Health Data Sources​

Health Data Providers​

Health Data Providers include companies that manufacture wearables or develop applications to collect health metrics, such as Polar, Oura, Garmin, Withings, and Whoop. These providers collect health information which, with user consent, is shared with ROOK for integration into client applications.

Health Data Collectors​

Health Data Collectors include platforms that compile and structure health data from various providers, maintaining standards for data quality and integrity. Examples include Google Fit, Health Connect, Apple Health, and Strava.

Products​

ROOK Connect​

"ROOK Connect" facilitates the collection of users' health data from multiple sources. Learn more at ROOKConnect Get Started.

ROOK Score​

"ROOK Score" is a health score calculated from users' health data. Learn more at ROOKScore Quickstart.

RookMotion​

RookMotion is designed for clients developing fitness apps that use heart rate sensors. For more information, please contact us.

Health Aspects​

Definition of Health​

We define "health" as a state of complete well-being across four fundamental pillars: physical, body, sleep, and mental/social health.

Health Metrics​

"Health Metrics" are quantifiable indicators of a user's health, such as step count or heart rate.

Health Data Pillars​

"Health Data Pillars" consist of the four pillars in our health definition: physical, sleep, body, and mental/social health.

Physical Health Data Pillar​

The "Physical Health Data Pillar" includes all health data related to categories such as daily activities, exercise sessions, or user movement throughout the day.

Body Health Data Pillar​

The "Body Health Data Pillar" contains all health data associated with categories like body size, physiological variables, and nutrition.

Sleep Health Data Pillar​

The "Sleep Health Data Pillar" encompasses all health data related to sleep, recovery, or rest.

Data Types​

Health Data​

Health Data encompasses the full range of data derived from user health metrics, capturing a wide array of physiological and activity-based information.

Unstructured Data​

Unstructured Data is the raw health data collected directly from wearable devices or health applications, maintained in the format provided by the Health Data Providers without undergoing any modifications.

Structured Data​

Structured Data is the result of refining unstructured health data through processes such as harmonization, standardization, cleansing, and normalization, making it ready for analytical applications.

Harmonized Data​

Harmonized Data involves aligning disparate health data to a uniform format and unit system, ensuring consistency across different data points. Example: Converting distances from miles to kilometers across all data sources to ensure uniform measurement.

Standardized Data​

Standardized Data refers to the process of making health data interoperable among various Health Data Providers, addressing compatibility issues to maintain data integrity. Example: Adjusting heart rate data to a consistent format, such as rounding decimals to whole numbers for integration.

Clean Data​

Clean Data emerges from identifying and resolving discrepancies within health data sets, such as duplicates from multiple devices or providers, to present a single, reliable data set to clients. Example: Reconciling step counts from two data sources for a definitive count.

Normalized Data​

Normalized Data involves adjusting health data to common standards, facilitating comparison and integration by establishing consistent scales and measurement ranges. Example: Aligning sleep quality ratings from different scales to a single standard scale for direct comparison.

ROOK Components​

ROOK Components consist of essential tools and technologies that enable efficient health data management and application integration.

API​

The ROOK API offers endpoints for accessing health data and user information, simplifying integration within client applications.

WebHook​

WebHooks provide real-time data updates, keeping applications aligned with the latest health information.

Connections Page​

The Connections Page illustrates a dashboard for user authorization management, serving as a development tool and example for client applications.

SDK​

Our SDK facilitate direct access to health data from sources such as Apple Health and Health Connect, streamlining integration with ROOK servers.

Environments​

We offer distinct environments for different development stages. Each environment possesses its unique resources, such as servers, databases, and domains. These environments include:

  • Production Environment: This is the final stage where the product is released. The resources used in this environment are optimized for stability, scalability, and security.
  • Sandbox Environment: This environment is used to test new features before releasing them to production.

Domains​

The corresponding domains for each environment are:

Variables​

client_uuid​

A unique identifier in UUID4 format assigned to each client by ROOK. This identifier is provided when a service agreement is signed and an account is created with ROOK. The client_uuid is consistent across all environments and essential for client identification within the ROOK ecosystem.

secret_key​

A confidential alphanumeric string provided to clients upon account setup, the secret_key is crucial for secure API access. It enables basic authentication, ensuring that only authorized users can access specified endpoints.

user_id​

A unique identifier for each user within your system, the user_id is highly flexible and can accommodate various formats such as numerals, emails, UUID4, or other internal identifiers, with a few constraints:

  • The length must be between 1 and 50 characters.
  • Accepted characters are alphanumeric (A-Z, a-z, 0-9) and hyphens (-) for exclusive use in UUIDs and emails.
  • In the case of using emails as user_id, the following will be accepted:
    • The user name (part before the @ symbol) can contain letters (upper and lower case), numbers and the following special characters: . _ % + -.
    • After the @ symbol, there can be letters (upper and lower case), numbers and hyphens (-).
    • After a dot (.) in the domain, there can be letters (upper and lower case), between 2 and 7 characters long.
caution

For entities subject to regulations like HIPAA or GDPR, using personally identifiable information (PII) such as emails or names for user_id is discouraged. Anonymizing identifiers through hashing or other methods is recommended to protect user privacy and comply with legal requirements.

api_url​

The api_url is composed of "api" + the environment domain. For

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

Units​

ROOK uses UCUM metric units, ensuring precision and compatibility with the International System of Units (SI), but also includes non-SI units that are common in medicine and science. For more information, please consult the following link.