Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Featured add: 2.6

...

keyrequireddefaultvaluesdescriptionminimum version
conceptsrequired
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

conceptNameTypeoptional
  • 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.
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
obsGroupLabelsoptionalnone
  • 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.


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

...

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


encounterType
optionalnullFilters encounters by encounter type
encounterTypes
optional
Introduced with Coreapps v1.29.0. Comma delimited list of Encounter Types. Filters Observations of the same concept from multiple encounters. 
showEncounterTypeName
optionalfalseIntroduced 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.
detailsUrl
optionalnullProvides the option to navigate to a page that contains more detailed information
useConceptShortName
optionalnullIf set to true, the widget would display the concept SHORT name for the coded obs. By default, the obs.value.display is displayed
headersoptionalnullA list of custom column headers. e.g. 
"zl.date,mirebalais.vitals.short.heartRate.title,mirebalais.vitals.short.temperature.title"

...

keyrequireddefaultdescriptionminimum version
conceptIdrequired
Comma delimited string of concepts UUIDs 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 


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

...

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

...

keyrequireddefaultdescriptionminimum version
maxRecordsrequired6The maximum number of relationships to display
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.

...

keyrequireddefaultdescriptionminimum version
maxRecordsrequired6The 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?  

...

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

...

keyrequireddefaultdescriptionminimum version
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.


...

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

...

keyrequireddefaultdescriptionminimum version
displayActivationDateoptional
false
Specifies whether to display date of medication dispensation.
detailsUrloptional
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.
returnUrloptional/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.