To learn more about Referral Reconciliation, click here. Link to the Pub Package:

The referral reconciliation feature enables the user to track referrals made by on-field health workers to different health facilities digitally via the Digit HCM app capturing all the cases of:

• Beneficiary being referred

• Referral details of the beneficiary

• Reason for referrals and their diagnosis

• Based on the diagnosis, further details, if applicable

Role

• HEALTH_FACILITY_WORKER

Getting Started

To use this package, add the following dependency to your pubspec.yaml file:

dependencies:
  referral_reconciliation: ^latest
  digit_scanner: ^latest

Integrating with the HCM Application

1. To integrate this package with the HCM Application, run the main function located in health-campaign-field-worker-app/tools/referral_reconciliation_imports.dart.

   • This will automatically add the necessary imports, mapper initializers, route config, setting initial data, and repository initialization to the required files.

2. Make sure you are on the path apps/health_campaign_field_worker_app and run the command:

dart run build_runner build --delete-conflicting-outputs

This adds a package route to the main router.gr.dart

1. Install the application and you should have referral reconciliation integrated into your base app.

By following these steps, you can successfully integrate and use the Referral Reconciliation module within your application.

Sequence Diagram

As a part of the 1.4 release, we have extracted the features of the Frontline Worker's App as individual packages:

• Registration & Delivery Package

• Referral Reconciliation Package

• Inventory Management Package

• Attendance Management Package

• DIGIT Scanner Package

• DIGIT Showcase Package

• Digit Data Model Package

To learn more about Attendance Management, click here.

Link to the Pub Package:

Role

• SUPERVISOR

Features

• Attendance Pages: The package includes several pages like mark_attendance.dart, manage_attendance.dart, and session_select.dart that provides the user interface for managing attendance.

Getting Started

To use this package, add the following dependency to your pubspec.yaml file:

dependencies:
  attendance_management: ^latest

Integrating with the HCM Application:

1. To integrate this package with the HCM application, run the main function located in health-campaign-field-worker-app/tools/attendance_management_imports.dart.

   • This will automatically add the necessary imports, mapper initializers, route config, setting initial data, and repository initialization to the required files.

2. Now make sure you are on the path apps/health_campaign_field_worker_app and run the command:

dart run build_runner build --delete-conflicting-outputs

This adds a package route to the main router.gr.dart

1. Navigate to the project bloc since we need to fetch registers and attendee data after login:

final RemoteRepository<AttendanceRegisterModel, AttendanceRegisterSearchModel>
  attendanceRemoteRepository;
final LocalRepository<AttendanceRegisterModel, AttendanceRegisterSearchModel>
  attendanceLocalRepository;
final LocalRepository<AttendanceLogModel, AttendanceLogSearchModel>
  attendanceLogLocalRepository;
final RemoteRepository<AttendanceLogModel, AttendanceLogSearchModel>
  attendanceLogRemoteRepository;

1. Next, navigate to the line where the project staff search is written, and add the below code in the try-catch where we check the role and fetch attendance data:

if (context.loggedInUserRoles
            .where(
              (role) => role.code == RolesType.districtSupervisor.toValue(),
            )
            .toList()
            .isNotEmpty) {
          final individual = await individualRemoteRepository.search(
            IndividualSearchModel(
              userUuid: [projectStaff.userId.toString()],
            ),
          );
          final attendanceRegisters = await attendanceRemoteRepository.search(
            AttendanceRegisterSearchModel(
              staffId: individual.first.id,
              referenceId: projectStaff.projectId,
            ),
          );
          await attendanceLocalRepository.bulkCreate(attendanceRegisters);

          for (final register in attendanceRegisters) {
            if (register.attendees != null &&
                (register.attendees ?? []).isNotEmpty) {
              try {
                final individuals = await individualRemoteRepository.search(
                  IndividualSearchModel(
                    id: register.attendees!
                        .map((e) => e.individualId!)
                        .toList(),
                  ),
                );
                await individualLocalRepository.bulkCreate(individuals);
                final logs = await attendanceLogRemoteRepository.search(
                  AttendanceLogSearchModel(
                    registerId: register.id,
                  ),
                );
                await attendanceLogLocalRepository.bulkCreate(logs);
              } catch (_) {
                emit(state.copyWith(
                  loading: false,
                  syncError: ProjectSyncErrorType.project,
                ));

                return;
              }
            }
          }
        }

1. Make sure you are on the path apps/health_campaign_field_worker_app and run the command:

