Skip to content

Opal Documentation

We have just gone open source! 🎉

This site is currently under construction while we add more details and information to support our open source community. New information will be added regularly. Please check back for updates. To report an issue with this site, please create an issue on our issue tracker.

This is the technical documentation for Opal – the open source patient-in-the-loop data platform. We've grouped together information on using, contributing, and deploying Opal.

Opal is an award-winning open source patient-in-the-loop data platform, connecting patients, clinicians, industry partners and researchers. Opal provides real-time access for patients to their medical data, through a host of features, such as appointments, lab results, clinical notes, personalized educational and reference materials, questionnaires, connection to smart devices, on-site appointment check-in and call-in, e-consent, data donation, etc. To learn more about Opal, visit us at https://www.opalmedapps.com/.

Structure of the Documentation

To explore the documentation on this site, use the tabs at the top of this page. Each tab has a sidebar on the left listing its sub-pages. The following is a high-level overview of each section:

  1. User Guide (coming soon): instructions on navigating and configuring the Opal system as an end-user or administrator.
  2. Contribute: everything you need to know as a developer to contribute to Opal's open-source development:
  3. Install (coming soon): how to deploy the Opal system in an environment

Try it Yourself

If you'd like to get a feel for the experience of using Opal as a patient, try it yourself by logging into a test account in our demo hospitals.

  1. Download the Opal - Patient in the loop app from the Google Play Store or Apple App Store.
  2. Launch the app, and log in with a test account1. Under the password field, you'll be prompted to choose a hospital: Select Opal Demo 1.
  3. Take a look around the app, and feel free to try out all the features (including answering questionnaires, checking into appointments, etc.).

Info

Due to the app's security settings, each account only allows one concurrent login. If another user logs into the account you're using, you'll be logged out with the message "You have logged in on another device". The number of available test accounts will be adjusted according to demand; to report an issue, please contact us at ___.

  1. We will add test account credentials to this page soon. If you are eager to try it out in the meantime, please reach out to us. ↩