customise messages

oliebolz · July 2, 2024, 12:44am

Hello team,

I’m currently trying to customise an OpenMRS installation so that it is usable within the aged care sector. Within the aged care sector, we utilise different terminology, such as referring to a patient as a client. I’d like to customise the application to reflect these changes. However, it’s unclear to me how I can do that as:

I’ve not been able to find the messages.properties file.
The Custom Message Module shows “There was an error starting the module: Custom Message,” and on the line within the “manage modules” table, there is simply the message “Error starting! Click for details” without a link.

Any assistance with this would be appreciated.

Fyi I am using Last Build: 2024-06-18 15:43 Version: 2.6.6 Build 2aeebf of the reference application

Thanks again.

Regards Olie

mksd · July 2, 2024, 3:51am

The @ICRC has done something similar where the word “patient” is changed to “HSU” (health services user) all throughout OpenMRS.

Hopefully someone from their team will be able to share the steps to make this happen? The tips and tricks will apply to O2 and O3.

jofrancisco · July 2, 2024, 9:01am

Hi Olie,

Regarding your question on customizing OpenMRS for the aged care sector, here’s a detailed guide based on our experience at ICRC:

Messages.properties File:

For OpenMRS 2.x, you typically locate the messages.properties file in your distribution package and update it with the new values, label by label. This file will override the labels from other modules.

Core Module Example: If you want to change a label initialized in the core module, find the label key here:

github.com

openmrs/openmrs-module-coreapps/blob/a6ce43ba50c41d609b531debec094d7beae13c40/api/src/main/resources/messages.properties#L24


      
          
          coreapps.title=Core Apps Module
          coreapps.patientDashboard.description=Patient Dashboard Application
          coreapps.patientDashboard.extension.visits.description=Visit Actions
          coreapps.patientDashboard.actionsForInactiveVisit=Attention! These actions are for a past visit:
          coreapps.patientDashboard.extension.actions.description=General Patient Actions
          
          coreapps.activeVisits.app.label=Active Visits
          coreapps.activeVisits.app.description=Lists patients who have active visits
          
          coreapps.findPatient.app.label=Find Patient Record
          coreapps.findPatient.search.placeholder=Search by ID or Name
          coreapps.findPatient.search.button=Search
          coreapps.findPatient.result.view=View
          coreapps.age.months={0} Month(s)
          coreapps.age.days={0} Day(s)
          
          coreapps.patientDashBoard.editPatientIdentifier.duplicateMessage=is already in use
          coreapps.patientDashBoard.editPatientIdentifier.invalidMessage=did not pass validation
          coreapps.patientDashBoard.editPatientIdentifier.invalidFormatMessage=must be in the format
          coreapps.patientdashboard.activeDrugOrders=Dispensed Medication

Extract the key and add it to your messages.properties file in your distro. It will override the original.

Concepts: To change concept labels, locate the concept and update the label, e.g., in the reference application:

github.com

