HR Benefits

The HR Benefits module enables organizations to manage the full lifecycle of employee benefit offerings from plan design and eligibility configuration to enrollment, life event changes, and cost administration. The module supports defining benefit plans with options and coverage levels, managing benefit providers and service agreements, configuring eligibility rules and waiting periods, establishing enrollment periods for open enrollment and new hires, processing benefit enrollments with elections and beneficiary designations, handling qualifying life event changes, administering contribution rates for employer and employee costs, tracking cost allocations across funds and departments, maintaining deduction codes for payroll integration, and processing benefit-related claims or reimbursements with effective dating, auditability, and structured benefit governance.

Typical use cases include open enrollment administration, new hire benefit setup, qualifying life event processing, beneficiary management for life insurance and retirement plans, benefit cost analysis and allocation, payroll deduction coordination, benefit claim processing, benefits compliance reporting, and benefits provider relationship management.

Using the Module

The module supports benefits administration from plan design through enrollment and cost management. Users can create and manage HR Benefit Plan records defining specific benefit offerings with plan names, plan years, HR Benefit Provider assignments, plan types and categories (medical, dental, vision, life insurance, disability, retirement, health savings account, flexible spending account, wellness, tuition assistance, employee assistance program), plan status, effective dates, Legal Authority and Compliance Framework references for regulatory compliance, parent plan relationships for dependent plans, and plan descriptions. HR Benefit Provider records store benefit carriers or administrators with provider names, provider types (insurance carrier, third-party administrator, retirement board, HMO, PPO, self-insured), Agreement references for service contracts, and provider contact information.

Benefit plan structure is defined through HR Benefit Option records representing selectable options within plans—PPO versus HDHP, basic versus premium coverage, investment fund choices—with option names, option descriptions, option codes, default selection indicators, and option status. HR Benefit Coverage Level records define coverage tiers (employee only, employee plus spouse, employee plus dependents, employee plus family, retiree, continuation coverage) with coverage level names, ordering sequences, coverage descriptions, and effective dates for pricing and eligibility determination. HR Benefit Plan Document records maintain plan-related documentation—summary plan descriptions, policy documents, regulatory filings, internal guidelines—with document types, document dates, document versions, and supporting document attachments.

Eligibility is managed through HR Benefit Eligibility Rule records defining participation conditions with rule names, eligibility criteria descriptions, employment type restrictions, Pay Grade or Personnel Type requirements, service duration thresholds, location requirements, bargaining unit specifications, and effective dates for reusable eligibility enforcement. HR Benefit Waiting Period records establish waiting period rules with period types, waiting period durations (days), effective dates for eligibility start calculations, and alignment options (first of month following eligibility).

Enrollment cycles are defined through HR Benefit Enrollment Period records representing enrollment windows with period names, period types (open enrollment, new hire enrollment, special enrollment, annual enrollment), start and end dates, enrollment deadlines, period status, and eligible employee populations. HR Benefit Enrollment records represent individual enrollments with persons, HR Benefit Plan references, HR Benefit Option selections, HR Benefit Coverage Level assignments, enrollment effective and termination dates, enrollment status (pending, active, terminated, cancelled), enrollment sources, waiver indicators for declined benefits, HR Benefit Enrollment Period linkages, HR Benefit Life Event references for mid-year changes, and HR Benefit Deduction Code assignments for payroll integration.

HR Benefit Election records capture detailed selections within enrollments—optional riders, add-ons, sub-options—with election descriptions, election amounts or values, election effective dates, and election status. HR Benefit Beneficiary records store beneficiary designations for plans requiring them with beneficiary persons or names, beneficiary types (primary, secondary, contingent), relationship descriptions, allocation percentages, designation priorities for sequencing, effective dates, addresses, dates of birth, and beneficiary status for life insurance and retirement plan administration.

Life event processing is supported through HR Benefit Life Event records documenting qualifying events—marriage, birth, adoption, divorce, death, loss of coverage—with life event types, event dates, reported dates, persons affected, event descriptions, supporting documentation, approval status, and qualifying event verification. HR Benefit Life Event Change records track specific enrollment modifications resulting from life events with original and new HR Benefit Option references, original and new HR Benefit Coverage Level references, change types, change effective dates, change request descriptions, approval workflow, and change status for mid-year enrollment adjustments.

