Reference Application 2.8.1
This page is outdated and no longer receives updates!
Overview
Reference Application 2.8.1 is a release of our new Reference Application, 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 3.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.
Capture allergies
Enter forms from the patient dashboard
Patient request/scheduling appointment
Patient's condition list
Dispense medication
Attach patient note
Try It Out!
Hosted Demo Server
You can explore the latest released version of the Reference Application by going to demo.openmrs.org and signing in with the following credentials:
username: | doctor | nurse | clerk | sysadmin |
---|---|---|---|---|
password: | Doctor123 | Nurse123 | Clerk123 | Sysadmin123 |
Each user has access to different parts of the application and we encourage you to explore them all.
Note that this server is reset every 24 hours, so if it is unresponsive or the entire site seems down, please try again in 10-15 minutes.
Standalone
You can download a standalone version of this release from http://openmrs.org/download. The first time you run this you have the option of setting up demo data or not.
Enterprise
You can run the OpenMRS Platform with the Reference Application modules on top of it. These are two separate downloads at http://openmrs.org/download ("Platform", and "Modules & Data").
Demo patients
If you want to see demo data on top of an Enterprise installation, go to Advanced Settings and set "referencedemodata.createDemoPatientsOnNextStartup" to the number of demo patients you want to create, then restart your servlet container. (Creating demo patients is a bit slow, so we recommend creating <50 the first time you try this.)
Legacy OpenMRS vs. Reference Application
The Reference Application is built on top of the OpenMRS Platform 2.x, which still includes the Legacy User Interface (the original web application). You can still download and use the legacy application. See the download page. (for legacy UI module)
The Reference Application is a set of modules that are installed in addition to the legacy OpenMRS web application. 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.
Required Initial Configuration
For all features of the reference application to work well, you will need to make the configurations below:
To register a patient, the logged in user needs to have an associated provider account, meaning no patient registration will be possible if there is no user that has a provider account and yes this includes super user. Go to System Administration - Manage Accounts - Add New Account to add a new user and provider. Remember to create both a user account (with appropriate privileges) and a provider account.
Advanced Configuration
You can find more info about configuring the reference application here.
Features
As mentioned previously the Reference Application is built of small apps. There are a couple of apps provided out of the box and we expect to improve them and increase their number over time. 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. (For more details see here.) 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 System Administration - 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 signing in as an administrator and going to System Administration - 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 System Administration - Advanced Administration - Manage Users and assign them organizational roles. In demo data we have created 3 users for you: doctor, nurse and clerk.
When you create users, you need to create providers as well, otherwise they will not be able to enter data. Go to System Administration - Advanced Administration - Manage Providers and bind a new provider with a previously created user.
Multilingual
The Reference Application is partially translated into several languages. (To see how to contribute translations, or just see the current status, see Translating the Reference Application.)
Each user account has a "default locale" that is applied when they log in. The administrator can set this when creating a user account, or a user can change it on their own from My Account (under their username in the header):
...then by choosing Default Settings and setting the Default Locale:
The next time the user logs in, they will see the UI in the newly-selected language.
Registration
The registration app is available under the Register a patient button from the home page. It is seen by users having the "Applicatio