Custom Sections and Fields on the Registration App

...

Follow the basic instructions to disable an App and add a custom App found at System Administration: Manage Apps.

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",
   • NB .Ensure your new Id contains a string "registerPatient"   say "referenceapplication.registerPatient.MyRegister" as that string wil be required when  Generating a comprehensive registration summary ID when you try to acces the Edit registration link to the Registration Summary Page seehere
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!
   
   

...

To use the Address Hierarchy Module in the Reference Application Registration App requires a little configuration to a custom App.  The steps are outlined below.

1. Ensure the Address Hierarchy Module is installed and configured per the instructions; including configuration of the address levels, marking them all "Required".
2. Open the App you created in the Initial Steps above.

3. Under the address section, replace...

   Code Block
   language java title Text Box Address Fields
   "widget": { "providerName": "uicommons", "fragmentId": "field/personAddress" }

   with...

   Code Block
   language java title Address Hierarchy Address Fields
   "widget": { "providerName": "registrationapp", "fragmentId": "field/personAddressWithHierarchy", "config" : { "shortcutFor": "address1", "manualFields": ["address2"] } }

   
   

...

"config": {
	"genderOptions":"M,F,U,O"
}

Change the return URL once the registration is done

Allows to redirect the user to a specific page once registration is done. For example to a custom HTML form based on its uuid:

"config": {
    "afterCreatedUrl": "/htmlformentryui/htmlform/enterHtmlFormWithStandardUi.page?patientId={{patientId}}&formUuid=62ef4c41-273f-42db-9fe4-adbc48e814d6"
}

Collecting Additional Patient names with person attributes in the Registration 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

...

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.

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

...

To configure the registration app to support the collection of patient fingerprints and other biometrics, please refer to this page.

Related articles

...