Skip to main content

Iframe

Compatible with

Apple iOSAndroidMicrosoft
ChromeSafariFirefoxFirefoxEdge

This section is the integration manual for embedding the Legit.Health iframe into native iOS apps, progressive web apps, Wordpress sites and any other host that can render an <iframe>.

Please note

The iframe interface this documentation refers to is not part of the medical device Legit.Health Plus. The medical device is comprised of the algorithms accessed via HTTP API. The iframe is one of the ways in which organisations may interact with the device. For details about the medical device, please visit the Instructions For Use.

What is iframe?​

Iframe integration means embedding a small, pre-designed interface inside your application. That interface lets users upload images and view outputs from the Legit.Health medical device.

Because <iframe> is a universal HTML element, the embedding mechanics are the same as anywhere else on the web. See MDN's <iframe> reference for details.

The iframe is designed for simplicity and ease of implementation. It is a great option when you want to integrate quickly without complex development, and when you do not need to transfer identifying user data such as patient names or email addresses.

No login required​

The iframe is embedded inside your application, where users are already authenticated. As a result, the iframe does not ask for credentials and does not store any user data.

The trade-off is that the iframe cannot track users across sessions. If a user uploads an image and later logs out, the system cannot link the image back to that user.

Limitations​

Because the iframe does not retain information about the user, it cannot compare two reports taken at different points in time for the same patient.

Integration time estimate​

Based on the experience accumulated across past customer integrations, the iframe can be deployed end-to-end in well under a working week:

  • Configure the iframe (personalisation) and embed it into your product: about 15 minutes.
  • Save or forward the JSON response to your EHR / backend database: under 1 day.
  • Configure your clinical decision workflow on top of the report data: under 1 week.
Dedicated support throughout the integration

Our integrations team is available throughout the whole process, from picking URL parameters to wiring the backend call. If you get stuck, open a support request (see the Support page).

Where to go next​

  • Get the iframe running end-to-end: see the Quickstart page.
  • Customize the iframe and look up every URL parameter: see the Configure → Customize page.
  • Generate a short-lived company key: see the Configure → Security page.
  • Wire up postMessage listeners: see the Callbacks page.
  • Embed on a specific platform: see the Platforms section.
  • Compare output formats: see the Output page.
  • Pull a report from the API: see the Output → API Endpoint page.
  • Inspect the callback payloads: see the Output → JSON Schema page.
  • See iframe-specific use cases: see the Use Cases page.