dart run build_runner build --delete-conflicting-outputs

This adds a package route to the main router.gr.dart

By following these steps, you'll successfully integrate and can use attendance module within your application.

Sequence Diagram

To known more about Inventory Management, click here.

Link to the Pub Package:

Role

• DISTRIBUTOR, WAREHOUSE_MANAGER

Features

• Manage Stocks: Receipt, issued, returned, damaged, and loss of stocks.

• Stock Reconciliation: Reconcile the stock data.

• View Reports: View the reports of the stocks.

Getting Started

To use this package, add the following dependency to your pubspec.yaml file:

dependencies:
  inventory_management: ^latest
  digit_scanner: ^latest

Integrating with the HCM Application:

1. To integrate this package with the HCM Application, run the main function located in health-campaign-field-worker-app/tools/inventory_management_imports.dart.

   • This will automatically add the necessary imports, mapper initializers, route config, setting initial data, and repository initialization to the required files.

2. Make sure you are on the path apps/health_campaign_field_worker_app and run the command:

   Copy

   dart run build_runner build --delete-conflicting-outputs

   This adds a package route to the main router.gr.dart

3. Install the application and you should have Inventory Management integrated into your base app.

By following these steps, you can successfully integrate and use the Inventory Management module within your application.

Sequence Diagram

Link to the Pub Package:

The showcase widget is a wrapper widget that provides a way to highlight or showcase a widget. It is useful for highlighting a widget in a list of widgets or providing functionality to provide visual help to understand the widget's functionality.

Features

• Provides a showcase or highlight of the wrapped widget:

Getting Started

To use the digit_showcase package, add the following dependency to your pubspec.yaml file:

dependencies:
  digit_showcase: ^latest

Wrap the top layer of your widget tree with the showcase widget:

