Custom Sections and Fields on the Registration App

The Reference Application includes a built-in Registration app that is configured for

Custom Sections and Fields on the Registration App

The Reference Application includes a built-in Registration app that is configured for a common one-size-fits-all use case. However it is possible to disable the built-in app, and set up your own customized version.  For example, you can integrate the address hierarchy module and add additional person attributes.  You can see the full list of configuration options in the template definition found at this link, which describes the config fields.

...

1. Navigate to System Administration-->Manage Apps
2. Click the square disable button beside "referenceapplication.registrationapp.registerPatient" to disable the integrated Registration App configuration.
3. Add a new App Definition by clicking "Add App Definition".
4. Give your new App a name, perhaps "referenceapplication.registrationapp.myRegisterPat".
5. Copy the latest template for the registration App, found here (note that the square brackets before and after should not be used). 
6. Paste this into the Definition (required) field.
7. Modify the ID to represent the ID you specified in step 4 above.  For example, change "id": "referenceapplication.registrationapp.registerPatient", to "id": "referenceapplication.registrationapp.myRegisterPat",
8. Modify the URL line to represent the ID you specified in step 4 above.  For example, change "url": "registrationapp/registerPatient.page?appId=referenceapplication.registrationapp.registerPatient", to "url": "registrationapp/registerPatient.page?appId=referenceapplication.registrationapp.myRegisterPat",
9. If you prefer, you can change the "description" and "label" fields to your liking, for example, name them in your language.  You can also change the icon and order to your liking.

10. Save the new App configuration.
    
    

...

1. Find the UUID of the Person Attribute Type (s) that you want to add to the Registration App. 
   1. Go to System Administration --> Advanced Administration --> Manage Person Attribute Types
   2. Click on the name of the Person Attribute, for example "Mother's Name".
   3. You will find the UUID listed in grey, for example... 8d871d18-c2cc-11de-8d13-0010c6dffd0f
   Note: If the person attribute you want to add doesn't yet exist, you can create it here.
2. Open the App you created in the Initial Steps above.

3. In the list of sections you can add a new section, or you can simply add the person attribute to an existing section.  Sections and fields are separated with a comma.  The code to add a question of Mother's Name is...
   
   

   Code Block
   language java title Mother Name Person Attribute Field
   { "type": "personAttribute", "label": "Mother's Name", "formFieldName": "mothersName", "uuid": "8d871d18-c2cc-11de-8d13-0010c6dffd0f", "widget": { "providerName": "uicommons", "fragmentId": "field/text" } }

   If you want to add the question in a section of it's own, you would use something like this, placed in the list of sections...

   Code Block
   language java title Person Attribute in own section
   { "legend": "My Person Attribute", "id": "myPersonAttributeLabel", "fields": [ { "type": "personAttribute", "label": "Mother's Name", "formFieldName": "mothersName", "uuid": "8d871d18-c2cc-11de-8d13-0010c6dffd0f", "widget": { "providerName": "uicommons", "fragmentId": "field/text" } } ] }

   
   

4. Change the "uuid": value to the UUID of the Person Attribute that you want to appear in the Registration App.
5. Save your App and enjoy!
   
   

...

Setup Master Patient Index configuration

You have to setup some global properties:

...

OpenEMPI specific properties:

1. registrationcore.openempi.globalIdentifierDomainId : specifies global identifier type at OpenEMPI server. You can find this value in your admin page at OpenEMPI server. Property type: integer. 
2. registrationcore.openempi.enableProbabilisticMatching : specifies whether system should search for similar patients. At registrationcore v1.4 this functionality is not supported, so it shopuld be turned off. Property type: boolean (true/false).

Mapping Local to Mpi identifiers:

To map identifiers from MPI server to local OpenMRS application, you have to specify how they maps on each other. Of course, first of all you have to create proper identifier types in Managing patient identifiers console& (For example: you can see that in screenshot above there is ECID identifier, which was created for mapping).

How to specify mapping? You have to create property in Global properties which names:

registrationcore.local_mpi_identifierTypeMap.{name_of_identifier_type} : {local_identifier_type_id} : {mpi_identifier_type_id}

...

Setting up Registration Open Web App

Note: The app needs to have an address field. If it does not, such as in the "registrationapp.basicRegisterPatient" (defined in openmrs-module-registrationapp/omod/src/main/resources/apps/registrationapp_app.json) you will receive the following errors:

ERROR - PixPatientExporter.exportPatient(47) |2018-06-25 15:07:18,328| java.util.NoSuchElementException

ERROR - PatientCreationListener.performMpiAction(71) |2018-06-25 15:07:18,339| PIX patient push exception occurred

this is because the fields sent to the MPI through PIX/PDQ is hardcoded (defined in openmrs-module-registrationcore/api/src/main/java/org/openmrs/module/registrationcore/api/mpi/pixpdq/PixPdqMessageUtil.java)

Thus, if you use a registration app that has all the required fields, such as the referenceapplication.registrationapp.registerPatient that comes with the reference application, it will not produce that error.

------------------------------------------------------------------------------------------------------------------------

OpenEMPI Specific Rest API Implementation of MPI functionality

• Developed by Roman Zayats
• See Google Summer of Code 2015 Project Page: Integrate Registration Module with a Master Patient Index

You have to setup some global properties:

1. registrationcore.mpi.implementation : specifies which MPI implementation you are going to use. Since registrationcore v1.4 you can use OpenEMPI implementation.
2. registrationcore.mpi.url : specifies url to MPI server Property type: string. Example: 128.100.10.10:8080/openempi-admin
3. registrationcore.mpi.username : username for authentication on MPI server
4. registrationcore.mpi.password : password for authentication on MPI server
5. registrationcore.mpi.personIdentifierId : specifies local patient identifier type id. Through this identifier imported MPI patient will be linked with patient on remote MPI server. You have to create new patient identifier type in Managing patient identifiers console: 
   
   Image Added

OpenEMPI specific properties:

1. registrationcore.openempi.globalIdentifierDomainId : specifies global identifier type at OpenEMPI server. You can find this value in your admin page at OpenEMPI server. Property type: integer. 
2. registrationcore.openempi.enableProbabilisticMatching : specifies whether system should search for similar patients. At registrationcore v1.4 this functionality is not supported, so it shopuld be turned off. Property type: boolean (true/false).

Mapping Local to Mpi identifiers:

To map identifiers from MPI server to local OpenMRS application, you have to specify how they maps on each other. Of course, first of all you have to create proper identifier types in Managing patient identifiers console& (For example: you can see that in screenshot above there is ECID identifier, which was created for mapping).

How to specify mapping? You have to create property in Global properties which names:

registrationcore.local_mpi_identifierTypeMap.{name_of_identifier_type} : {local_identifier_type_id} : {mpi_identifier_type_id}

Example: registrationcore.local_mpi_identifierTypeMap.ECID : 5:60

------------------------------------------------------------------------------------

Integrating with fingerprinting and other biometrics

...