Health
PlatformDomainAcademyDesign SystemFeedback
v1.0
v1.0
  • Introducing DIGIT Health Platform
    • Roadmap
  • Platform
    • Release Notes
      • Release Checklist
    • Platform Features
    • Architecture
      • Master Data Management Service (MDMS)
      • High Level Design
        • Health Campaign System High Level Design
        • Design Decision Log
      • Low Level Design
        • Registries
          • Individual
          • Household
          • Product
          • Facility
        • Services
          • Project
          • Stock
    • Technical Skillset & Pre-requisites
    • Installation
      • Setup Requirements
      • Supported Clouds
    • Configuration
      • Localisation Keys
    • Development Guide
    • Source Code
    • DHIS2 to DIGIT Integration
      • DHIS2-DIGIT Field Mapping
  • Products
    • Health Campaign Management
      • Frontline Worker's App
        • User Personas
        • Features
        • User Interface Design
          • User Management
          • Complaints Management
          • Supervision Flow
          • Beneficiary Registration
          • Service Delivery
          • Inventory Management
          • User Login
        • HCM App User Manual
          • Language Selection
          • Login
          • Forgot Password
          • Project Selection
          • Beneficiary Registration
          • Delivery Intervention
          • Stock Management
          • Checklist
        • Test Cases
        • Functional Specifications
        • Field App Architecture
        • Installation
          • APK Installation
        • Configuration
          • HCM Configuration
            • Individual Registry
            • Household Registry
            • Product Registry
            • Facility Registry
            • Stock & Inventory
            • Project Services
            • Complaints
              • QA Sign-Off
                • Test Cases
            • User Management
              • QA Sign-Off
          • HCM Master Promotion Guide
        • Release Notes
          • Success Metrics
        • Product Sign-off
        • Architect Sign-off
          • Health UAT API Execution Report
          • Performance Report
        • QA Sign-off
        • Products Requirement Documents (PRDs)
          • User Management
          • Complaints Management
          • Supervision Flow
          • Role Action Mapping
          • Beneficiary Registration
          • Service Delivery
          • Inventory Management
          • User Login
      • Campaign Management Dashboard
        • Features
        • User Stories
        • User Interface Design
        • Dashboard User Manual
        • Test Cases
        • Installation
        • Configuration
          • Dashboard UI Enhancements
          • HCM Dashboard Master Promotion Guide
        • Release Notes
          • UX Audit
          • PM Audit
        • Product Sign-Off
        • Architect Sign-Off
        • QA Sign-Off
        • Product Requirement Document (PRD)
  • Programme
    • Standard Operating Procedures (SOPs) and Plans
      • SOP for Helpdesk Support
      • User Management SOP
        • Master Data Collection Template
          • Boundary Hierarchy
          • Boundary Data Specs
          • System User Setup
          • Facility
          • Product
      • Master Data Management SOP
      • Training Plan
      • Field Test Plan
      • Programme Roll-Out Plan
      • Change Management Strategy
      • UAT Plan
        • UAT 1
          • UAT 1 Test Scenarios
          • UAT Test Cases
            • Registration & Distribution
            • Inventory Flow
            • Supervision
          • User Acceptance Test Report
            • Plan Dates
        • UAT 2
          • UAT 2 SOP
          • UAT 2 Test Scenarios
          • UAT Observations
            • Registration and Distribution
            • Inventory Flow
            • Supervision
            • General Feedback
          • UAT Feedback Form: SUS
          • UAT Feedform Form: Process
    • Monitoring and Evaluation (M&E) Tools
    • Implementation Checklist
    • DIGIT Pre-Training Tutorials
Powered by GitBook

https://creativecommons.org/licenses/by/4.0/

On this page
  • Overview
  • User actions
  • API details

Was this helpful?

Export as PDF
  1. Products
  2. Health Campaign Management
  3. Frontline Worker's App
  4. HCM App User Manual

Beneficiary Registration

PreviousProject SelectionNextDelivery Intervention

Last updated 2 years ago

Was this helpful?

Overview

Beneficiary registration involves the registration of households and individuals using the HCM application. When field, and district supervisors navigate to the home screen, the beneficiaries button is visible to them.

File Path :

User actions

On this page, the following actions can be performed:

  • A user can register a new household only after attempting a search.

  • A user has to click on the "Register New Household" button to register a household.

  • File Path :

  • After the user clicks on "Register New Household", the page navigates to the "Household Location" page.

  • File Path :

  • The "Administrative Area" is the only mandatory field. "Address Line 1", "Address Line 2", 'Landmark' and "Postal Code" are optional fields.

  • File Path :

  • Clicking on the 'Next' button will take the user to the "Household Details" page where the number of members living in the household can be registered.

  • File Path :

  • Clicking the 'Next' button will take the user the "Individual details" screen.

  • The first individual added will be the "Head of Household" by default.

  • The name, ID type, and ID number fields are mandatory. Users can enter the date of birth or their age. The date birth will take precedence over age.

  • When the user clicks on the submit button, a popup appears asking for confirmation.

  • If the user clicks on ‘Submit’, the household is registered and a confirmation screen is displayed.

  • The user can click on the "Back to Search" button for editing the household or register new household fields.

  • Click on the open card to navigate to the detailed page of the household.

  • There is an "Edit Household" button for editing household details, which navigates the user to the household location screen. The service delivery status is present below the household’s name followed by the administrative area and the number of members.

  • There are cards for each member, starting from the household head. The card consists of the ‘Edit’ button for individual-level actions.

  • For adding new members to the household, there is the "Add Member" button below the member cards, which navigates the user to the "Individual Details" screen.

  • At the bottom, the "Deliver Intervention" button is present which navigates the user to the update delivery screen.

