Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 featureBahmni Registration module provides an extension for linking/verifying other identifiers for patients. Implementers can plugin in their custom requirements leveraging this extension.

Extensions

Implementers are expected to leverage the extension point “org.bahmni.registration.identifier". As of now, only “link” type are supported. This means that an implementer can specify an URL to a
sub-system/UI and Bahmni will launch in an IFRAME. It is expected that such an extension will return a basic FHIR patient resource (JSON) and send that as a message to the parent window.

Defining Extensions points on Registration page:

...

Example of adding an Extension

Code Block
"IdentifierLookup":{
        "id": "org.bahmni.registration.identifier.IdentifierSrcyour_identifier_id",
        "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"]
            }
            "requiredPrivilege": "app:registration"
        }

key

description

Mandatory

id

Unique identifier for extension

NY

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 which include extra identifier’s name, which registration page feels become nonEditable after the Identifier linkage, what is the button name : linkDisplay, and button name and so on

Y

extensionParams.identifierType

one or more identifier type name. Note, if different identifier types require different source integration, define separate extensions.

Y

extensionParams.nonEditable

defines attributes which needs to be non-editable after extra Identifier linkage

N

extensionParams.linkDisplay

defines button display name

Y

extensionParams.addressMap

address map that maps the address FHIR object (returned from the link to registration page) to field in registration page

YN

Assumptions

  1. The link specifies the path to the UI that needs to be rendered on click of the link identifier button.

  2. The external link returns an FHIR patient object to be mapped to Registration Page fields.

The returned payload is expected as a simple FHIR Patient resource.

Note: A complete patient resource is not required - only fields

...

Sample like identifier(s), name, birthdate, gender and address, those you want to be updated with a value from FHIR patient in registration page are expected.

If you provide patientUuid in FHIR patient id field, it will redirect to that patientUuid dashboard and update the respective details passed as a part of FHIR object. If id not defined, it will redirect and update details in the create new patient dashboard.

For example: consider the following FHIR Patient object

Code Block
address{
  id: 'patientUuid',
  identifiers: [
    {
    city  type: "", {
        countrytext: "IN",identifierType1"
      },
      districtvalue: "Bhopal",hina@xyz"
    },
    {
 line: ['A-12, Dholakpur'],     type: {
        postalCodetext: "212021",identifierType2"
      },
      statevalue: "Madhya Pradesh",
}],
contactPoint57-0517-6745"
    }
  ],
  names: [
    {system: 'phone', value: '+919800083232'}
],

      familyName: 'Patel',
      givenName: [
        'Hina',
        ''
      ],
      use: ''
    }
  ],
  gender: "F",
  idbirthDate: undefined"2000-10-21",
identifiers: [ isBirthDateEstimated: false
  {typecontactPoint: {[
    {
       textsystem: "identifierType1"},
'phone',
       value: "hina@xyz"'+919800083232'
    }
  ],
  address: [
    {type:
{      city: "",
     text country: "identifierType2IN"},
        valuedistrict: "57-0517-6745Bhopal",
    } ], namesline: [{familyName: 'Patel', givenName: ['Hina',''], use: ''}],
birthDate: "2000".
        'A-12, Dholakpur'
      ],
      postalCode: "212021",
      state: "Madhya Pradesh",
      
    }
  ] 
}