openmrs/openmrs-distro-referenceapplication/blob/5e4f2c8a1333261d86ef37a2b60f33bdd76cc6ea/distro/configuration/concepts/findings-core_demo.csv#L7


      
          Uuid,Void/Retire,Same as mappings,Fully specified name:en,Fully specified name:fr,Short name:en,Short name:fr,Description:en,Description:fr,Data class,Data type,Absolute low,Critical low,Normal low,Normal high,Critical high,Absolute high,Units,Allow decimals,Display precision,_version:1,_order:1000
          5085AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5085;PIH:5085;AMPATH:5085;SNOMED CT:271649006,Systolic blood pressure,Tension arterielle systolique,SBP,,A patient's systolic blood pressure measurement (taken with a manual cuff in either a sitting or standing position),,Finding,Numeric,0,85,100,140,180,250,mmHg,No,,,
          5086AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5086;PIH:5086;AMPATH:5086;SNOMED CT:271650006;LOINC:35094-2,Diastolic blood pressure,Tension arterielle diastolique,DBP,,A patient's diastolic blood pressure measurement (taken with a manual cuff in either a sitting or standing position),,Finding,Numeric,0,40,55,90,120,150,mmHg,No,,,
          5088AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5088;PIH:5088;AMPATH:5088,Temperature (c),Température (c),Temp (c),,Patient's temperature in degrees centigrade.,,Finding,Numeric,25,,35,37.7,39,43,DEG C,Yes,,,
          5090AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5090;PIH:5090;AMPATH:5090,Height (cm),Taille (cm),HT,,Patient's height in centimeters.,,Finding,Numeric,10,,,,,272,cm,Yes,,,
          5089AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5089;PIH:5089;AMPATH:5089,Weight (kg),Poids (kg),WT,,Patient's weight in kilograms.,,Finding,Numeric,0,,,,,250,kg,Yes,,,
          5087AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5087;PIH:5087;AMPATH:5087;SNOMED CT:78564009,Pulse,Pouls,HR,,"Patient pulse rate, as measured with a peripheral oximeter.",,Finding,Numeric,0,49,55,100,130,230,beats/min,No,,,
          1343AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:1343;PIH:1290;AMPATH:1343;SNOMED CT:284473002,Mid-upper arm circumference,Circonférence du haut du bras,MUAC,,"MUAC is the circumference of the left upper arm, measured at the mid-point between the tip of the shoulder and the tip of the elbow. MUAC is useful for the assessment of nutritional status.",,Finding,Numeric,,,,,,,cm,Yes,,,
          5242AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5242;PIH:5242;AMPATH:5242;SNOMED CT:86290005,Respiratory rate,Rythme respiratoire,RR,,Measured respiratory rate in breaths per minute,Frequence respiratoire,Finding,Numeric,0,8,12,18,26,999,breaths/min,No,,,
          5283AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5283;AMPATH:5283,Karnofsky performance score,,KPS,,"Zero to 100 scale commonly used for assessing terminally ill patients.",,Finding,Numeric,,,,,,,%,,0,,
          5092AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,,CIEL:5092;AMPATH:5092;SNOMED CT:431314004,Arterial blood oxygen saturation (pulse oximeter),Saturation d'oxygène dans le sang,SpO2,,"Oxygen saturation, as measured from a peripheral oximeter.",,Finding,Numeric,0,90,95,,,100,%,Yes,,,,

OpenMRS 3.x:

For changing labels in the front-end modules, use the translation overrides property for that module. Here’s an example:

github.com

mks-d/ozone-distro-cambodia/blob/c4d1f655003690981104edea0ce29fd8de498860/configs/ozone_config/frontend/ozone-frontend-config.json#L88


      
            {
              "id": "relationshipsSection",
              "name": "Relationships",
              "fields": []
            }
          ],
          "defaultPatientIdentifierTypes": [
            "a4949ae8-d858-444b-ac9f-33c1d8825442",
            "177c01be-789a-4c47-9515-3e6b092d4322"
          ],
          "Translation overrides": {
            "en": {
          
              "Commune": "Commune",
              "Village": "City",
              "Country": "Country",
              "Province": "Province",
              "District": "District",
              "contactSection": "Contact Details",
              "demographicsSection": "Basic Info",
              "Male": "Male",

Ampath Forms Schema: Create an ampathformstranslations file if you need to change a label in the Ampath forms schema, similar to this example: openmrs-distro-referenceapplication/distro/configuration/ampathformstranslations/Ampath POC adult return visit form_translations_en-core_demo.json at 5e4f2c8a1333261d86ef37a2b60f33bdd76cc6ea · openmrs/openmrs-distro-referenceapplication · GitHub

I hope this covers most of the scenarios for customizing your OpenMRS installation. Let me know if you need further assistance!

Kind regards,

ICRC Team

CC: @frederic.deniger @icrc.psousa @luis.oliveira

oliebolz · July 2, 2024, 9:08am

thanks Team - i’ll have a crack at it