Interested is participating in the Google Summer of Code program? Please see the GSOC wiki page.

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

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
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 


  • No labels