Financial management is handled through HR Benefit Contribution Rate records defining employer and employee cost structures with HR Benefit Plan, HR Benefit Option, and HR Benefit Coverage Level references, effective dates, employer contribution amounts or percentages, employee contribution amounts or percentages, total premium amounts with currency support, contribution frequency (monthly, per pay period, annual), and rate structures supporting percentage-based or fixed-amount contributions with effective dating. HR Benefit Cost Allocation records define how employer costs are distributed across financial dimensions with HR Benefit Plan references, cost center or fund identifications, allocation percentages, effective dates, and allocation descriptions enabling split allocations for grant-funded or multi-entity cost management.

HR Benefit Deduction Code records map enrollments to payroll systems with deduction code identifications, deduction descriptions, HR Benefit Plan references, effective dates, deduction sequences, and payroll system integration identifiers. HR Benefit Claim records track internal benefit-related claims or reimbursements—tuition reimbursement, wellness reimbursement, dependent care—with claim numbers, claim types, claim dates, claimant persons, HR Benefit Enrollment references, claim amounts with currency support, claim status (submitted, under review, approved, denied, paid), approval workflow, payment dates, payment methods, and supporting documentation.

graph TD
  appbase_Agreement(Agreement)
  appbase_ComplianceFramework(Compliance Framework)
  appbase_Document(Document)
  appbase_HRBenefitBeneficiary(HR Benefit Beneficiary)
  appbase_HRBenefitClaim(HR Benefit Claim)
  appbase_HRBenefitContributionRate(HR Benefit Contribution Rate)
  appbase_HRBenefitCostAllocation(HR Benefit Cost Allocation)
  appbase_HRBenefitCoverageLevel(HR Benefit Coverage Level)
  appbase_HRBenefitDeductionCode(HR Benefit Deduction Code)
  appbase_HRBenefitElection(HR Benefit Election)
  appbase_HRBenefitEligibilityRule(HR Benefit Eligibility Rule)
  appbase_HRBenefitEnrollment(HR Benefit Enrollment)
  appbase_HRBenefitEnrollmentPeriod(HR Benefit Enrollment Period)
  appbase_HRBenefitLifeEvent(HR Benefit Life Event)
  appbase_HRBenefitLifeEventChange(HR Benefit Life Event Change)
  appbase_HRBenefitOption(HR Benefit Option)
  appbase_HRBenefitPlan(HR Benefit Plan)
  appbase_HRBenefitPlanDocument(HR Benefit Plan Document)
  appbase_HRBenefitProvider(HR Benefit Provider)
  appbase_HRBenefitWaitingPeriod(HR Benefit Waiting Period)
  appbase_LegalAuthority(Legal Authority)
  appbase_HRBenefitProvider --> appbase_Agreement
  appbase_HRBenefitPlan --> appbase_ComplianceFramework
  appbase_HRBenefitClaim --> appbase_Document
  appbase_HRBenefitEnrollment --> appbase_Document
  appbase_HRBenefitLifeEvent --> appbase_Document
  appbase_HRBenefitPlanDocument --> appbase_Document
  appbase_HRBenefitContributionRate --> appbase_HRBenefitCoverageLevel
  appbase_HRBenefitEnrollment --> appbase_HRBenefitCoverageLevel
  appbase_HRBenefitLifeEventChange --> appbase_HRBenefitCoverageLevel
  appbase_HRBenefitLifeEventChange --> appbase_HRBenefitCoverageLevel
  appbase_HRBenefitEnrollment --> appbase_HRBenefitDeductionCode
  appbase_HRBenefitBeneficiary --> appbase_HRBenefitEnrollment
  appbase_HRBenefitClaim --> appbase_HRBenefitEnrollment
  appbase_HRBenefitElection --> appbase_HRBenefitEnrollment
  appbase_HRBenefitLifeEventChange --> appbase_HRBenefitEnrollment
  appbase_HRBenefitEnrollment --> appbase_HRBenefitEnrollmentPeriod
  appbase_HRBenefitEnrollment --> appbase_HRBenefitLifeEvent
  appbase_HRBenefitLifeEventChange --> appbase_HRBenefitLifeEvent
  appbase_HRBenefitContributionRate --> appbase_HRBenefitOption
  appbase_HRBenefitEnrollment --> appbase_HRBenefitOption
  appbase_HRBenefitLifeEventChange --> appbase_HRBenefitOption
  appbase_HRBenefitLifeEventChange --> appbase_HRBenefitOption
  appbase_HRBenefitClaim --> appbase_HRBenefitPlan
  appbase_HRBenefitContributionRate --> appbase_HRBenefitPlan
  appbase_HRBenefitCostAllocation --> appbase_HRBenefitPlan
  appbase_HRBenefitCoverageLevel --> appbase_HRBenefitPlan
  appbase_HRBenefitDeductionCode --> appbase_HRBenefitPlan
  appbase_HRBenefitEligibilityRule --> appbase_HRBenefitPlan
  appbase_HRBenefitEnrollment --> appbase_HRBenefitPlan
  appbase_HRBenefitOption --> appbase_HRBenefitPlan
  appbase_HRBenefitPlan --> appbase_HRBenefitPlan
  appbase_HRBenefitPlanDocument --> appbase_HRBenefitPlan
  appbase_HRBenefitWaitingPeriod --> appbase_HRBenefitPlan
  appbase_HRBenefitPlan --> appbase_HRBenefitProvider
  appbase_HRBenefitPlan --> appbase_LegalAuthority

