Patient Image Module


The patient image module allows adding an image of the patient in the patient dashboard. The module adds a tab to the patient dashboard to manage the patient image.

By default, if no image is available, the module will display a silhouette as the patient image and clicking on the Patient Image tab will allow managing this image. The image can either be captured through a webcam or an image can be uploaded. The portrait of the patient is saved in the OpenMRS Application Data directory under the patient_images folder. A person attribute (Patient Image) is used to associate the filename with the image. Currently the filename is the preferred identifier of the patient, but in later version will be customizable through a global property.

As of version 1.0, the module uses HTML 5 for image capture through connected Camera. File upload also uses the HTML5 File API. Thus, Flash plugin is no more required for the use of this module. Changing image for the patient can be done only through the legacy UI dashboard tab. Next release will allow modifying patient images through the UI 2.x dashboard.

Two settings (formerly Global Properties from 1.8 downwards)can be configured to enable the patient images on dashboard:

  • patientimage.showOnLegacyDashboard = true (displays patient image on Legacy UI)
  • patientimage.showOn2xDashboard = true (displays patient image on UI 2.x dashboard)



  • Session authentication is required for UI 2.x dashboard to display patient image

** Patient images are overridden and previous versions of images are not stored. **

Source code

Since v1.0 (uses MPL 2.0 with HD) -

v0.5 and older releases (uses OpenMRS Public license v1) -



Release Notes

  • 1.0
    • Removed Flash player dependencies and uses HTML5 getUserMedia API
    • Uses HTML5 File API for image upload
    • Works on reference application 2.x UI as well as Legacy UI patient dashboard
    • Works all the way from OpenMRS 1.6 - Reference application 2.3
  • 0.5
    • OTHER-34 fixed
    • Upgrading to colorbox v1.3.20.1
    • Requires Flash player 11.1.0 and higher
  • 0.4
    • Bugfixes to be compatible with 1.9
    • Auto-resize depending on header height (works with Visit enabled in Patient Dashboard)
    • Minor bugfixes in UI by upgrading jquery.form and colorbox
  • 0.3.3
    • Bugfixes to be compatible with 1.7+
  • 0.3.2
    • Added privilege for managing patient images on dashboard
  • 0.3.1
    • Bug fixes
    • Improved scaling and image capture quality
  • 0.3
    • Bug fixes
    • Requires Flash Player 10 to comply with new sandbox security
  • 0.2 (Official beta release to community)
    • Bug fixes
    • Added webcam support
  • 0.1
    • Initial release

Upcoming features (No ETA)

  • Allow patient image upload and camera capture from 2.x UI
  • Patient image album (multiple images and history of patient images)
  • Allow storing patient image in multiple formats