Versions Compared

Version Old Version 15 New Version 16
Changes made by

Heidi Kuum (Deactivated)

Heidi Kuum (Deactivated)

Saved on

Key

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

...

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

DB

Data

login

Users

  • User unique ID

  • Name

  • Last name

  • Role

  • Region (address)

  • District (address)

CR - Citizen Registry

openIMIS API:

  • Swagger:

    • FHIR IG: http://fhir.openimis.org/StructureDefinition-openimis-patient.html

    • UID - system ID generated by MOSIP

    • ID (personal ID)

    • First name

    • Last name

    • Birth Date

    • Gender

    • Region

    • District

    • Municipality

    • Village

    SRIS - Social Registry Information System

  • openIMIS API (Programm ID & Name):

    • openIMIS API (contract)

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

    • FHIR IG: http://fhir.openimis.org/StructureDefinition-openimis-contract.html

    • Candidate ID (personal ID)

    • Occupation

    • E-mail

    • Program ID

    • Program name

    • Status

    • (Banc Account no) - openIMIS does not include this field - organisational organizational discussion needed on where banking information needs to be stored. It can be added to some other field to provide this data to Payment BB

    BOMS - Beneficiary Operations Management System

    We need to register the notification to get payment data

    • Program/Product ID

    • Citizen ID (Beneficiary)

    • Benefit amount (coming with the product)

    • Benefit due date

    • ….

    IFMS - Integrated Finance Management Information System

    • Personal ID (Citizen)

    • Bank Account

    ...

    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

    Data input

    Data output

    Sandbox API spec

    • User unique ID

    • User role ?

    • Citizen ID (personal ID)

    • First name

    • Last name

    • Birth Date

    • Gender

    • Region

    • District

    • Municipality

    • Village - must be available in OpenIMIS master data

    • …..

    • Citizen ID (Beneficiary data)

    • Reference ID the the social registry program BOMS

    • Payment account details

    • Payment amount

    • Payment due date

    • ….

    OpenIMIS resources

    Description

    Input

    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
    .htmlhttps://fhir.openimis.org/usecase-enrollment

    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 ?