Registration Page Extension Points

Description

This page talks about configuring an extension on Registration page to verify/link an extra identifier.

Extensions

Extension points, like the name suggests are used to define a plug-in/plug-off feature

Defining Extensions points on Registration page:

File to be updated: openmrs/apps/registration/extension.json

Example of adding an Extension

"IdentifierLookup":{
        "id": "org.bahmni.registration.identifier.IdentifierSrc",
        "extensionPointId": "org.bahmni.registration.identifier",
        "type": "link",
        "src" : "/sample/index.html",
        "extensionParams": {
            "identifierType": [
                "sampleIdentifier1",
                "sampleIdentifier2"
            ],
            "nonEditable": ["givenName","middleName","familyName","gender","birthDate","age"],
            "linkDisplay": "Verify SampleIdentifier",
            "addressMap": {
                "city": "cityVillage",
                "state": "stateProvince",
                "postalCode": "postalCode",
                "line": "address1"
            }
        }

key	description	Mandatory
id	Unique identifier for extension	N
extensionPointId	"`org.bahmni.registration.identifier`"	Y
type	link	Y
src	The source to be loaded on click of defined button	Y
extensionParams	Contains additional parameters mentioning the extra identifier’s name, which registration page feels become nonEditable after the Identifier linkage, what is the button name : `linkDisplay`, and address map that maps the address FHIR object (returned from the link to registration page) to field in registration page	Y

Assumptions

The link specifies the path to the UI that needs to be rendered on click of the link identifier button.
The external link returns an FHIR patient object to be mapped to Registration Page fields.

Sample FHIR Patient object

address: [{
    city: "",
    country: "IN",
    district: "Bhopal",
    line: ['A-12, Dholakpur'],
    postalCode: "212021",
    state: "Madhya Pradesh",
}],
contactPoint: [
    {system: 'phone', value: '+919800083232'}
],
gender: "F",
id: undefined,
identifiers: [
    {type: {
            text: "identifierType1"},
        value: "hina@xyz"
    },
    {type: {
            text: "identifierType2"},
        value: "57-0517-6745"
    }
],
names: [{familyName: 'Patel', givenName: ['Hina',''], use: ''}],
birthDate: "2000".