FibriCheck Developer Documentation
  • 👋FibriCheck Developer Documentation
  • 👩‍💻Developer Guide
  • 🔗App-to-app integration
  • Web Portal Integration
  • Cloud SDK
    • ▶️Introduction
  • 🔒Authentication
  • 👤Users & Registration
  • 📱Profile
  • 📄Prescriptions
  • 🫀Measurements
  • 📊Reports
  • 🪝Webhooks
  • 🔧Changelog
  • Camera SDK
    • ▶️Introduction
  • ⚡Events
  • ⚙️Properties
  • 🔧Changelog
  • Legal & Regulatory
    • Partner Portal Requirements
    • Instructions for Use
    • Terms of Use
  • External Links
    • GitHub
Powered by GitBook
On this page
  • High-level app-to-app sequence diagram
  • Redirect the user to the FibriCheck mobile application
  • Deep Link URL
  • Environments
  • Access measurement data in your application
  • Submit your application as a connected app in FibriCheck
  • Access the measurements using the REST API

App-to-app integration

PreviousDeveloper GuideNextWeb Portal Integration

Last updated 8 days ago

Next to integrating the FibriCheck technology into your application, it's also possible to implement an app-to-app integration. In this scenario, your users will use the FibriCheck application to perform measurements.

An app-to-app integration has two components:

  • The ability to redirect the user from your application to the FibriCheck mobile application

  • The ability to access and visualize the measurement results in your application

The following videos show how this works in practice:

Example 1: Clicking the deep link for the first time

When a user clicks the deeplink without the FibriCheck app installed, they will be directed to the app store to download it. After installation, the deeplink information will be transferred to the FibriCheck application, ensuring a convenient onboarding.

Example 2: Clicking the deep link after the first time, when installation has completed

Once the user has installed the FibriCheck mobile app and created an account, a deep link can instantly direct them from your application to the measurement feature within FibriCheck.

High-level app-to-app sequence diagram

The following sequence diagram shows an overview of the different steps involved in onboarding a (new) patient to FibriCheck through an app-2-app integration with a partner platform.

Redirect the user to the FibriCheck mobile application

Deep Link URL

A deep link URL with different query parameters is available which allows you to:

  • Provide user information to facilitate onboarding

  • Redirect the user to different parts of the FibriCheck application, e.g. directly to the measurement functionality of the mobile application

  • Provide activation information so that the user can immediately start measuring their heart rhythm

The following example shows combines all possibilities in one URL:

https://fibricheck.app.link?
	fc_hash={{prescription hash}}&
	fc_data_extra_{{partner_prefix}}_patient_id={{partner patient id}}&
	fc_data_extra_{{partner_prefix}}_{{other_param}}={{partner other parameters}}&
	fc_reg_first_name={{patient's first name}}&
	fc_reg_last_name{{patient's last name}}=&
	fc_reg_email={{patient's last name}}&
	fc_reg_language={{language}}&
	fc_reg_country={country}}&
	fc_reg_gender={{gender}}

More specific information on the different parameters are provided in the sections below.

Prefilled user registration

Deeplink URL:

https://fibricheck.app.link/?fc_reg_email=demo1%2B4%40fibricheck.com

This deeplink allows you to pre-fill information in the FibriCheck app to register a new user

  • fc_reg_first_name

  • fc_reg_last_name

  • fc_reg_email

  • fc_reg_language

  • fc_reg_country

  • fc_reg_gender

If some query parameter values are not provided, the user will be able to provide them in the registration form within the FibriCheck application.

The query parameters from the "activate a prescription" deeplink (fc_hash) can be added here as well. Then the user will be able to directly perform measurements after registering.

Show an overview of measurements to the user

Deeplink URL: https://fibricheck.app.link/?screen=measurements_overview

Show a specific measurement result to the user

Deeplink URL: https://fibricheck.app.link/?screen=measurement&measurementId=xxx

Start a measurement with instructions on how to measure

Deeplink URL: https://fibricheck.app.link/?screen=measurement_instructions

Start a measurement

Deeplink URL: https://fibricheck.app.link/?screen=start_measurement

Activate a prescription

Deeplink URL: https://fibricheck.app.link/?fc_hash={{hash}}

The provided prescription hash will be activated upon app launch, so the user can immediately start measuring.

Provide additional information

The following query parameters allow partners to store specific information related to the integration:

  • fc_data_extra_{{partner_prefix}}_patient_id={{partner patient id}} Should contain the unique identifier of the patient in the partner system. If you integrate using webhooks, this value will be provided in each webhook request that is performed to facilitate mapping users in FibriCheck with users in the partner system.

  • fc_data_extra_{{partner_prefix}}_{{other_param}}={{partner other parameters}} Can be used to store other relevant information linked to the patient in the patient's profile within FibriCheck.

The {{partner_prefix}} is a key that will be given to you to scope all information related to the integration.

Note that all query parameters for the deep links must be URL encoded.

The user has to click on the deep link to be redirected to the FibriCheck app.

The deep link functionality does not work when the link is copied in the address bar of a web browser.

Environments

If you're testing your integration, you'll be using the development environment, which has a different base URL.

Access measurement data in your application

When a user performs a measurement in the FibriCheck application, the measurements, analysis, and diagnosis are performed and stored in the FibriCheck cloud.

There are two ways to get the measurement data into your application.

Submit your application as a connected app in FibriCheck

Connected apps are applications that FibriCheck integrates with. For connected apps, FibriCheck will push the measurements and reports into the connected app.

To support this, your application needs to provide an API that FibriCheck can access using an OAuth2.0 authorization flow.

The user will have to take the following steps to connect your application:

  1. The user logs in to the FibriCheck application

  2. In the "Connected apps" screen, the user selects your application

  3. The user is redirected to your application's login screen

  4. After successful authentication, the user is redirected to FibriCheck

  5. FibriCheck receives access tokens that are used to push the measurement data into your application

Because the user signs in, there is a hard link between the user's account in your application and the user's FibriCheck account, thereby making sure that measurements are linked to the correct account.

Access the measurements using the REST API

The FibriCheck cloud offers a REST API and associated Cloud SDK to fetch measurements. You can use this API to fetch the measurements into your system.

When using this method, you have to be very careful that you match the measurements with the correct user.

To redirect the user from your application to FibriCheck, we provide . Deep links can be used in another app, on the web, in an email, or sms. When users click on the link or button, they are redirected to the FibriCheck app. Using this method, integrating FibriCheck in your application only requires adding a button in your app that contains the deep link.

If the user has not installed the FibriCheck app yet, the link will be a . The user is then first redirected to the App or Play Store to download the app. After the app is installed, the user will be redirected to the deep link as if the app was already installed.

The following query parameters map directly onto the :

Additionally, custom properties can be provided that will be stored in the custom_fields property of the using the dynamic query parameter fc_data_{fieldName}.

Non-US - Development App

United States - Development App

Non-US // Production App

US // Production App

This method requires help from the FibriCheck technical team to implement. Reach out to to discuss your specific use case.

See for more information.

🔗
deep links
deferred deep link
registration parameters
user's profile
integrations@fibricheck.com
🇪🇺
🇺🇸
🇪🇺
🇺🇸
https://fibricheck.test-app.link
https://fibricheck-us.test-app.link
https://fibricheck.app.link
https://fibricheck-us.app.link
this link