API details

End Point
Request Method
Request Info

/individual/v1/bulk/_create

POST

/individual/v1/bulk/_update

POST

/individual/v1/_search

POST

/household/v1/bulk/_create

POST

/household/v1/bulk/_update

POST

/household/v1/_search

POST

/household/member/v1/bulk/_create

POST

/project/beneficiary/v1/bulk/_create

POST

File Path :

File Path :

File Path :

{
  "RequestInfo": {
    "authToken": "string"
  },
  "Individuals": [
    {
      "tenantId": "tenantA",
      "clientReferenceId": "string",
      "name": {
        "givenName": "string",
        "familyName": "string",
        "otherNames": "string"
      },
      "dateOfBirth": "14/10/2022",
      "gender": "MALE",
      "bloodGroup": "string",
      "mobileNumber": "string",
      "altContactNumber": "string",
      "email": "user@example.com",
      "address": [{}
      ],
      "rowVersion": 0
    }
  ]
}
Parameter content type
{
  "RequestInfo": {
    "authToken": "string"
  },
  "Individuals": [
    {
      "tenantId": "tenantA",
      "clientReferenceId": "string",
      "name": {
        "givenName": "string",
        "familyName": "string",
        "otherNames": "string"
      },
      "dateOfBirth": "14/10/2022",
      "gender": "MALE",
      "bloodGroup": "string",
      "mobileNumber": "string",
      "altContactNumber": "string",
      "email": "user@example.com",
      "address": [{}
      ],
      "rowVersion": 0
    }
  ]
}
Parameter content type
{
  "RequestInfo": {
    "authToken": "string"
  },
  "Individual": {
    "id": [
      "string"
    ],
    "clientReferenceId": [
      "string"
    ],
  }
}
{
  "RequestInfo": {
    "authToken": "string"
  },
  "Households": [
    {
      "tenantId": "tenantA",
      "clientReferenceId": "string",
      "memberCount": 4,
      "address": {
        }
      },
      "additionalFields": {
      },
      "rowVersion": 0
    }
  ]
}
{
  "RequestInfo": {
    "authToken": "string"
  },
  "Households": [
    {
      "id":"string",
      "tenantId": "tenantA",
      "clientReferenceId": "string",
      "memberCount": 4,
      "address": {
        }
      },
      "additionalFields": {
      },
      "rowVersion": 0
    }
  ]
}
{
  "RequestInfo": {
    "authToken": "string"
  },
  "Household": {
    "id": [
      "string"
    ],
    "clientReferenceId": [
      "string"
    ],
    "boundaryCode": "string"
  }
}

  "RequestInfo": {
    "authToken": "string"
  },
  "HouseholdMembers": [
    {
      "householdClientReferenceId": "string",
      "individualClientReferenceId": "string",
      "isHeadOfHousehold": false,
      "tenantId": "tenantA",
      "additionalFields": {
      },
      "rowVersion": 0
    }
  ]
}
{
  "RequestInfo": {
    "authToken": "string"
  },
  "ProjectBeneficiaries": [
    {
      "clientReferenceId": "string",
      "tenantId": "tenantA",
      "projectId": "string",
      "beneficiaryId": "string",
      "beneficiaryClientReferenceId": "string",
      "dateOfRegistration": 1663218161,
      "additionalFields": {
      },
      "rowVersion": 0
    }
  ]
}
https://github.com/egovernments/health-campaign-field-worker-app/blob/master/apps/health_campaign_field_worker_app/lib/pages/beneficiary_registration/individual_details.dart
https://github.com/egovernments/health-campaign-field-worker-app/blob/master/apps/health_campaign_field_worker_app/lib/pages/acknowledgement.dart
https://github.com/egovernments/health-campaign-field-worker-app/blob/master/apps/health_campaign_field_worker_app/lib/pages/beneficiary/household_overview.dart
https://github.com/egovernments/health-campaign-field-worker-app/blob/master/apps/health_campaign_field_worker_app/lib/pages/home.dart
https://github.com/egovernments/health-campaign-field-worker-app/blob/master/apps/health_campaign_field_worker_app/lib/pages/search_beneficiary.dart
https://github.com/egovernments/health-campaign-field-worker-app/blob/master/apps/health_campaign_field_worker_app/lib/pages/beneficiary_registration/beneficiary_registration_wrapper.dart
https://github.com/egovernments/health-campaign-field-worker-app/blob/master/apps/health_campaign_field_worker_app/lib/pages/beneficiary_registration/household_location.dart
https://github.com/egovernments/health-campaign-field-worker-app/blob/master/apps/health_campaign_field_worker_app/lib/pages/beneficiary_registration/household_details.dart