The HR Benefits module manages the full lifecycle of employee benefit offerings, from plan design and eligibility configuration to enrollment, life event changes, and cost administration. It allows organizations to define benefit plans, options, coverage levels, providers, and contribution structures, while enforcing eligibility rules and waiting periods. HR staff can manage open enrollment cycles, process new hire enrollments, handle qualifying life events (such as marriage or birth), maintain beneficiary records, and track benefit-related claims or reimbursements. The module also supports payroll integration through deduction codes and contribution rates, and enables financial oversight through cost allocation tracking. It is designed to support both public sector and commercial organizations with effective dating, auditability, and structured benefit governance.

Tables

HR Benefit Plan

Defines a specific benefit offering provided by the organization (e.g., Medical Plan A, Pension Plan, Basic Life Insurance), including plan year and provider.

HR Benefit Option

Defines selectable options within a benefit plan (e.g., PPO vs. HDHP, Basic vs. Premium coverage).

HR Benefit Coverage Level

Defines coverage tiers available under benefit plans (e.g., Employee Only, Employee + Spouse, Family). Used to determine pricing and eligibility.

HR Benefit Provider

Stores information about the external or internal organization administering the benefit plan (e.g., insurance carrier, retirement board, third-party administrator).

HR Benefit Plan Document

Stores plan-related documentation such as summary plan descriptions, policy documents, regulatory filings, or internal guidelines.

HR Benefit Eligibility Rule

Defines reusable eligibility conditions for benefit participation, such as employment type, grade/rank, bargaining unit, service duration, or location.

HR Benefit Waiting Period

Defines waiting period rules before an employee becomes eligible for enrollment (e.g., 30 days after hire, first of month following eligibility).

HR Benefit Enrollment Period

Defines enrollment windows such as Open Enrollment, New Hire Enrollment, or Special Enrollment periods, including start and end dates.

HR Benefit Enrollment

Represents an individual’s enrollment in a specific benefit plan, including selected option, coverage level, effective dates, and enrollment status.

HR Benefit Election

Captures detailed selections made under a benefit enrollment, such as optional riders, add-ons, or sub-options within a plan.

HR Benefit Beneficiary

Stores beneficiary designations for benefit plans that require them (e.g., life insurance, retirement). Includes allocation percentage, relationship, effective dates, and priority sequencing.

HR Benefit Life Event

Records a reported qualifying life event for an individual (e.g., marriage, birth, divorce) that may trigger enrollment changes. Includes documentation and approval status.

HR Benefit Life Event Change

Tracks specific benefit enrollment changes resulting from a life event, including affected plans, requested modifications, approval status, and effective dates.

HR Benefit Contribution Rate

Defines employer and employee contribution structures for a benefit plan, option, and/or coverage level. Supports percentage-based or fixed-amount contributions with effective dating.

HR Benefit Cost Allocation

Defines how employer benefit costs are allocated across funds, cost centers, grants, or departments. Supports split allocations and effective dating.

HR Benefit Deduction Code

Maps benefit enrollments to payroll deduction identifiers. Supports integration with payroll systems and deduction tracking.

HR Benefit Claim

Tracks internal benefit-related claims or reimbursement requests (e.g., tuition reimbursement, wellness reimbursement). Includes submission details, approval status, payment status, and associated enrollment.

Note: All data shown in screenshots is fictitious and for demonstration purposes only.

Use the pac data CLI command or the Configuration Migration tool to import sample data into your environment.

No guides are available for this solution yet.