Skip to main content
Version: 1.0.0

Definitions

This section provides a comprehensive explanation of key terms and concepts frequently used in our documentation and product.

Participants​

Rookeries Development​

Rookeries Development, also known as RookDev, is the legal entity that owns and operates the ROOK product.

Client​

A "Client" refers to the organization that integrates the ROOK product or the entity developing an application utilizing ROOK technology.

User​

A "User" is an individual who leverages the services offered by the client. This person, essentially the "client's customer," connects their health data to the app through the ROOK solution.

Offerings​

ROOK​

"ROOK" in this documentation represents our comprehensive solution, including APIs, SDKs, and Webhooks. It empowers wellness, health, and fitness applications to interface with their users' health data. ROOK serves as a Health Data Collector and a data processing/insights platform that integrates into your application to simplify access and utilization of your users' health data.

ROOK Connect​

"ROOK Connect" is the product responsible for collecting users' health data from multiple data sources. Learn more at ROOK Connect Quickstart.

ROOK Score​

"ROOK Score" is the product that generates a score based on the users' health pillars. Learn more at ROOK Connect Quickstart.

RookMotion​

RookDev also provides RookMotion, a specialized offering for clients intending to develop a fitness app that utilizes heart rate sensors for training. If you require additional information about this product, please contact us. Shortly, ROOK's capabilities will be expanded to encompass training functionalities.

Data Sources​

Health Data Sources​

"Health Data Sources" encompass both Health Data Providers and Health Data Collectors. ROOK gathers health data from these sources, processes it, and makes it readily accessible for consumption, regardless of the source type.

Health Data Provider​

A "Health Data Provider" is typically the manufacturer of sensors and wearables, such as Polar and Garmin, or other applications that collect users' health data through their devices or apps. Through our connections page, the user can permit us to access their data, which we then deliver to our client (embedded in their app) in a standardized, normalized, and unified manner. A user can connect multiple providers to ROOK.

Health Data Collectors​

"Health Data Collectors" are products and providers that aggregate health data from Health Data Providers in a centralized manner. Often referred to as "Health Kits" or "Health Data Hubs," providers and products in this category include Apple Health, Health Connect, Samsung Health, Huawei Health, Xiaomi Health, and Huami.

Health Aspects​

Definition of Health​

We perceive "health" as a state of wholeness embodied by a balance across four fundamental pillars: physical, body, sleep, and mental/social health.

Health Metrics​

"Health Metrics" pertain to any quantifiable indicators related to a user's health or wellness, such as step count or heart rate.

Health Data Pillars​

"Health Data Pillars" refer to the four pillars encompassed in our definition of health: 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" includes all data collected from a user's health metrics.

Unstructured Data​

"Unstructured Data" refers to health data stored in its original form as received from Health Data Providers, without any processing by our technology. This data is generated by the user's wearable device, while ROOK gathers this data from the Health Data Provider.

Structured Data​

"Structured Data" denotes health data that has undergone harmonization, standardization, cleaning, and normalization through our technology. ROOK collects and processes the user's health data, facilitating its meaningful use.

Harmonized Data​

"Harmonized Data" presents health data in a consistent format with universal units.

Standardized Data​

"Standardized Data" ensures that health data is compatible across different Health Data Providers.

Clean Data​

"Clean Data" provides clients with the most accurate single data set when duplicate data sets are discovered. This could occur if a user has multiple wearable devices or Health Data Providers connected or if the user connects both a Health Data Provider (like Garmin, Polar, Fitbit, etc.) and a Health Data Collector (like Apple Health, Health Connect, etc.).

Normalized Data​

"Normalized Data" represents health data that has undergone transformation to establish unified scales and ranges.

ROOK Components​

"Components" refer to the various technologies deployed in ROOK to offer the functionalities mentioned earlier. These components form part of the comprehensive technology solution that ROOK provides.

API​

An "API," or Application Programming Interface, consists of a set of endpoints used to query health data or execute actions like generating tokens from ROOK.

WebHook​

A "WebHook" is a notification system where ROOK alerts the client about newly available health data from users.

Connections Page​

The "Connections Page" is a webpage that you can integrate into your app where users can locate a list of available Health Data Providers and Health Data Collectors to connect with. It is also where they authorize us to access the health data of their chosen provider.

Variables​

client_uuid​

A unique identifier for each client, in UUID4 format. This UUID is generated by ROOK and provided to clients upon signing service agreements. Please reach out to us to create an account. The client_uuid remains consistent across every environment.

client_secret​

The client secret is a confidential string instrumental in authorizing access to API endpoints through basic authentication. ROOK assigns it to clients during account creation.

user_id​

This is a unique identifier for your users. It is a flexible string that accepts numerals, emails, UUID4, names*, or whatever identifier you use internally for your users.

  • Length ranges from 1 to 50 characters
  • Valid characters are:
    • Alphanumeric ("Aa-Zz", "0-9").
    • Emails ("Aa-Zz", "0-9"), ("@" & "."), At least 2 characters for domain ending, e.g., ".co".
    • UUIDs ("Aa-Zz", "0-9") + ("-").
caution

If you are a HIPAA covered entity, please refrain from using names or emails as user_id. It is recommended to hash them or any Protected Health Information (PHI).

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.
  • Development Environment:

This is where the majority of the development work happens. It is used for testing new features.

domains​

The corresponding domains for each environment are:

api_url​

The api_url is composed of "api" + the environment domain. For instance, the api_url for the production environment would be api.rook-connect.com.