Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Current »

❗️Warning, Old Version of the Validic API

This is the legacy version of the Validic API. As of 01/01/2019, developers have only been issued credentials to our new Inform Platform. If you're a new Validic customer, please review the Inform API Documentation.

Validic Legacy API Overview

The Validic API is designed to enable a simple, standardized connection between healthcare companies and mobile health and wellness apps and devices. Validic captures a user’s fitness activities and health measurements over time. Each activity and measurement contain a timestamp and a note about which integration was used to track the activity.

The Validic REST API uses token-based authentication to manage and automate the creation of user accounts. All communication with the API is performed through HTTPS, and errors are communicated through HTTP response codes. All requests return JSON data.

A core aspect of the Validic API is to vastly increase the speed of integration between mHealth app developers and healthcare businesses. Additionally, Validic provides critical enterprise features needed by healthcare companies that are not usually provided as a core service by app developers. These features include:

HIPAA/Safe Harbor/PHI Compliance

Validic eliminates concerns regarding the transfer of protected health information (PHI), as all data stored in and transferred through Validic follows the “Safe Harbor” de-identification standard and complies with all HIPAA regulations.

Standardized Endpoints

App developers and healthcare companies rarely speak the same language. The Validic REST API translates information to something both sides can understand.

Easy connectivity

The Validic health app marketplace allows for a simple, one-to-many connection for healthcare businesses and app developers alike. If your company wishes to connect with 200+ mHealth apps and devices, Validic makes it simple. Get started below, and if you have any questions, contact us.​

Key Terms

Knowing is half the battle.

Before we begin, let's review some terms you'll encounter in the following documentation. Understanding these terms and their definitions will help you understand how Validic works.

Organization

An "Organization" is a collection of Validic users. An Organization typically represents a company that delivers the Validic marketplace through its web portal or mobile application.

Organization ID (Org ID, Organization_ID)

An "Organization ID" is used to identify your organization when making requests through the API. Your organization credentials are issued during the Validic implementation process. If you do not have an Organization ID, please contact our support team at support@validic.com.

Organization Access Token

The "Organization Access Token" is the secure token used in conjunction with your Organization ID. Your Organization Access Token is issued during the Validic implementation process. If you do not have this token, please contact our support team at support@validic.com.

User ID (User_ID)

The "User ID" is generated by Validic and used to represent a user of your system in our system. To ensure HIPPA compliance, Validic exchanges your unique User ID for a Validic User ID. The Validic User ID is then used to request data from Validic for a specific user.

User Access Token

This token part of an ID exchange mechanism that allows your users' data to remain de-identified, safe and secure. The "User Access Token" is used to tie the application marketplace to your unique users. This token is specific to a user and should not be confused with the Organization Access Token.

Marketplace

The "Marketplace", or "Application Marketplace", helps you connect with your users and obtain their permission to use their data. You'll guide users to this marketplace, they'll select their device and be led through the process of granting access to their data.

Expanded Data

Our conventional request only returns standardized data, which we call standard data. Standard data fields and data types should not change without prior notice.

In addition to our standard data payload, you can expand your request to include all available fields. To do this, you'll use the expanded filter with a value of "1" (true). By default,​ expanded is set to "0" (false).

For example, the Lumo API returns "time_in_bad_posture" and "time_in_good_posture" as part of its response. These metrics are not returned by Validic by default. To access them, you would specify the following parameters in the request:

Expanded Filter with Source

GET https://api.validic.com/v1/organizations/{ORGANIZATION_ID}/users/{USER_ID}/fitness.json?access_token={ORGANIZATION_ACCESS_TOKEN}&start_date=2015-09-01T00:00:00+00:00&end_date=2015-09-30T23:59:59+00:00&source=lumo&expanded=1

If you do not specify a source, we will return expanded data for every device.

Expanded Filter Without Source

GET https://api.validic.com/v1/organizations/{ORGANIZATION_ID}/users/{USER_ID}/fitness.json?access_token={ORGANIZATION_ACCESS_TOKEN}&start_date=2015-09-01T00:00:00+00:00&end_date=2015-09-30T23:59:59+00:00&expanded=1

Expanded data returns non-standardized data and we cannot guarantee this data will not change.

  • No labels