Wiki Spaces


Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack


Page tree
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 9 Next »


Reference Application is a state of the art implementation of OpenMRS, which may serve as a solid base for new implementations. It is designed using the latest UI 2.x and App Framework, which make it easy to add new functionality as small apps in a similar fashion to mobile applications. The Reference Application comes with a number of apps out of the box. Currently we provide apps, which enable you to:

  • register patients
  • start and end visits
  • list patients with active visits
  • admit/transfer/discharge patients
  • take clinical notes
  • capture patient vitals
  • display patient summary and visit history.

Try It Out!

Demo (nightly, unreleased current state)

You can always explore the latest version of the Reference Application by going to and signing in with the following credentials:


Each user has access to different parts of the application and we encourage you to explore them all.

Note that the application is actively developed and any changes are pushed live to the server so it may be unavailable at times. If it is unresponsive or you see errors, please try again in 10-15 minutes.


Please leave your comments in the box on the right as you explore the application at

Standalone (stable, released)

If you want to explore the latest released version of the Reference Application you can download it as a standalone, which is a complete package with an embedded Tomcat and MySQL database. When you first start a standalone, you can pick one of 2 install options.

  • the starter implementation mode is a configured and ready to use Reference Application without any patients in it
  • the demo mode includes randomly generated patients 

You can get the standalone version from our download page.

Legacy OpenMRS vs. Reference Application

The Reference Application is built on top of the legacy OpenMRS 1.9.5. You can still download and use the legacy application. See the download page. We will continue to provide support and release new versions of the legacy OpenMRS.

The Reference Application is a set of modules that are installed on the legacy OpenMRS. It means that when you install the Reference Application, you can still access all the features of the legacy application, however we keep them hidden from users by default.


As mentioned previously the Reference Application is built of small apps. There is a couple of apps provided out of the box and we expect to improve them and increase their number overtime. The apps that come with the Reference Application focus on basic functionality. They are designed and developed in a way that satisfies as many use cases as possible and also can be adjusted to specific needs. In this paragraph we will describe features that come with the Reference Application and their configuration options.

Location based login

When you first open up the Reference Application you will see a login screen.

You can login as a system developer with full privileges by giving the default username admin and password Admin123. You also need to select Location for this session. Locations are configurable from Advanced Administration - Manage locations. In order for a location to appear on a login screen you need to open it up and select a checkbox next to the Login location tag.

You should change the system developer password by going to Advanced Administration - Manage Users. Search for admin, pick it in results, change the password and hit Save.

Role based home page

You can see all apps that are available in your installation by logging in as a system developer and opening the home page.

Less privileged users do not see all apps, because they are hidden if they don't have privileges to use them. We have defined a set of application and organizational roles, which you can use, modify or create new as needed. Organizational roles inherit from application roles. Roles start from "Application:" or "Organizational:", e.g. "Application: Writes Clinical Notes" or "Organizational: Doctor". You can view all roles by singing in as an administrator and going to Advanced Administration and Manage roles.

If you open a role you can see which privileges it has. In the Reference Application we assign API level privileges to all roles automatically and limit access by assigning UI level privileges. You can easily distinguish the two, because UI level privileges start from "Task:" or "App:". Task privileges relate to specific features available in apps, whereas App privileges limit access to whole apps.

If you have a starter implementation you must create users from Advanced Administration - Manage Users and assign them organizational roles. In demo data we have created 3 users for you: doctor, nurse and clerk.


The registration app is available under the Register a patient button from the home page. It is seen by users having the "Application: Registers patients" role. 

The registration form supports keyboard navigation. You can go to a next field by hitting the TAB or ENTER key. Going backwards is possible with SHIFT + TAB. You can also jump between sections like Name, Gender, etc. using the UP and DOWN arrows.

All fields are being validated and you cannot advance if you do not provide a correct input.

The registration app has an auto-complete feature for given and family names. It displays suggestions based on a selected algorithm. It also searches for similar patients based on the information you entered so that you can review them and avoid creating duplicates. As soon as a duplicate is found you will see a bar at the top that there are similar patients found and you can click the Review patient(s) button to see them.

If you want to change or add more fields to the form, you can go to Advanced Administration - Settings - Layout and edit Address Template.

Patient search

You can use the Find Patient Record app to display recently viewed patients or find any patient in a database by name or ID.

If the search field is empty, you see a listing of recently viewed patients. As soon as you start typing and enter at least 2 characters, you will see results changing live for what you entered.

Patient Summary

Once you open up a patient you see a clinical summary.

The header has basic demographic details, which you can edit by clicking the Edit button. There's also Show Contact Info, which expands a section with contact details when clicked. If a patient has an active visit you can see a green bar in the header saying when it started and also patient's current location.

Right below the header you can see boxes DIAGNOSIS, VITALS and VISITS. To the right you can find General Actions and Current Visits Actions if a patient has an active visit.


Currently you can see there a list of diagnoses entered as visit notes from 3 years back with the most recent at the top. You can configure the period by going to Advanced Administration - Settings - Coreapps and enter Recent Diagnosis Period in Days.

A diagnosis that was entered as free-text is displayed in quotes. Each kind of diagnosis is displayed only once. See also Visit Notes.


The box shows the last captured vitals. See also Capture Vitals.


The box lists previous visits. It says if it was an outpatient or inpatient visit. You can click each visit to open up Visit details.


On the right you can find a box with actions. General actions are:

  • Start Visit - start a visit if there is no active visit yet
  • Add Past Visit - enter a retrospective visit
  • Merge Visits - merge past visits

Current visit actions are displayed if there is an active visit and they include:

  • End visit - end a visit
  • Visit Note - enter a visit note
  • Admit to Inpatient / Exit from Inpatient - change a type of visit
  • Transfer to Ward/Service - transfer to a defined location (displayed only when in an inpatient visit)
  • Capture vitals - enter patient's vitals

Some actions may not be visible based on privileges of the currently logged in user.

Patient Visits Summary

It is accessible from the Visits box on Patient Summary. You can either open up a specific visit or click Show more info to display the latest visit.


  • No labels