Table of Contents

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.

Initial Steps

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

...

Table of Contents

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.

Initial Steps

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

...

Navigate to System Administration-->Manage Apps
Click the square disable button beside "referenceapplication.registrationapp.registerPatient" to disable the integrated Registration App configuration.
Add a new App Definition by clicking "Add App Definition".
Give your new App a name, perhaps "referenceapplication.registrationapp.myRegisterPat".
Copy the latest template for the registration App, found here (note that the square brackets before and after should not be used).
Paste this into the Definition (required) field.
Modify the ID to represent the ID you specified in step 4 above. For example, change "urlid": "registrationapp/registerPatient.page?appId=referenceapplication.registrationapp.registerPatient", to "urlid": "registrationapp/registerPatient.page?appId=referenceapplication.registrationapp.myRegisterPat",
- 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.

...

title	Notes:

- 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
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",
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.
Save the new App configuration.

Info

title	Notes:

If you have a syntax error, it will give you an error "Invalid Json", and not let you save it until fixed.
If you didn't change the App ID in the Json, it will give you an error "The App ID should match the one in the definition" when you try to save it.
If the App name is too long, it will give you an error like, "Failed to save referenceapplication.registrationapp.myRegisterPatient", and not let you save it.

...

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.
Open the App you created in the Initial Steps above.

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"
                 }
       }
      ]
}

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

Info

title	Notes:

You must create your Person Attribute Types before adding them to the Registration App. You can find instructions at Managing Person Attribute Types.
Coded Person Attributes are not currently supported in the Registration App.
Jira Legacy
server OpenMRS JIRA
serverId 45c5771b-fa4b-3e43-b34a-c19dc45ccc95
key REG-15
You can add multiple Person Attribute fields to a single section.
You can add fields to the demographics section by naming the section "demographics" in your json file. Whatever fields you add will be added after the patient's birth date question.
The sections will be ordered in the form exactly how in the same exact way they are ordered in the json. This includes the ability to collect fields before the patient's demographic information is collected.
- The only exception to this is the question that asks if the registration was done today when retrospective registrations are enabled.

You can make a particular field required by adding a "cssClasses": ["required"] after the "widget" declaration in the field. The following code block shows the cssClasses declaration that makes the phone number required:

Code Block

"fields": [
	{
		"type": "personAttribute",
		"label": "registrationapp.patient.phone.question",
		"formFieldName": "phoneNumber",
		"uuid": "14d4f066-15f5-102d-96e4-000c29c2a5d7",
		"widget": {
			"providerName": "uicommons",
			"fragmentId": "field/text"
		},
		"cssClasses": ["phone","required"]
	}
]

...

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.

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

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"]
        }
}

...

Combining registration sections into one section is achievable by setting "combineSections" to true. This combines all the registration sections' questions/sub-sections into the demographics section. The following line can be added to the config section of the Registration App Definition to allow for combining of sections into one.

Code Block
"config": { "combineSections":true }

...

Code Block
"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:

Code Block
"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

...

Additional identifiers can be collected by adding a section in the config, just as you would when adding person attributes. The primary difference has to do with the field type which is "patientIdentifier" and the UUID is the UUID of the patient identifier, found in grey in the patient Identifier types page for that identifier.

Image Removed

Here's where it's exposed in the UI where users can click on the identifier to edit it.

Image Removed

Find the UUID of the Patient Identifier Type(s) that you want to add to the Registration App.
1. Go to System Administration --> Advanced Administration --> Patient Identifier Type Management
2. Click on the name of the Patient Identifier Type, for example "Old Identification Number".
3. You will find the UUID listed in grey, for example... 8d79403a-c2cc-11de-8d13-0010c6dffd0f
4. Make sure to set the Location behavior to "Not Used" as you can see in this screenshot
Open the App you created in the Initial Steps above.

In the list of sections you can add a new section. Sections and fields are separated with a comma. The code to add a section to collect the Old Identification Number is...

Code Block

{
	"id": "patient-ids",
	"label": "Patient-Identifier",
	"questions": [
		{
			"legend": "Old Identification Number",
			"id": "Old_Identification_Number_patientIdentifier",
			"fields": [
				{
					"type": "patientIdentifier",
					"label": "Old Identification Number",
					"formFieldName": "oldIdentificationNumber",
					"uuid": "8d79403a-c2cc-11de-8d13-0010c6dffd0f",
					"widget": {
						"providerName": "uicommons",
						"fragmentId": "field/text"
					},
					"cssClasses": ["required"]
				}
			]
		}
	]
}

...

{
	"id": "patient-ids",
	"label": "Patient-Identifier",
	"questions": [
		{
			"legend": "Old Identification Number",
			"id": "Old_Identification_Number_patientIdentifier",
			"fields": [
				{
					"type": "patientIdentifier",
					"label": "Old Identification Number",
					"formFieldName": "oldIdentificationNumber",
					"uuid": "8d79403a-c2cc-11de-8d13-0010c6dffd0f",
					"widget": {
						"providerName": "uicommons",
						"fragmentId": "field/text"
					},
					"cssClasses": ["required"]
				}
			]
		}
	]
}

This allows you to collect the patient identifiers in the registration app, but it doesn't allow you to collect them elsewhere in the user interface. To add the ability to edit patient identifiers to the patient header in the clinician facing dashboard, you need to add the UUID of each identifier to the global property "emr.extraPatientIdentifierTypes":

Image Added

Here's where it's exposed in the UI where users can click on the identifier to edit it.

Image Added

Configuring a dropdown widget that consumes a concept-set in the Registration App

A drop-down widget to capture Concept formatted person attributes types can be defined/configured as follows below. One can provide the options as a map of 'options', 'conceptSet' or both as seen in the below example.

Code Block

language	js
title	Dropdown widget that consumes a concept-set

{
    "id": "nationality",
    "legend": "Country of Origin",
    "fields": [{
        "label": "Country of Origin",
        "type": "personAttribute",
        "formFieldName": "nationality",
        "uuid": "personAttributeTypeUuid-of-format-org.openmrs.Concept",
        "widget": {
            "providerName": "registrationapp",
            "fragmentId": "field/dropDown",
            "config": {
                "formFieldName": "nationality",
                "conceptSet": "165657AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
                "options": [{
                    "label": "",
                    "value": ""
                }],
                "initialValue": "",
                "hideEmptyLabel": true,
                "expanded": false
            }
        }
    }]
}

Integrating with a Master Patient Index

...

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 map identifiers from MPI server to local OpenMRS application, you have to specify how they maps map 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 the screenshot above there is a ECID identifier, which was created for mapping).

...

Versions Compared

Old Version 24

New Version Current

Key

Custom Sections and Fields on the Registration App

Initial Steps

Custom Sections and Fields on the Registration App

Initial Steps

Change the return URL once the registration is done

Collecting Additional Patient names with person attributes in the Registration App

Configuring a dropdown widget that consumes a concept-set in the Registration App

Integrating with a Master Patient Index

Page Comparison

Versions Compared

Old Version 24

New Version Current

Key

Custom Sections and Fields on the Registration App

Initial Steps

Custom Sections and Fields on the Registration App

Initial Steps

Change the return URL once the registration is done

Collecting Additional Patient names with person attributes in the Registration App

Configuring a dropdown widget that consumes a concept-set in the Registration App

Integrating with a Master Patient Index