Functional Specifications
Name of the field | Description | Mandatory or optional | Input | Validation | Need data from program/state |
---|---|---|---|---|---|
Campaign type name | Name of the campaign type. For example, LLIN 2022, IRS 2023. | Mandatory | User | | Yes |
Code | Unique code for the campaign type. | Mandatory | User | | Yes |
Disease group | Disease(s) targeted by the campaign. For example, malaria, polio. | Mandatory | User | | Yes |
Beneficiary type | Specify the beneficiaries for the campaign. For example, household, individual, structure. | Mandatory | User | | Yes |
Eligibility criteria | Specify the criteria to determine if beneficiaries are eligible for the campaign. For example, universal campaign, age-based, gender-based, etc. | Mandatory | User | | Yes |
Task procedure [ ] | Capture the details regarding the tasks to be carried out as a part of the campaign. For example, details regarding drug administration/resource distribution, that is, 1 bed net for 2 individuals, 1 tablet for individuals under the age of 5, etc. | Mandatory | User | | Yes |
Delivery mode | The way in which the campaign intervention will be delivered. For example, fixed, mobile, door-to-door. | Mandatory | User | | Yes |
Campaign product [ ] | When does the campaign start? It is set up by the national programme manager. | Mandatory | User | | Yes |
Product type | The type of product being used. For example, drug, spray, vaccine, bed net, IEC material. | Mandatory | User | | Yes |
Product name | Name of the product being used. For example, Ivermectin, Paracetamol, etc. | Mandatory | User | | Yes |
Product manufacturer | Name of the manufacturer. For example, Merck, Johnson & Johnson, etc. | Mandatory | User | | Yes |
Product variant | Capture details about the product variants and the SKU's being used. For example, Para 200 mg. | | | Ensure that the product is created before product variants and that the SKU's are defined. The system must not allow the creation of a product variant without a parent product. | Yes |
SKU | The stock-keeping unit code of the product. For example, Para 200 mg and Para 250 mg. | Mandatory | User | There must be at least one SKU assigned to a product: For a product with only 1 variant, it will be product "Bed net", with SKU "Bed net". | Yes |
Variant | Capture the variant of the products. Products can vary based on shape, size, colour, or other characteristics. For example, Para 200 mg, pack of 5 tablets, Para 250 mg, pack of 10 tablets. | Mandatory | User | | Yes |
Base unit variant | Capture details if the variant is the base unit used for record-keeping of the product's inventory. It is useful to filter variants applicable for tasks within a project. For example, base unit for bed net is an individual bed net or a base of 50 nets. | Mandatory | User | | Yes |
Name of the field | Description | Mandatory | Input | Validation | Comments | Need data from program/state |
---|---|---|---|---|---|---|
Address | | Mandatory | User | | | Yes |
Door number | House number or door number. | O | User | | | |
Latitude | Latitude of the address. | O | System | | | |
Longitude | Longitude | O | System | | | |
Location accuracy | Accuracy of the address, latitude and longitude, in metres. | O | System | | | |
Type | Type of address: permanent, correspondence, other. | R | User | | | |
| | | | | | |
Address Line 1 | Apartment, block, street of the address. | O | User | | | |
Address Line 2 | Locality, area, zone, ward of the address. | O | User | | | |
Landmark | Additional landmark to help locate the address. | O | | | | |
City | City of the address. This can be represented by the tenant ID itself. | R | User | | | |
Pincode | Pin code of the address. | R | User | | Indian pin codes will usually be all numbers. | |
Building name | Name of the building. | O | User | | | |
Street | Street name. | O | User | | | |
Locality | | | | | | |
Start date | Campaign start date. | Mandatory | User | | | Yes |
End date | Campaign end date. | Mandatory | User | | | Yes |
Targets | | | | | Targets will be provided after the micro-planning exercise | Yes |
Beneficiary type | | Mandatory | User | | | Yes |
Baseline | The total number of individuals/ households. | Mandatory | User | | | Yes |
Target number | | | | | | |
Department | Project department | Mandatory | User | | | Yes |
Description | Description of the project. | Mandatory | User | | | Yes |
| | | | | | |
Set up tasks to be carried out as a part of the campaign | | | | | | |
Tasks | | | | | | |
Resources [ ] | Array of resources that are a part of the campaign. | | | | | |
Task resources | | | | | | |
Delivery comment | Capture comments regarding the delivery of campaign resources. | Mandatory | User | | The final list of reasons to be given by the state/programme during impel | Yes |
Status | Status of the task. For example, delivered, not delivered, partial delivery, refused, insufficient, etc. | Mandatory | User | | The final list of tasks' status to be given by the state/program during impel. | Yes |
Name of the field | Description | Mandatory | Input | Data type | Minimum length | Maximum length | Validation | Comments | Need data from program/state |
---|---|---|---|---|---|---|---|---|---|
| Stock details | | | | | | | | |
Product variant ID | The product variant that is being transferred. | Mandatory | User | String | 2 | 64 | | | No |
Quantity | The number, or quantity, or the count of units of the product variant that are being transacted. | Mandatory | User | Integer | | | | Outputs from the micro-plan. | Yes |
Reference ID | The reference entity for which the stock transfer is taking place. | Mandatory | User | String | | | | | No |
Reference ID type | The entity type that the reference ID refers to. For example, 'Project'. | Mandatory | User | String | 2 | 64 | String | | No |
Transaction type | The kind of transaction that is taking place: Received, dispatched. | Mandatory | User | String | | | | | No |
Transaction reason | The status of the transaction: Received, returned, loss. | Mandatory | User | String | | | | | No |
Transacting party ID | The ID of the party from/to which the product variant stock is being transferred. | Mandatory | User | String | 2 | 64 | | | No |
Transacting party type | The type of entity that the transacting party ID refers to. For example, 'Warehouse'. | Mandatory | User | String | 2 | 64 | | The list of warehouses/facilities and their type to be provided by the program/state during impel. | No |
| Stock reconciliation | | | | | | | | |
Physical count | The count of units of the product variant as a result of a physical count. | Mandatory | User | Integer | | | | | No |
Calculated count | The count of units of the product variant that is calculated from the stock movements. | Mandatory | User | Integer | | | | | No |
| Facility details | | | | | | | | |
Facility ID | The ID of the facility where the stock of the product variant is being transferred. | Mandatory | System | String | 2 | 64 | | List of warehouses/facilities and their type to be provided by the programme/state during impel. | No |
Facility name | The administration name of the facility. | Mandatory | User | String | 2 | 2000 | | | Yes |
Is it permanent? | Whether the facility is permanent or not. | Mandatory | User | Boolean | | | | | Yes |
Usage | The purpose of the facility: Storage warehouse, medical facility, sewage treatment plant. | Mandatory | User | Dropdown | | | | | Yes |
Storage capacity | Physical storage capacity of the facility in cubic metres. | Optional | User | Numeric | | | | | Yes |
Address | | Mandatory | User | String | | | | | |
Name of the field | Description | Mandatory | Input | Data type | Minimum length | Maximum length | Need data from program/state |
---|---|---|---|---|---|---|---|
Serial number | The sequence number for the list. | | | | | | |
Boundary hierarchy type | The meaningful name to define a group of boundaries defined to perform one function. | Mandatory | MDMS | String | 2 | 256 | Yes |
Code | A code is used to identify a certain classification of the type of boundary hierarchy. | Mandatory | MDMS | String | 2 | 64 | Yes |
Description | | Mandatory | MDMS | String | 2 | 256 | Yes |
Name of the field | Description | Mandatory | Input | Data type | Minimum length | Maximum length | Validation | Comments | Need input from program/state |
---|---|---|---|---|---|---|---|---|---|
| Household details | | | | | | | | |
ID | Unique system-generated GUID. | Mandatory | System | String | 2 | 64 | | | No |
Client reference ID | Unique client-generated GUID. | Mandatory | Client generated | String | 2 | 64 | | | No |
Household ID | The ID of the household. | Mandatory | User/system | String | 2 | 64 | | | No |
Member count | The total number of individuals in a household. | Mandatory | User | Numeric | 1 | 1000 | | A household can be created only when it has at least 1 individual assigned to the household. | |
Individual ID | The ID of the individual | Mandatory | User/system | String | 2 | 64 | | | |
| Individual details | | | | | | | | |
ID | Unique system-generated GUID. | Mandatory | System | String | 2 | 64 | | | No |
Client reference ID | Unique client-generated GUID. | Mandatory | Client generated | String | 2 | 64 | | | No |
Name of the individual | Name of the individual being registered as the given name, family name, and other names. | Mandatory | User | String | 2 | 200 | | | No |
Head of the household | Capture if the registered individual is also the head of the household. | Mandatory | User | Boolean | | | | | No |
Type of ID | Capture type of ID. | Mandatory | User | Array | | | | The list of IDs to be given by the programme/state during impel. If no forms of ID are allowed, then a system generated ID is to be selected for the ID type. | |
Identity number | Capture ID number belonging to the beneficiary. | Mandatory | User | String | 2 | 64 | If the individual has no forms of ID, then a unique system generated ID must be assigned. | Validations for specific ID types to be built during impel depending on the list of acceptable IDs. | |
Date of birth | Date of birth in DD/MM/YYYY format. | Optional | User | String | | | The DoB cannot be in the future. Error Message: DoB cannot be in the future. | | |
Age | The age of the individual. | Optional | User | Integer | | | If DoB is not known, allow the user to enter his/her age. | | |
Contact number | The mobile number of the registered individual. | Optional | User | Integer | | | | Any validations on mobile numbers to be built during impel as per country-specific requirements. | |
Gender | Gender of the registered individual. | Optional | User | String | | | | A product allows three types of genders: male, female and other. Adding/deleting from this list to be done during impel in accordance with country-specific requirements. | |