Designer Onboarding to OpenMRS
Welcome to the OpenMRS design world! Contents in this page:
Quick Design Links
For some context:
See "A Visual History of OpenMRS" to better understand our design history.
OpenMRS 3 (aka 3.0, or 3.x) is a large project that:
Substantially modernized OpenMRS' frontend technology;
redesigned our UX/UI by leveraging Carbon Design; and,
brought together many organizations to use both this technology and the shared design framework to share the burden of work and benefit from collaborative processes.
Design Documentation
The latest version of the OpenMRS EMR (O3) uses Carbon Design System as our foundation. But Carbon Design doesn’t cover all our use cases (e.g. how to display medications), nor our specific branding and layout guidelines. So: We have 2 main OpenMRS-specific design documentation/asset hubs for you to know about, our Design Pattern Docs and our Styleguide.
2. Styleguide & Components
Explore the OpenMRS 3 Styleguide and Component Library.
Note: This requires logging in to the OpenMRS Zeplin project. You can use this shared login: username: openmrszeplinreview@gmail.com password: zeplinreview123
If you need more detailed access (e.g. to see notes for developers), you can request your own account with the OpenMRS Zeplin project. Contact: community@openmrs.org
Suggested Self-Onboarding Steps
First: Explore the EMR Demo
Play with the Reference Application! Go to https://o3.openmrs.org u: admin p: Admin123
Tips: Play with the sample patient chart for Agnes Testerson. Try following the steps taken in some of the OpenMRS 3.x demo videos (don't forget to look at patterns like what is used in Patient Lists and Offline Mode)
Then: Review OpenMRS' key design conventions and assets
Design Patterns:
Read http://om.rs/o3ui . Familiarize yourself with some of the existing features so you can see examples of existing micro-workflows that have already been User Tested and are being / have already been built into the community EMR.
OpenMRS Styleguide:
Find the OpenMRS styleguide in Zeplin. It's important designers are familiar with this so you can see the existing OMRS Carbon Component inventory, and to be aware of where we have intentionally created custom components.
How to Log in to Zeplin:
To log in to the OpenMRS Zeplin project, you can use this shared login: username: openmrszeplinreview@gmail.com password: zeplinreview123
If you need more detailed access (e.g. to see notes for developers), you can request your own account with the OpenMRS Zeplin project. Contact: community@openmrs.org
Carbon:
OpenMRS' design foundation is Carbon Design System. If you're not already familiar with Carbon Design, check out their helpful Carbon Onboarding for Designers. You'll find things like the Carbon Design Kit, grid system, and guidance on how to use them.
Design Tech Stack Summary:
Design Documentation: Zeroheight (at http://om.rs/o3ui )
Design Handover and Styleguide: Zeplin
Designing: Figma and/or Claude Design
Note: although we recommend Figma, you are welcome to use the tools you are most comfortable with or have to access to, so long as you can access the patterns in Zeplin.
Clickable Mockups: Protopie (but probably anything you're used to can work)
Asynchronous Feedback: Loom Videos have been helpful (free Chrome extension here)
Explore Design Videos
Check out the videos below to get a rapid intro to the what, where, and how of OpenMRS v3 design. (Note: yes, these are a bit old at this point as they are from ~2022, but their foundational points remain valid.)
3.x Reference Application Demos:
Introduction to 3.x Design Patterns and Carbon Design
Example: Applying UX Research & Carbon Design with 3.x
Past O3 UX Research
Wondering how we did UX Research to establish some of the patterns in O3? See our existing research, process, and findings at UX Research Questions We've Worked Through.
How to Communicate & Connect
Online
On Slack: #ux-design-advisory and #openmrs3
On OpenMRS Talk (Talk is the OpenMRS community forum)
Support:
#openmrs3-helpme slack channel
General questions or problems with Carbon Design: Carbon Issue and Question hub
Weekly O3 Squad Call (all-hands)
What: Our weekly 3.x initiative all-hands. Everyone shares their updates, and a short design showcase is shared to keep everyone current on the latest design thinking and user feedback.
Timing and call link information at https://om.rs/cal
Sample Designs*
Note: to see detailed CSS guidance at the Detailed links, you require an invite to our OpenMRS Zeplin project. Just let us know if you require an invite. In the meantime you can review all designs with this account:
u: openmrszeplinreview@gmail.com
p: zeplinreview123