Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

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

Documentation

Skip to end of metadata
Go to start of metadata

Featured add: 2.6

This page provides documentation of widgets that can be added to the patient dashboard 

Section Configuration Parameters

The following parameters are required for each section

keyrequireddescription
titlerequiredThe title of the section
provideroptional A valid moduleId
fragmentIdoptionalA valid fragment 
iconoptionalThe icon displayed for the heading
orderoptionalHow does this work elsewhere
extensionIdrequiredThe extension where the widget is displayed (How does one configure the section to appear in multiple extension points)

Latest Obs For Concept List 

Shows a list of concepts and the latest observations for each 

Configuration Parameters

keyrequireddefaultvaluesdescription
conceptsrequired Comma delimited list of Concept numeric id, uuid, or mapping* Provides the concepts whose most recent obs are returned.
* Minimum of 1 and a maximum of 10 concepts.
* If the concept has no value it is returned with no value
* Text showing how recent the obs is, today, yesterday, n days/months/years ago in smaller italic text whose title is the actual obs date
maxAgeoptional Numeric integer with a suffix for example:
*1d – 1 day
*2w – 2 weeks
*4m – 4 months from the current date
The maximum age of most recent obs for each of the items in the concept list
Example Latest Obs For Concept List widget app configuration

Image Sample 

Obs Across Encounters 

Shows concepts across multiple encounters based on date. When a concept has no value in an encounter then the value is left blank

Configuration Parameters

keyrequireddefaultdescription
conceptsrequired Comma delimited list of Concept numeric id, uuid, or mapping of the concepts whose observations are to be shown
maxRecordsrequired4The maximum number of encounters to be shown
maxAgeoptional 

The maximum age of most recent obs for each of the items in the concept list

Numeric integer with a suffix for example:
*1d – 1 day
*2w – 2 weeks
*4m – 4 months from the current date 

Example Obs Across Encounters widget app configuration

Image Sample 

Obs Graph 

Shows a graph of obs values for a concept with numeric values 

Configuration Parameters

keyrequireddefaultdescription
conceptIdrequired The concept whose values are to be graphed. Only concepts with a numeric data type are to be graphed
maxResultsrequired4The maximum number of observations to be graphed
maxAgeoptional 

The maximum age of most recent obs for each of the items in the concept list

Numeric integer with a suffix for example:
*1d – 1 day
*2w – 2 weeks
*4m – 4 months from the current date 

Example Obs Graph widget app configuration

Image Sample 

Data Integrity Violations 

Shows the data integrity module violations for a patient

Configuration Parameters

keyrequireddefaultdescription
maxResultsrequired6The maximum number of violations to be displayed. A link to fix the violation is only available if the action_url column has a value 
Example Data Integrity widget app configuration

Image Sample 

Relationships 

Shows the relationships for a patient 

Configuration Parameters

keyrequireddefaultdescription
maxResultsrequired6The maximum number of violations to be displayed. A link to fix the violation is only available if the action_url column has a value
baseAppPathoptional/coreappsProvides the ability to embed the relationships widget in a different module and page than the default coreapps clinician facing dashboard
dashboardPageoptional/coreapps/clinicianfacing/patient.page?patientId=patientUuidIndicates to which page to navigate when clicking on a relative
providerPage
optionalnullIf configured, it indicates the page to navigate if the relationship points to a provider
includeRelationshipTypesoptional Comma delimited list of relationship type UUIDs. It provides the ability to filter which relationship types should be allowed to be created. By default all relationship types are displayed
editPrivilegeoptional Indicates the privilege required to edit patient relationships. If you want to edit relationships via the widget you need to assign "Task: coreapps.editRelationships" privilege to the logged on user.
Example Relationships widget app configuration

Image Sample 

Recent Visit by Encounter Type 

Shows the recent visits for a patient by encounter type

Configuration Parameters

keyrequireddefaultdescription
maxResultsrequired6The maximum number of recent visits to show
maxAgeoptional 

The maximum age of most recent obs for each of the items in the concept list