ShowcaseWidget(
enableAutoScroll: true,
builder: Builder(
builder: (context) {}
);

Provide localisation for the showcase widget:

final date = ShowcaseItemBuilder(
    messageLocalizationKey: i18.showcase_date.date,
  );

Now use .buildWith to build the showcase widget:

date.buildWith(child: Text('Date'));

To learn more about Registration and Delivery, click here. Link to the pub package:

Role

• DISTRIBUTOR

Features

• Register new households and individuals.

• Search existing households and individuals.

• Update details for existing households and individuals.

• Record service delivery of healthcare interventions to households and individuals for a single round campaign.

• Auto-calculation of resources to be delivered to a household or individuals based on the configured rule.

Getting Started

To use this package, add the following dependency to your pubspec.yaml file:

dependencies:
  registration_delivery: ^latest
  digit_scanner: ^latest

Integrating with the HCM Application:

1. To integrate this package with the HCM Application, run the main function located in health-campaign-field-worker-app/tools/registration_delivery_imports.dart.

   • This will automatically add the necessary imports, mapper initializers, route config, setting initial data, and repository initialization to the required files.

2. Make sure you are on the path apps/health_campaign_field_worker_app and run the command:

dart run build_runner build --delete-conflicting-outputs

This adds a package route to the main router.gr.dart

1. Install the application and you should have Registration and Delivery integrated into your base app.

By following these steps, you can successfully integrate and use the egistration and delivery module within your application.

During boundary selection, if you need to downsync registration-delivery-related data, include the below code in the project_beneficiaries_downsync file:

final LocalRepository<HouseholdModel, HouseholdSearchModel>
  householdLocalRepository;
final LocalRepository<HouseholdMemberModel, HouseholdMemberSearchModel>
  householdMemberLocalRepository;
final LocalRepository<ProjectBeneficiaryModel, ProjectBeneficiarySearchModel>
  projectBeneficiaryLocalRepository;
final LocalRepository<TaskModel, TaskSearchModel> taskLocalRepository;
final LocalRepository<SideEffectModel, SideEffectSearchModel>
  sideEffectLocalRepository;
final LocalRepository<ReferralModel, ReferralSearchModel>
  referralLocalRepository;

Next, find this method in the same file networkManager.writeToEntityDb and the below repositories:

householdLocalRepository,
householdMemberLocalRepository,
projectBeneficiaryLocalRepository,
taskLocalRepository,
sideEffectLocalRepository,
referralLocalRepository,

With the above changes, you will enable the down sync of registration and delivery data.

Link to the Pub Package:

How to Use the Scanner Package

To use the digit_scanner package, add the following dependency to your pubspec.yaml file:

dependencies:
  digit_scanner: ^latest

Initialise DigitScannerBloc Provider

To initialise the DigitScannerBloc provider in your application, add the following code:

BlocProvider(
                create: (_) {
                  return DigitScannerBloc(
                    const DigitScannerState(),
                  );
                },
              ),

Clear the Scanner State

To clear the scanner state, use the following code:

context.read<DigitScannerBloc>().add(
    const DigitScannerEvent.handleScanner(),
);

Navigate to the DIGIT Scanner Page

To navigate to the Digit Scanner page, use this code snippet:

context.router.push(DigitScannerRoute(
                              quantity: 1, // Max no. of codes to be scanned
                              isGS1code: false, // Set Flag to true for scanning GS1 barcode
                              singleValue: true, // Set Flag to false for scanning multiple codes
                            ));

Wrap the DigitScannerListener or DigitScannerBuilder

Wrap the DigitScannerListener or DigitScannerBuilder in your widget tree wherever you need to read the scanned codes from the scanner state:

BlocListener<DigitScannerBloc, DigitScannerState>(
                  listener: (context, scannerState) {
                  if (scannerState.qrCodes.isNotEmpty) {
                  //
                  }
                  },
                  child: BlocBuilder<DigitScannerBloc, DigitScannerState>(
                  builder: (context, scannerState) {
                  if(scannerState.qrCodes.isNotEmpty){
                  return Text(scannerState.qrCodes.last); ///Get the scanned codes after scanning from the scanner State
                  }
                  else {
                  return Container();}
                  }
                  ));

Find out about usage at the example implementation.

Link to the Pub Package:

The digit_data_model package is a comprehensive data modeling library for the project. It defines various classes, enums, and functions used throughout the project. The package is written in Dart and is primarily used in Flutter applications.

Features

• Data Models: The package provides a set of predefined data models like DataModel, EntityModel, EntitySearchModel, AdditionalFields, AdditionalField, ClientAuditDetails, AuditDetails, etc. These models are used to structure the data in the project.

• Model Provider: The package includes a ModelProvider abstract class that can be implemented to provide a list of models. It also includes a ModelProviderRegistry class to register and retrieve all model providers.

• Data Model Type Enum: The package defines a DataModelType enum that represents the different types of data models in the project.

• Mapping Annotations: The package uses the dart_mappable package to generate mapping code for the classes. This helps in converting the data models to and from JSON.

• Data Repositories: The package provides abstract classes for data repositories, DataRepository, RemoteRepository, and LocalRepository, which can be extended to create repositories for different data models. It also includes error handling with InvalidApiResponseException.

• Sql Store: The package includes a SqlStore class that can be used to store data in a SQLite database.

Here are the key features it provides to other packages:

• Database Connection: It provides a connection to the SQLite database. This connection is opened when the database is first accessed.

• Table Definitions: It defines the tables in the database. These tables correspond to various entities in the project.

• Database Operations: It provides methods for querying and manipulating the data in the tables. These methods can be used to perform CRUD (Create, Read, Update, Delete) operations on the data.

• Schema Version: It provides the schema version of the database. This can be used to handle database migrations.

• Drift Integration: It uses the Drift package for interacting with the SQLite database. This provides a reactive persistence library for Flutter and Dart.

Getting Started

To use this package, add the following dependency to your pubspec.yaml file:

dependencies:
  digit_data_model: ^latest

Integrating with the HCM Application

To integrate this package with the HCM Application, run the main function located in health-campaign-field-worker-app/tools/digit_data_model_imports.dart.

This will automatically add the necessary imports, mapper initializers, and repository initializations to the required files.

Below are some examples of how you can use this package:

• Extend the EntityModel or `EntitySearchModel class and implement the required methods:

class ExampleSearchModel extends EntitySearchModel {
  ExampleSearchModel({
    required this.employeeId,
    required this.attendanceDate,
    required this.status,
  });
}

 class ExampleAdditionalFields extends AdditionalFields {
  ExampleAdditionalFields({
    required this.field1,
    required this.field2,
  });
}

• Extend the `LocalRepository` class and implement the required methods:

class ExampleLocalRepository
        extends LocalRepository<ExampleModel, ExampleSearchModel> {
    ExampleLocalRepository(super.sql, super.opLogManager);
    }

• Extend the `RemoteRepository` class and implement the required methods:

 class ExampleRemoteRepository
        extends RemoteRepository<ExampleModel, ExampleSearchModel> {
  ExampleRemoteRepository(super.apiClient, super.opLogManager);
    }