---
title: mdlCodeMaps
summary: API reference for mdlCodeMaps.
status: draft
owner: SAIF
last_reviewed: 2026-07-24
library: SAIF.Business
reference_type: package
---

# mdlCodeMaps

`mdlCodeMaps` is a public module in `SAIF.Business.CodeMappings` that exposes cached reference-data maps for many SAIF business code tables and a small set of hard-coded enum/code translations.

## Purpose
- Loads business code tables such as claim type, claim status, jurisdiction, payment, reimbursement, and geographic lookup data into reusable map objects.
- Centralizes hard-coded mappings for values such as gender, payment transaction types, medically stationary flags, tax multipliers, leave types, and system types.
- Reuses cached module-level map instances and refreshes them on demand when callers pass the corresponding refresh flag.

## Context
- Namespace: `SAIF.Business.CodeMappings`
- Assembly/package: `SAIF.Business`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `GetEmailCode` | `Public Function GetEmailCode(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsEmailCodes` | Returns the cached email-code table loaded from `email_code`. |
| `GetAddressCode` | `Public Function GetAddressCode(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsAddressCodes` | Returns the cached address-code table loaded from `address_code`. |
| `GetPhoneCode` | `Public Function GetPhoneCode(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsPhoneCodes` | Returns the cached phone-code table loaded from `phone_code`. |
| `GetCustomerCode` | `Public Function GetCustomerCode(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsCustomerCode` | Returns the cached company-code table loaded from `company_code`. |
| `GetRelationshipCode` | `Public Function GetRelationshipCode(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsRelationshipCode` | Returns the cached company-person relationship table loaded from `relationship_code`. |
| `ETHNIC_GROUP_UNSPECIFIED` | `Public Const ETHNIC_GROUP_UNSPECIFIED As String = "7"` | Exposes the code constant used for the unspecified ethnic-group value. |
| `GetEthnicGroupCode` | `Public Function GetEthnicGroupCode(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsEthnicGroupCodes` | Returns the cached ethnic-group table loaded from `ethnic_group_code`. |
| `GetLanguagePrefernceCodeMap` | `Public Function GetLanguagePrefernceCodeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsLanguagePrefernceCodeMap` | Returns the language-preference map built from `cl_language_preference_code` and translated into `LanguagePrefernces` enum values. |
| `GetClaimTypeCodeMap` | `Public Function GetClaimTypeCodeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsClaimTypeCodeMap` | Returns the claim-type map built from localized `cl_claim_type_code` rows and mapped to `ClaimTypes`. |
| `GetClaimStatusCodeMap` | `Public Function GetClaimStatusCodeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsClaimStatusCodeMap` | Returns the claim-status map built from `Claim_Status_code` and `cl_claim_status_gcode` rows and mapped to `ClaimStatuses`. |
| `GetBenefitTypeMap` | `Public Function GetBenefitTypeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshBenefitTypes As Boolean = False) _ As clsBenefitTypeMap` | Returns the benefit-type map built from `cl_benefit_type_code` and mapped to `BenefitTypes`. |
| `GetJurisdictionCodeMap` | `Public Function GetJurisdictionCodeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsJurisdictionCodeMap` | Returns the jurisdiction map built from `cl_jurisdiction_code`, including federal flags and DOL authorization IDs. |
| `GetCountryCodeList` | `Public Function GetCountryCodeList(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsCountryCodeList` | Returns the country-code list built from `country_code`, including ISO alpha-3 codes. |
| `GetStateCodeList` | `Public Function GetStateCodeList(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsStateCodeList` | Returns the state-code list built from `all_states` rows whose NCCI state code falls between `01` and `54`. |
| `GetRelationshipToWorkerCodeMap` | `Public Function GetRelationshipToWorkerCodeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsRelationshipToWorkerCodeMap` | Returns the relationship-to-worker map built from `cl_relationship_to_worker_code`. |
| `GetClaimPersonTypeCodeMap` | `Public Function GetClaimPersonTypeCodeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsClaimPersonTypeCodeMap` | Returns the claim-person-type map built from `claim_person_code`. |
| `GetPaymentTransactionTypeMap` | `Public Function GetPaymentTransactionTypeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) _ As clsPaymentTransactionTypeMap` | Returns the hard-coded payment transaction type map for values such as `FA`, `SET`, `SDA`, `SA`, `TL`, `MA`, `ADJ`, `EAIP`, `LB`, and `LS`. |
| `GetPaymentCategoryMap` | `Public Function GetPaymentCategoryMap(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshPaymentCategories As Boolean = False) _ As clsPaymentCategoryMap` | Returns the payment-category map built from `cl_payment_category_code`. |
| `GetReimbursementProgramMap` | `Public Function GetReimbursementProgramMap(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshReimbursementPrograms As Boolean = False) _ As clsReimbursementProgramMap` | Returns the reimbursement-program map built from `cl_reimb_program_code`. |
| `GetClaimDecisionMap` | `Public Function GetClaimDecisionMap(ByVal inDPI As IDataPortalInfo, Optional ByVal ForceRefresh As Boolean = False) _ As clsClaimDecisionCodeMap` | Returns the claim-decision map built from `claim_decision_code`. |
| `GetClaimRequestTypeMap` | `Public Function GetClaimRequestTypeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal ForceRefresh As Boolean = False) _ As clsClaimRequestTypeCodeMap` | Returns the claim-request-type map built from `cl_request_type_code`. |
| `GetOwnMotionReasonsMap` | `Public Function GetOwnMotionReasonsMap(ByVal inDPI As IDataPortalInfo, Optional ByVal ForceRefresh As Boolean = False) _ As clsOwnMotionReasonsCodeMap` | Returns the own-motion-reason map built from `own_motion_reason_code`. |
| `GetGenderMap` | `Public Function GetGenderMap(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsGenderMap` | Returns the hard-coded gender map for `M`, `F`, and `U`. |
| `GetEaipCategories` | `Public Function GetEaipCategories(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsEaipCategories` | Returns the EAIP category table loaded from `eaip_expense_type_code`, including purchase flags and limits. |
| `GetRtwLoadCodes` | `Public Function GetRtwLoadCodes(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsRtwLoadCodes` | Returns the return-to-work load-code table loaded from `rtw_load_code`, including reporting rollup and location names. |
| `GetWagePeriodPayUnitCodes` | `Public Function GetWagePeriodPayUnitCodes(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) As clsWagePeriodPayUnitCodes` | Returns the wage-period pay-unit code table loaded from `cl_wage_period_pay_unit_code`. |
| `GetSettlementFullPartCodes` | `Public Function GetSettlementFullPartCodes(ByVal inDPI As IDataPortalInfo, Optional ByVal inRefresh As Boolean = False) _ As clsSettlementFullPartCodes` | Returns the settlement full/partial code table loaded from `cl_settlement_full_part_code`. |
| `GetMedicallyStationaryCodes` | `Public Function GetMedicallyStationaryCodes(Optional ByVal inRefresh As Boolean = False) _ As clsMedicallyStationaryCodes` | Returns the hard-coded medically stationary map for `Y` and `N` values. |
| `GetTaxMultiplierMap` | `Public Function GetTaxMultiplierMap() As clsTaxMultiplierMap` | Returns the hard-coded tax multiplier map for state, federal, and blank values. |
| `GetClaimFinancialTransTypeCodeMap` | `Public Function GetClaimFinancialTransTypeCodeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsClaimFinancialTransTypeCodeMap` | Returns the claim financial transaction type map built from `cl_financial_trans_type_code`. |
| `GetClaimCostCategoryCodeMap` | `Public Function GetClaimCostCategoryCodeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal refresh As Boolean = False) As clsClaimCostCategoryCodeMap` | Returns the claim cost-category map built from `cl_claim_cost_category_code`, including award, effective-date, group, and display metadata. |
| `GetLeaveCodeMap` | `Public Function GetLeaveCodeMap() As clsLeaveCodeMap` | Returns the hard-coded leave-type map for vacation, leave, training, and offline codes. |
| `GetSystemTypeMap` | `Public Function GetSystemTypeMap() As clsSystemTypeCodeMap` | Returns the hard-coded system-type map for `TITAN` and `THRDP`. |

## Behavioral notes
- Most module functions cache their map instance in a `Static` local and rebuild it only when the corresponding refresh flag is `True` or the cache is empty.
- `GetCodeTable(Of T)` centralizes the refresh-or-reuse behavior for the simpler database-backed table getters at the top of the module.
- Several maps are database-backed and populated immediately from the named code tables, while others are constructed entirely from hard-coded values in source.
- `GetCountryCodeList` and `GetStateCodeList` both insert a blank entry before loading database rows.

## Constraints and usage notes
- Database-backed getters require a valid `IDataPortalInfo` and access to the underlying code tables.
- Because cached map instances are shared through `Static` locals, refresh requests replace the shared cached object for subsequent callers.
- This page documents the module-level members of `mdlCodeMaps`; the many nested public map/info classes declared inside the module are separate public types and are not expanded here.

## Sources
- `Business\SAIF.Business\mdlCodeMaps.vb`