Patient Summary Widget Documentation

title

required

The title of the section

provider

optional

 A valid moduleId

fragmentId

optional

A valid fragment 

icon

optional

The icon displayed for the heading

order

optional

How does this work elsewhere

extensionId

required

The extension where the widget is displayed (How does one configure the section to appear in multiple extension points)

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

• FSN

• shortName

• preferred

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

• FSN

• shortName

• none

May be used when obs grouping concept uuid(s) are used in the concept key.
Specifies the format in which to display obs group member prefixes, FSN, shortName, none. The prefixes to display refer to either Fully Specified Name, Short Name,  of the underlying member concept or No prefix respectively.

nLatestObs

optional

1

Numeric integer

Specifies the number of latest non voided observations for a/each concept specified in the concepts key.

concepts

required

Comma delimited list of Concept uuids whose observations are to be shown

maxRecords

optional

4

The maximum number of encounters to be shown

maxAge

optional

no limit

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 

^{encounterType}

optional

no filter

Filters encounters by encounter type, specified by its UUID.

^{encounterTypes}

optional

no filter

Introduced with Coreapps v1.29.0. Comma delimited list of encounter type UUIDs. Filters Observations of the same concept from multiple encounters. 

^{showEncounterTypeName}

optional

false

Introduced with Coreapps v1.29.0. Can be used with/without 'encounterTypes' parameter/key. Specifies whether to display name of Encounter/Encounter-type (the name could be a message property for i18n) for which observations belong on an entry/row.

^{useConceptShortName}

optional

false

If set to true, the widget would display the concept SHORT name for the coded obs. By default, the obs.value.display is displayed

^{useConceptNameForDrugValues}

optional

false

If set to true, the widget will display the concept name for drug values, rather than the drug name.

^headers

optional

null

A list of custom column headers. e.g. 

^{"zl.date,mirebalais.vitals.short.heartRate.title,mirebalais.vitals.short.temperature.title"}

showDateWithTime

optional

false

If set to true, the widget would display the date with the time component.

datetimeFormat

optional

null

Specify a format for the datetime, if not specified it will use the Global Property with datetime format.

showEncounterProviderName

optional

false

If set to true, the widget would display the provider or providers of the encounter.

conceptId

required

Comma delimited string of concepts UUIDs whose values are to be graphed. Only concepts with a numeric data type are to be graphed

maxResults

required

4

The maximum number of observations to be graphed

maxAge

optional

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 

encounterTypes

optional

Comma delimited string of Encounter Type UUIDs. Only the observations from the given list of encounter types will be taken for drawing graph.

function

optional

e.g. (bmi, "WEIGHT_CONCEPT_UUID", "HEIGHT_CONCEPT_UUID"); 
Provides the ability to compute one or more concept values.

1.31

showLegend

optional

true

Boolean true/false indicating whether or not to display the graph legend

1.32

hideConcepts

optional

Comma delimited string of concept UUIDs whose lines should not be plotted. This is useful if using the function config parameter that computes the value of one or more concepts but wanted to plot only the computed value.

^{duringCurrentEnrollmentInProgram}

optional

String indicating the UUID of a program. Only the obs that are collected during this program enrollment will be displayed.

2.0

maxResults

required

6

The maximum number of violations to be displayed. A link to fix the violation is only available if the action_url column has a value 

maxRecords

required

6

The maximum number of relationships to display

baseAppPath

optional

/coreapps

Provides the ability to embed the relationships widget in a different module and page than the default coreapps clinician facing dashboard

dashboardPage

optional

/coreapps/clinicianfacing/patient.page?patientId=patientUuid

Indicates to which page to navigate when clicking on a relative

^providerPage

optional

null

If configured, it indicates the page to navigate if the relationship points to a provider

includeRelationshipTypes

optional

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

editPrivilege

optional

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.

maxRecords 

required

6

The maximum number of recent visits to show

maxAge 

optional

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 

combineEncounterTypes

optional

true

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

showEncounterDate

optional

false

When true, the date displayed is the encounter datetime instead of the encounter's visit start date.

showEncounterDate  is processed only when combineEncounterTypes  is set to false .

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

^{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.

program

required

Program UUID (ie. uuid of a program in OpenMRS Program table)

dateFormat

optional

^yyyy-MM-dd

Date format to use when displaying dates

locationTag

optional

null

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

markPatientDeadOutcome

optional

null

UUID of a concept. If that concept is selected as the "Program Outcome", user will be redirected to "Mark Patient Deceased" page 

(assuming the user has the "Task: coreapps.markPatientDead" privilege).  For example, if you have an outcome of "Patient Died" this allows you

to config the widget to redirect to the "Mark Patient Deceased" page if that outcome is selected.

since Core Apps 1.31.0

dashboard

optional

null

ID of a patient dashboard.  Used so that the widget can know the context it is rendered in.  Currently, this is used in conjunction with

the "markPatientDead" functionality: this dashboard id is passed on to the Mark Patient Dead controller so it can properly generate a return 

URL to the appropriate dashboard.

since Core Apps 1.31.0

^{Task: enrollInProgram}

Whether the user has the ability to enroll a patient in a program

Task: editPatientProgram

Whether the user has the ability to edit an existing patient program

Task: deletePatientProgram

Whether the user has the ability to delete an existing patient program

program

required

Program UUID (ie. uuid of a program in OpenMRS Program table)

dateFormat

optional

^yyyy-MM-dd

Date format to use when displaying dates

locationTag

optional

null

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

includeActive

optional

true

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

markPatientDeadOutcome

optional

null

UUID of a concept. If that concept is selected as the "Program Outcome", user will be redirected to "Mark Patient Deceased" page 

(assuming the user has the "Task: coreapps.markPatientDead" privilege).  For example, if you have an outcome of "Patient Died" this allows you

to config the widget to redirect to the "Mark Patient Deceased" page if that outcome is selected.

since Core Apps 1.31.0

dashboard

optional

null

ID of a patient dashboard.  Used so that the widget can know the context it is rendered in.  Currently, this is used in conjunction with

the "markPatientDead" functionality: this dashboard id is passed on to the Mark Patient Dead controller so it can properly generate a return 

URL to the appropriate dashboard.

since Core Apps 1.31.0

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.