Numeric integer with a suffix for example:
*1d – 1 day
*2w – 2 weeks
*4m – 4 months from the current date 

combineEncounterTypesoptionaltrueWhen true shows a comma delimited value of encounter types that occur on the same visit, when false shows each encounter type on its own row for the same visit.

What are the thoughts on this?  
Example Visits By Encounter Type widget app configuration

Image Sample 

Programs List

Shows the programs the patient is currently enrolled in, as well as historical programs.  Serves as an access point into programs-specific dashboards.

Configuration Parameters

keyrequireddefaultdescription
dateFormatoptional
yyyy-MM-dd
Date format to use when displaying dates
supportedProgramsoptionalnull

A comma-separated list of program uuids (ie. uuid of a program in OpenMRS Program table). If specified, will only display patient enrollments in the selected programs.

If left empty (default) will list all patient program enrollments, regardless of program.

enableProgramDashboardsoptionalfalse

If enabled: 1) adds a hyperlink to each patient program enrollment that links to the URL specified by "dashboardPage", and 2) displays a dropdown listing all programs that the patient is not currently enrolled in (limited by supportedPrograms if specified); selecting a program from the list also redirects the user to the page specified by "dashboardPage"

dashboardPageoptional
/coreapps/clinicianfacing/patient.page?
patientId={{patientUuid}}&dashboard={{dashboard}}

Link to follow when a user clicks on a program hyperlink or selected a program to enroll a patient in. "PatientUuid" will be replaced with the uuid, and the "dashboard" will be substituted with the uuid of the selected program, enabling use of Program-Specific dashboards (see Context-Specific Dashboards),

maxRecordsoptional20Max number of patient program enrollments to display

Privileges

privilege

description

Task: enrollInProgram
Determines whether or not to render dropdown (see example below) allowing users to navigate to a program-specific dashboard to enroll in a program if not enrolled.

 

 

Example Visits By Encounter Type widget app configuration

Image Sample 

Example of patient enrolled in two programs:

Example of dropdown box to navigate to program-specific dashboard to enroll a patient in a program:

Program Status

Shows the specifies of the current patient program enrollment: date enrolled, enrollment location, date completed, and outcome.  Allows editing of these four data points, and the deletion of the patient program (assuming the user has the appropriate privilege). If the patient is not currently enrolled in the program, provides the ability to enroll in the program.  

An updated version of this widget (likely to be released in Coreapps 1.16.0) provided the ability to set and edit workflow state transitions.

This widget is also used by the Program History widget to allow viewing and editing of completed programs.

Configuration Parameters

keyrequireddefaultdescription
programrequired
 
Program UUID (ie. uuid of a program in OpenMRS Program table)
dateFormatoptional
yyyy-MM-dd
Date format to use when displaying dates
locationTagoptionalnull

UUID of a location tag. If specified, the options in the "program enrollment location" drop-down will be limited to locations with tag.

Privileges

PrivilegeDescription
Task: enrollInProgram
Whether the user has the ability to enroll a patient in a program
Task: editPatientProgramWhether the user has the ability to edit an existing patient program
Task: deletePatientProgramWhether the user has the ability to delete an existing patient program

 

 

Example Visits By Encounter Type widget app configuration

Image Samples 

Prior to enrollment:

After enrollment:

 Editing enrollment:

Program History

Given a program, shows all of a patient's enrollments in that program by rendering a Program Status widget (see above) for each program, ordered from most recent to oldest.

Configuration Parameters

keyrequireddefaultdescription
programrequired
 
Program UUID (ie. uuid of a program in OpenMRS Program table)
dateFormatoptional
yyyy-MM-dd
Date format to use when displaying dates
locationTagoptionalnull

UUID of a location tag. If specified, the options in the "program enrollment location" drop-down will be limited to locations with tag.

includeActiveoptionaltrueIf set to false, excludes the active program enrollment (if any) from the list

 

 

Example Visits By Encounter Type widget app configuration

Image Sample 

 

 

 

 

 


 

  • No labels