{"type":"doc","content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"outline":{"value":"true"},"indent":{"value":"20px"},"style":{"value":"none"},"printable":{"value":"false"}},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"The ui.springmvc module allows you to rapidly compose new UIs out of re-usable components.","type":"text"}]},{"type":"paragraph","content":[{"text":"In order to use this module you would write another module that depends on it, and configures the way it wants to use the ui.springmvc's widgets via it's webModuleApplicationContext.xml.","type":"text"}]},{"type":"paragraph","content":[{"text":"The goal of this module is to make development and reuse of widgets quick and easy, without changing OpenMRS's underlying MVC paradigms. (The module's code does not intend to be elegant.)","type":"text"}]},{"type":"paragraph","content":[{"text":"Additional widgets are most welcome.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Available Components","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Homepage with list of \"Apps\"","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"\"App\" with an icon and a homepage","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n \n \n\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Create Patient page","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Patient Dashboard with Tabs, each containing Widgets","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n \n \n \n ...\n \n \n \n \n\n","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Available Widgets","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"\"Anywhere\" Widgets","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Patient Search Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"An AJAX find-patient widget.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nonClickUrl (required): what url to go to go to when a patient is clicked on. (will have \"?patientId=xyz\" appended)\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Patient Viewed History Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"Shows a list of the patients the current user has viewed during this session","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nonClickUrl (required): where to go when a patient is clicked on. (will have \"?patientId=xyz\" appended)\nmaxSize (default=10): maximum number of patients to show in the list\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Button Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"A button","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nlabel (required): the text on the button\nhref: what url to go to when clicked\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Patient Widgets","type":"text"}]},{"type":"paragraph","content":[{"text":"These widgets are only usable in a patient-centric context, like on a patient dashboard","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Program Enrollment Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"Allows you to enroll the patient in, and exit them from a specific program. You may specify an html forms to use to enroll the patient, otherwise a generic date + workflow-statuses will be used.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nprogramId (int, required): what program is this for\nshowPastEnrollments (boolean, default=true): whether to show a compact list of past enrollments in the program\nshowCurrentEnrollment (boolean, default=true): whether to show details of the current program enrollment\nshowEnrollButton (boolean, default=true): whether to allow enrollment (if the patient isn't already enrolled)\nshowExitButton (boolean, default=true): whether to allow exiting (if the patient is currently enrolled)\nenrollmentFormIds (List): ids of forms that may be used to enroll the patient\noutcomeWorkflowIds (List): ids of workflows that must have a value specified when the patient is exited from the program.\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Form Table Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"Shows one-row-per-encounter, based on a form or an encounter type, and lets you add more via an html form.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nencounterTypeId (int): only show encounters of this encounter type\nformId (int): only show encounters for the given form\naddAnotherFormId (int): if specified then an \"Add another\" button will be displayed, popping up this html form.\ncolumns (List, required): what columns to display in this table. (See Utility classes -> Columns below.)\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Obs Group Table Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"Shows one-row-per-obs-group","type":"text"}]},{"type":"codeBlock","content":[{"text":"\ngroupingConceptId (int, required): show obs groups with this as their grouping concept\ncolumnConceptIds (LinkedHashMap, required): text of the column heading, and the id of the concept to display in that column\naddAnotherFormId (int): if specified, display an \"Add another\" button that pops up this html form\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Obs Graph Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"Shows a graph (over time) of numeric obs of the specified concept","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nconceptId (int, required): which concept\nminY (int): optional min value of the y-axis\nmaxY (int): optional max value of the y-axis\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Active Problems Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"A simple list of active problems for a patient, e.g. what you'd get if you integrate across PROBLEM ADDED and PROBLEM REMOVED obs for a patient.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\naddConceptId (int, required): what concept adds problems to the list\nremoveConceptId (int): what concept removes problems from the list\nshowCurrentProblems (boolean, default=true): whether to show currently-active problems\nshowResolvedProblems(boolean, default=false): whether to show problems that have been resolved\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Regimen Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"Shows a regimen view of drugs orders whose generic drug is in the specified drug set","type":"text"}]},{"type":"codeBlock","content":[{"text":"\ndrugSetConceptId (int, required): which concept represents the drug set (e.g. antiretroviral drugs)\nregimenSuggestions (List): regimens that may be added via shortcuts\nchangeReasonConceptIds (LinkedHashMap): reasons that may be given for changing a regimen (concept -> display label)\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Visit List Widget","type":"text"}]},{"type":"paragraph","content":[{"text":"A widget that shows all the patient's visits, where a visit is defined as all encounters at the same location on the same day","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nmaxNumber (int): optional limit for how many to show\nsortDescending (boolean, default=true): if true, show the most-recent at the top\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Utility classes","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Columns","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SingleConceptColumn","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nconceptId (int, required): just this concept\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Column","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nString heading\nList contents\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"TextDisplayItem","type":"text"}]},{"type":"paragraph","content":[{"text":"String html","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ConceptDisplayItem","type":"text"}]},{"type":"paragraph","content":[{"text":"Integer conceptId","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Download","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Download the ui.springmvc module","type":"text","marks":[{"type":"link","attrs":{"href":"http://modules.openmrs.org/modules/view.jsp?module=ui.springmvc"}}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Screenshots","type":"text"}]},{"type":"paragraph","content":[{"text":"Overall homepage","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":686,"id":"773787c8-bb18-4f1b-b1d0-ec63494ca305","collection":"contentId-25520599","type":"file","height":506}}]},{"type":"paragraph","content":[{"text":"App homepage","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":686,"id":"79aa275d-dc20-4494-a69a-f632bf69e8ad","collection":"contentId-25520599","type":"file","height":355}}]},{"type":"paragraph","content":[{"text":"Patient dashboard","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":686,"id":"31d4802b-90aa-4282-957b-ad1f54fe399a","collection":"contentId-25520599","type":"file","height":451}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Release Notes","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Version 0.1","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Initial alpha release","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Basic Example","type":"text"}]},{"type":"paragraph","content":[{"text":"This would be the webModuleApplicationContext.xml file for a simple module that uses ui.springmvc to create one app. It uses the patient search widget, the recently-viewed-history widget, and the create-patient page. It also includes a patient dashboard with a few tabs","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n\n \n \n \n 50\n \n \n rwandamohHomepage\n dataentryHomepage\n dataentryPatientDashboard\n dataentryCreatePatientController\n \n \n \n \n \n \n \n \n\n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n 1\n \n \n \n \n 2\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Suspected medication\n 1296\n \n \n Reaction\n 1297\n \n \n Action taken\n 1643\n \n \n \n \n \n \n \n \n \n \n \n Diagnosis\n 2134\n \n \n Date\n 3290\n \n \n Discharge date\n 3800\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n","type":"text"}]}],"version":1}

Browser not supported