Versions Compared

Version Old Version 15 New Version Current
Changes made by

Heidi Kuum (Deactivated)

Nico Lueck

Saved on

Key

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

GovStack resources

GovStack requirements for BB

https://govstack.gitbook.io/specification/architecture-and-nonfunctional-requirements/introduction#2.3-building-blocks

GovStack requirements for registration BB

https://govstack.gitbook.io/bb-registration

GovStack GitHub Registration

https://github.com/GovStackWorkingGroup/bb-registration

Registration of the beneficiary candidate and evaluation of eligibility. In this step, citizen is registered to SRIS - Social Registration Information System where eligibility evaluated, linked to the suitable benefit program in BOMS - Beneficiary Operations Management System and payment request created.

Initial plan for involving actual BB candidates:

...

Materials from here: https://docs.google.com/presentation/d/1IZh5FQIqgmVkk7KU0ui8ETVaFawfsT-DFO8Zql6G-mU/edit#slide=id.g1177a058de2_0_10

Normal course of registration in MVP

Normal course is a description on what happens if the event is triggered and pre-conditions are met. Following table contains the comparison of MVP normal course and fully implemented workflow normal course.

MVP course

  1. User fills beneficiary's data form in SRIS:

    • User enters citizen personal ID

      • Citizen personal data is pulled from CR-Citizen Registry via x-road and personal data fields filled automatically

    • User enters citizen banc account details

  2. Submits the registration form.

    • Record in SRIS with beneficiary data is created

  3. User associates the benefit program with the beneficiary

    • Program data is provided from BOMS

  4. User submits the benefit form

  5. Payment request message is sent to IM

  6. Payment completion message received from IM (this messaging will be mocked)

    1. Mark payment completed

...

Preconditions:

  • Information mediator IM is installed to the sandbox and enabled

  • The mocked database acting as the CR (Citizen Registry) is created

  • The mocked benefit program data is available in BOMS

  • The User (Civil-servant who fills citizen registration form in SRIS) must be created in SRIS and BOMS to fill and submit registration form.

To create SRIS and BOMS record, Users, Citizen and Benefit program data must be available.

login

openIMIS API:

swagger POST: https://dev-mssql.s1.openimis.org/api/api_fhir_r4/docs/swagger/#/api_fhir_r4/api_fhir_r4_login_create

DB

Data

  • FHIR IG: http://fhir.openimis.org/security.html

    • Users

    • User unique ID

    • Name

    • Last name

    • Role

    • Region (address)

    • District (address)

    CR - Citizen Registry

    openIMIS API:

    Swagger:

  • POST https://dev-mssql.s1.openimis.org/api/api_fhir_r4/docs/swagger/#/api_fhir_r4/api_fhir_r4_Patient_create

    • GET https://dev-mssql.s1.openimis.org/api/api_fhir_r4/docs/swagger/#/api_fhir_r4/api_fhir_r4_Patient_list

    SRIS - Social Registry Information System

  • openIMIS API (Programm ID & Name):

    • openIMIS API (contract)

    BOMS - Beneficiary Operations Management SystemWe need to register the notification to get payment data

    • Program/Product ID

    • Program name

    • Citizen ID (Beneficiary)

    • Benefit amount (coming with the product)

    • Benefit due date

    • ….

    IFMS - Integrated Finance Management Information System

    • Personal ID (Citizen)

    • Bank Account number

    • Debit amount

    • Credit amount

    Trigger

    Trigger is the event that triggers the BB action. In this phase there are four triggers based on user actions in UI:

    1. Create SRIS record - triggered when user submits the record

    2. Provide benefit program data - triggered when user associates the SRIS record to BOMS benefit program record

    3. Create BOMS record - triggered when user submits the SRIS and BOMS association

    4. Send payment request - triggered when user submits the SRIS and BOMS association. (In openIMIS we need to register the notification to get payment information for Payment BB)

    Data input and output

    NB! All additional backround data that is required for minimum data exchange between BB (RequestID, ResponseID, SourceBBID,….etc.) should be included to the input and output (marked as ……)

    Data input

    Data output

    GovStack API spec

    • User unique ID

    • User role ?

    • Citizen ID (personal ID)

    • First name

    • Last name

    • Birth Date

    • Gender

    • Region

    • District

    • Municipality

    • Village

    • …..

    • Citizen ID (Beneficiary data)

    • Reference ID the the social registry program BOMS

    • Payment account details

    • Payment amount

    • Payment due date

    • ….

    https://govstack.gitbook.io/bb-registration/7-service-apis

    OpenIMIS resources

    Description

    Input

    OpenIMIS API spec

    User login

    User/Civil servant logs in. To create new record the user must have certain role

    User ID

    Login:

    Provide Citizen personal data

    Civil servant opens the registration form to fill the beneficiary registration form. Civil Servant enters citizens personal ID. Citizens personal data is pulled from the CR and form filled automatically

    Citizen ID

    openIMIS citizen/patient API:

    Provide Benefit program details (Product details)

    (Programm ID & Name):

    1. swagger GET: https://dev-mssql.s1.openimis.org/api/api_fhir_r4/docs/swagger/#/api_fhir_r4/api_fhir_r4_InsurancePlan_list

    2. FHIR IG: http://fhir.openimis.org/StructureDefinition-openimis-insurance-plan.html

    Request Beneficiary enrollment

    Civil Servant enrolls beneficiary

    New beneficiary record is created and related to suitable benefit program (product) to the OpenIMIS

    Citizen ID

    Program ID (in OpenIMIS Product ID)

    openIMIS API (contract)

    Register beneficiary
    fhir
    /StructureDefinition-openimis-invoice-bill.htmlEnroll beneficiary: https

    https://fhir.openimis.org/usecase-enrollment.html

    Notify payment BB of new payment request

    Citizen ID

    Program ID (in OpenIMIS Product ID)

    Payment amount

    Payment due date

    In OpenIMIS notification setup must be done to send out the payment

    https://fhir.openimis.org/StructureDefinition-openimis-invoice-bill.html ?