| Warningnote |
|---|
This is a copy of RefApp 2.5 documentation and needs to be reviewed/updated prior to the RefApp 2.6 release (when this notice can be removed) |
page is outdated and no longer receives updates! |
| Table of Contents |
|---|
Overview
Reference Application 2.6.0 is the latest 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
...
Try It Out!
Hosted Demo Server
| Anchor | ||||
|---|---|---|---|---|
|
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.
...
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.
...
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 with "Task:" or "App:". Task privileges relate to specific features available in apps, whereas App privileges limit access to whole apps.
...
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:
...
If you want to integrate the Address Hierarchy Module or add custom person attributes, you can find directions for Registration App Configuration.
If you want to integrate Registration with a Master Patient Index (MPI) you can find directions for /wiki/spaces/~approce/pages/16875546.
If you want to add/remove address fields or change the address field labels that appear on the form, you can go to System Administration - Advanced Administration - Manage Address Template. For more information see Administering Address Templates.
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 the number of characters set as the value of the Min Search Characters global property on the settings page, you will see results changing live for what you entered. Note that when searching by patient identifier you need to enter the full patient identifier because partial searches only work when searching by patient name.
...
Patient Summary
Once you open up a patient you see a clinical summary.
...
A diagnosis that was entered as free-text is displayed in quotes. Each kind of diagnosis is displayed only once. See also Visit Notes.
Vitals
The box shows the last captured vitals. See also Capture Vitals.
...
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
Chart Search - search for patient chart
Any forms which are marked as showing up under General Action section
Schedule a New Appointment
Request Appointment
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
Note: Some actions may not be visible based on privileges of the currently logged in user.
Note: You can now add custom forms in the actions section. See Manage Forms to add your own action items.
...
In Reference Application 2.6.0 we introduced a number of new customizable widgets. Please see this page for more information.
Patient Visits
...
You can see it has the same patient header as Patient Summary. Right below on the left you can see a list of visits with date and diagnoses captured during a particular visit. The most recent visit is displayed at the top. You can click at any visit to see its details on the right. It has Visit Actions buttons if a visit is active and a list of encounters, which you can view by clicking show details. It is possible to edit them with the pencil icon or delete with the x icon.
Only encounters that are specifically configured as "editable" can be edited. This is how it's done for the built-in reference application forms. There is currently not a way to edit your own forms. In order to edit an encounter, you either need to have the privilege "Task: emr.patient.encounter.edit", or else have participated in the encounter.
...
When you click to "Add New Allergy", it allows you to select the allergy type; drug, food or environmental. You can click the allergen, and then specify the reaction it causes and the severity. You can also add a comment if you like. After you click save,
...
Visit Notes
The form for entering visit notes is accessible from Patient Summary and Patient Visits. It is listed under Current Visits Actions.
...
First you enter a primary diagnosis by starting to type in the Add presumed or confirmed diagnosis field. It has an auto-suggest feature which finds diagnosis concepts, but also has the Non-coded selection with the value you entered. You need to pick from the auto-suggest list to add the diagnosis, which then appears on the right under Primary Diagnosis. If you repeat these steps, your selections will appear under Secondary Diagnoses.
...
A patient can be admitted, discharged or transferred from Patient Summary or Patient Visits under Current Visit Actions.
...
Locations can be configured from System Administration - Advanced Administration - Manage Locations. You need to have a location marked with the Visit location tag, which has children marked with the Admission location or Transfer location tags.
For an example look at the setup in the demo data. See Demo.
Configure Metadata
Click on the Configure Metadata app on the main apps screen. If you want to add, edit, retire/restore or delete metadata in the new UI, this is where you go.
...
When you click on any of the links in blue above, you should be able to view page that lists the respective metadata, the action column on the right has these icons , click the pencil icon to edit, the 'x' icon to retire and the trash icon to delete items forever. When you retire an item, the 'x' icon gets replaced with 'restore' icon which when clicked should un retire the item. To add a new piece of metadata, click on the add button at the top of the listing page, e.g 'Add New Encounter Type' in case of encounter types.
...
Under the Configure Metadata screen, there is now a new app to "Manage Forms". It is possible to add custom forms to the new user interface without any custom programming! When you initially enter Manage Forms, it shows you a list of forms that exist in the system. Obviously, before you can configure where a custom form will appear in the system, you must create the form. Both HTML and XForms are supported, but they must be created through the legacy user interface, under System Administration - Advanced Administration.
...
After you've created your custom form that you want to add to the new user interface / patient dashboard, you can click "Add" in the UI column next to the form name, as seen in the screenshot above. Clicking "Add" opens up the configuration screen for that form.
...
There is a rich user interface for configuring metadata i.e add, create, retire/void, restore and delete metadata, as seen above you can also configure where and how your form will appear. Let's discuss these settings individually.
...
Show If - Do you want to display the form only if the patient has certain characteristics? Perhaps you would only want a maternal health form to be visible on the patient dashboard of a female patient. You would use something like "patient.person.gender=='F' && patient.person.birthdate < '2001-01-01T00:00:00.000+0000' && patient.person.dead==false". Or show if males with an active visit "visit.active && patient.person.gender=='M' ". Or show if the patient has a current visit and they are currently admitted, "visit.active && visit.admitted". For more information on what properties are available, see the Conditionally displaying Apps and Extensions page.
If you are replacing a built-in form, with a new custom form, you can view the configuration of the integrated forms in the source code.
...
Under the System Administration App, you will find system administration tools. This currently includes the Style Guide, especially useful to programmers, It also includes Advanced Administration which returns you from the new user interface to the legacy user interface. This is useful for configuring legacy settings and modules that don't yet have a user interface in the new UI; like Reporting and Facility Data Module for example. You can also manage global properties and user accounts by selecting the appropriate app from the page shown in the screenshot below, you can navigate to this page by selecting Home -> System Administration.
...
Manage Apps
This allows implementers to add or remove applications to/from the system without having to build a module. This is done by configuring a JSON definition. For more information see System Administration: Manage Apps.
Viewing And Managing Accounts
In the reference applications, user and provider accounts are linked to a person record and are managed from the same page. From the home page navigate to the account listing page by clicking System Administration -> Manage Accounts as seen in the screenshot above to view all the accounts.
...
To add a new account, from the account listing page, click on the 'Add New Account' button, fill the form and save.
To Edit an existing account, from the account listing page click the pencil icon beside the account you wish to edit.
To edit the person details, under person details section click on the pencil icon on the right, make changes and save or press cancel if you don't wish to save the changes.
To add a new user account, under user details section click on the last tab with the '+' sign, make changes and save or press cancel if you don't wish to save the changes. It now includes support for user capabilities.
To edit an existing user account, under user details section click on the associated pencil icon on the right hand side of the tab content pane for that user account, make changes and save or press cancel if you don't wish to save the changes.
To add a new provider account, under provider details section click on the last tab with the '+' sign, make changes and save or press cancel if you don't wish to save the changes.
To edit an existing provider account, under provider details section click on the associated pencil icon on the right hand side of the tab content pane for that provider account, make changes and save or press cancel if you don't wish to save the changes.
Note: Retiring and deleting user and provider accounts is not supported as of 2.3 but should be in future releases.
...
From the home page navigate to the account listing page by clicking System Administration -> Manage Settings (formerly Global Properties from 1.8 downwards) as seen in the screenshot above to view all the Settings (formerly Global Properties from 1.8 downwards).
...
Click on the 'Add New Setting (formerly Global Property from 1.8 downwards)' button to add a new Setting (formerly Global Property from 1.8 downwards).
The action column on the right has these icons
, click the pencil icon to edit and the trash icon to delete a setting (formerly global property from platform 1.8 downwards).
Note: Some Setting (formerly Global Property from 1.8 downwards) values are truncated to fit in the allocated space, clicking the pencil icon should take you to the edit screen from where you can see the entire value. On the listing page, hovering over the name cell should display the description also.
...
New to the OpenMRS 2.1 user interface is the OpenMRS Atlas configuration. When the implementation is first established, you must link ownership with an OpenMRS ID. Click “Sign in with your OpenMRS ID” and provide your OpenMRS ID and password. If your browser is already logged in to OpenMRS ID, it will use that account automatically when you click "Sign in".
...