/
Registration App Configuration

Registration App Configuration

Jul 01, 2020

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.

  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 see here

  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.


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.

Add Person Attributes

To add a person attribute follow these simple additional steps after completing the Initial Steps above.

  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...


    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...

    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!


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.

    Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

  • 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 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:

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

A complete Json configuration with Mother's Name Person Attribute would look like this...

Register Patient with Person Attribute
{ "id": "referenceapplication.registrationapp.myRegisterPat", "instanceOf": "registrationapp.registerPatient", "label": "My Register Patient", "description": "Create MY new Patient Record", "extensions": [ { "id": "referenceapplication.registrationapp.myRegisterPat.homepageLink", "extensionPointId": "org.openmrs.referenceapplication.homepageLink", "type": "link", "label": "My Register Patient", "url": "registrationapp/registerPatient.page?appId=referenceapplication.registrationapp.myRegisterPat", "icon": "icon-user", "order": 1, "requiredPrivilege": "App: registrationapp.registerPatient" } ], "config": { "afterCreatedUrl": "/coreapps/clinicianfacing/patient.page?patientId={{patientId}}", "sections": [ { "id": "contactInfo", "label": "registrationapp.patient.contactInfo.label", "questions": [ { "legend": "Person.address", "fields": [ { "type": "personAddress", "label": "registrationapp.patient.address.question", "widget": { "providerName": "uicommons", "fragmentId": "field/personAddress" } } ] }, { "legend": "registrationapp.patient.phone.label", "id": "phoneNumberLabel", "fields": [ { "type": "personAttribute", "label": "registrationapp.patient.phone.question", "formFieldName": "phoneNumber", "uuid": "14d4f066-15f5-102d-96e4-000c29c2a5d7", "widget": { "providerName": "uicommons", "fragmentId": "field/text" }, "cssClasses": ["phone"] } ] }, { "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" } } ] } ] } ] } }

Integrate Address Hierarchy

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...

    Text Box Address Fields

    "widget": { "providerName": "uicommons", "fragmentId": "field/personAddress" }

    with...

    Address Hierarchy Address Fields

    "widget": { "providerName": "registrationapp", "fragmentId": "field/personAddressWithHierarchy", "config" : { "shortcutFor": "address1", "manualFields": ["address2"] } }