Featured add: 2.6
This page provides documentation of widgets that can be added to the patient dashboard. To add or modify go to System administration → Manage apps.
If you want to override the behavior of existing one, make sure to use the exact appId of the existing one in all places ( app ID input and json config)
If you want to create a new one based on one of the following examples, make sure you use a different appID in all places
| Table of Contents | ||
|---|---|---|
|
...
| key | required | default | values | description | minimum version |
|---|---|---|---|---|---|
| concepts | required | Comma delimited list of Concept numeric id, uuid, or mapping | * Provides the concepts whose most recent obs or group observations are returned are returned. * 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 | ||
| conceptNameType | optional |
| Specifes the preferred format for displaying both the concept and any value-coded concepts. The values correspond to "FULLY_SPECIFIED", "SHORT", and locale_preferred = true, respectively. | ||
| maxAge | optional | 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 | ||
| obsGroupLabels | optional | none |
| May be used when obs grouping concept uuid(s) are used in the concept key. | |
| nLatestObs | optional | 1 | Numeric integer | Specifies the number of latest non voided observations for a/each concept specified in the concepts key. |
...
| key | required | default | description | minimum version |
|---|---|---|---|---|
| dateFormat | optional | yyyy-MM-dd | Date format to use when displaying dates | |
| supportedPrograms | optional | null | 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. | |
| enableProgramDashboards | optional | false | 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" | |
| dashboardPage | optional | /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), | |
| maxRecords | optional | 20 | Max number of patient program enrollments to display |
...
| key | required | default | description | minimum version |
|---|---|---|---|---|
| displayActivationDate | optional | false | Specifies whether to display date of medication dispensation. | |
| detailsUrl | optional | null | URL to redirect the user to the user to a drug orders management page. NB. {{patientUuid}} in the url is replaced by the patient's uuid. To use the Order Entry OWA for drug order management, the url in the example below can be used to access the app. The Order Entry OWA can be installed as detailed in the installation guide. | |
| returnUrl | optional | /openmrs/coreapps/clinicianfacing/patient.page?patientId={{patientUuid}} | Specifies the return url when leaving the order entry ui. NB. {{patientUuid}} in the url is replaced by the patient's uuid. |
...
- obsgroup table
- Similar to the obsaccrossencounters but for obsgroups. Should allow for multiple obs within an obsgroup.
- Use case: A list of medications dispensed with encounter date, medication name, and frequency
- Graphs
- Graphs with log scale
- Use case: Viral load scale could vary from non-detectable to 10,000. It would be helpful to graph.
- Multiple variable graphs
- Use case: Graph 2 or more variables (concepts) on the same graph. Use for weight and height.
- BMI graph
- Use case: Based on weight and height, graph weight and calculated BMI on a single graph.
- Graphs with log scale