
Payroll Benefits Contributions
Recommendation, 2007 April 15
Editors:
Penni Kessler
Kim Bartkus
Authors:
Penni Kessler
Contributors:
Members of the Payroll work group
Copyright ©2007 HR-XML Consortium, Inc.
Abstract
This document describes HR-XML’s Payroll Benefit Contributions schema. The schema allows the capture of information used by third party administrators to manage employees benefit contributions.
Table of Contents
1.1.2 Relationship to Business Processes
1.1.3 Background of Payroll Benefit Contributions (Son of Spark)
1.4.1 Payroll Processing Benefit Contributions
1.4.2 Updating Benefit Contributions Election
2.1 PayrollBenefitContributions Schema
2.2 Schema/DTD Elements Explained
2.2.1 PayrollBenefitContributions
4 Appendix A - Document Version History
5 Appendix B – Related Documents
6 Appendix C – Reference Examples
Create a Schema/DTD design to define payroll benefit contributions information that would be used by third party administrators to manage employees benefit contributions. This first design is only intended for US payroll-benefit contributions.
The Internet has transformed the way payroll benefit contribution information can be managed by third party administrators and the people who participate in these programs. People are now able to view their payroll contributions and manage how those monies are disbursed through web interfaces. They are able to view balances and contact the third party administrators directly if any issues have occurred.
While the Internet has transformed the management of payroll benefit contributions dramatically, the current mechanisms of actually transferring payroll information from payroll vendors to third party administrators is still quite cumbersome. Some of the major areas of concern are listed below:
Many companies have defined/deferred contributions as part of their benefits packages that they offer to employees. In order to process these contributions correctly, the employees’ participation information must be used to interface with the payroll system and third party administrators. This document specifies the data elements that will be necessary to process benefit contributions within a payroll and to send information to the third party administrators.
The SPARK standard was forwarded to the payroll workgroup to define the benefit contributions information to be transmitted between a payroll vendor and a third party administrator The first phase of this project was to convert the SPARK standard to XML. The payroll transmission was demonstrated during a conference using a demo XML format. This initial phase was called the Son of SPARK.
Develop a Schema and documentation to allow the transfer of payroll benefits contributions information between employers and third-party administrators.
Define the payroll benefit contributions structure for use in the payroll schemas defined by the HR-XML Consortium. This will include two transactions:
· Updating the benefit contributions election
Standardized XML vocabularies with no direct references to any US terminology will allow international payroll vendors to easily adopt the standard for international use. However, this specification contains benefit information specific to the US. Attributes may need to be added or driven off a table that stores the types of plans available by country.
The use case describes the payroll benefits transactions between an organization, employee, and third-party administrator. This is further defined in the activity diagrams below, where the swim lanes denote the transmission of information between business partners.
As the organization processes payroll, the benefit contributions are calculated and posted. This information is tranmitted to the third-party administrator. The administrator posts the contributions to the online system, where the employee may review the contributions information.

When a current participant changes their benefit contributions, the new contribution information is transmitted to the organization. The organization calculates and posts the payroll using the new benefit contributions. The third-party administrator posts the updated contributions to the online system, to be reviewed by the employee.

A high level diagram can be found below.

Note: LocalDateType and AnyDateTimeNaType are references to the HR-XML CPO DateTimeTypes specification. See references for links to this information.
|
Component Name |
ContentModel |
Definition |
|
/ |
xml:lang
- - |
The root element for the schema. This is the starting point for the Payroll Benefit Contributions schema/dtd design. |
|
/
PayrollBenefitContributions/ |
- LocalDateType - S (1/1) |
Date of transmission to the plan administrator. |
|
/
PayrollBenefitContributions/ |
- LocalDateType - S (1/1) |
The date the XML file was created by the payroll system transmitting the information. |
|
/
PayrollBenefitContributions/ |
PlanId - PayrollBenefitContributionsIdentifierType - S (1/1) |
Defines the Plan, such as PlanId and Participant. |
|
/
PayrollBenefitContributions/ VendorPlan/ |
- PayrollBenefitContributionsIdentifierType - S (1/1) |
PlanId specifies which plan the sibling elements relate to. Sample value: "XYZ Company Pension Plan". A taxpayer identification number could also be used here. |
|
/
PayrollBenefitContributions/ VendorPlan/ PlanId/ |
- xsd:boolean - |
True/False. Identifies if this is the primary plan. |
|
/
PayrollBenefitContributions/ VendorPlan/ PlanId/ |
- AnyDateTimeNaType - |
Beginning inclusive date for the ID. |
|
/
PayrollBenefitContributions/ VendorPlan/ PlanId/ |
- AnyDateTimeNaType - |
Ending inclusive date for the ID. |
|
/
PayrollBenefitContributions/ VendorPlan/ PlanId/ |
- xsd:string - S (1/1) |
Unique identifier. |
|
/
PayrollBenefitContributions/ VendorPlan/ PlanId/ |
IdIssuer -
xsd:string - S
(0/1) |
Contains the domain information for the Id. |
|
/
PayrollBenefitContributions/ VendorPlan/ PlanId/ Domain/ |
- xsd:string - S (0/1) |
The entity responsible for the issuing Id. |
|
/ PayrollBenefitContributions/
VendorPlan/ PlanId/ Domain/ |
- xsd:string - S (0/1) |
Information that can be used to help further identify the id. |
|
/
PayrollBenefitContributions/ VendorPlan/ |
DatesInformation
- [complexType] - S
(0/*) |
Contains all the information related to the person (employee) and the information gathered for that employee. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ |
StartDate
- LocalDateType - S
(0/1) |
Contains the begin and end dates for various events in a person's employment history. All dates are as per ISO 8601 (YYYY-MM-DD) |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ DatesInformation/ |
- dateTypePatternExtensionType - |
Describes the employment status related to the date |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ DatesInformation/ |
- LocalDateType - S (0/1) |
Contains the begin date for the event. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ DatesInformation/ |
- LocalDateType - S (0/1) |
Contains the end date for the event. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ |
PayDate - LocalDateType - S (0/1) |
Contains the payroll information as it relates to the person. This will include the contributions, payrates, earnings, paydates, etc. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/ |
- LocalDateType - S (0/1) |
The pay (check) date that this entry relates to for the person. As per ISO standard 8601 |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/ |
- LocalDateType - S (0/1) |
The pay period end date for the contribution information. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/ |
xsd:extension base: xsd:decimal |
All the eligible earnings for this payroll contribution. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PayrollInformation/ EligibleEarnings/ |
xsd:restriction base: xsd:string (enumeration) |
Describes the earnings that are being defined for this contribution |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
EligibleEarnings/ |
- CurrencyCodeType - |
Defines the currency code being used for the earnings. Based on ISO standard. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PayrollInformation/ EligibleEarnings/ |
- planTypePatternExtensionType - |
Describes the plan type being contributed to. '**US only defined plans |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/ |
ContributionAmount
- xsd:decimal - S
(0/*) |
Contains all the contribution information as it relates to the person. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ |
xsd:restriction base: xsd:string (enumeration) |
Describes the type of contribution. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ |
- CurrencyCodeType - |
Defines the currency code being used for the contribution/loan. Based on ISO standard. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ |
- planTypePatternExtensionType - |
Describes the plan type being contributed to. '**US only defined plans |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PayrollInformation/ Contribution/ |
xsd:restriction base: xsd:string (enumeration) |
Describes whether Pretax, posttax or loan. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ |
xsd:extension base: xsd:decimal |
Contains the amount of the contribution. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ ContributionAmount/ |
- xsd:string - |
Plan identification code used by the plan administrator. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ |
xsd:extension base: xsd:decimal |
Contains the year to date amount for the contributions. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ ToDateAmount/ |
xsd:restriction base: xsd:string (enumeration) |
Describes the To Date amount. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ |
Id - xsd:string - S (0/1) |
Gives the loan information such as ID and amount. |
|
/ PayrollBenefitCon
tributions/ VendorPlan/ Participant/ PayrollInformation/ Contribution/ Loan/ |
- xsd:string - S (0/1) |
Unique identifier. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ Loan/ |
- xsd:string - S (0/1) |
Unique identifier. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
Contribution/ Loan/ |
xsd:extension base: xsd:decimal |
The goal amount for the loan. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PayrollInformation/ Contribution/ Loan/
LoanPaymentAmount/ |
xsd:restriction base: xsd:string (enumeration) |
Describes the Loan Payment amount. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PayrollInformation/ |
xsd:restriction base: PayFrequencyType (enumeration) |
Describes the pay frequency for this person. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/ |
xsd:restriction base: xsd:string (enumeration) |
Describes the compensation basis for the employee. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/ |
- xsd:string - S (0/1) |
Describes the employment status of the person. This may be full time, part time, part time with benefits, contract, or any other applicable schedule. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/ |
xsd:extension base: xsd:decimal |
States the pay rate for the person. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
PayRate/ |
xsd:restriction base: xsd:string (enumeration) |
Describes base pay rate for the person. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/
PayRate/ |
- CurrencyCodeType - |
Defines the currency code being used for the pay rate. Based on ISO standard. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PayrollInformation/ |
xsd:restriction base: xsd:string (enumeration) |
Contains overtime status information. In the U.S., this contains the Fair Labor Standards Act status. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ |
PlanInformation
- [complexType] - S
(0/*) |
Contains the summary of the plan information as it relates to the person. Includes elements containing indicators (such as HCE) for the person and beneficiary information. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/ |
Loan - [complexType] - S (0/*) |
Describes the plan(s) that the person is a part of. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ |
- planTypePatternExtensionType - |
Describes the plan type being contributed to. '**US only defined plans |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ |
- CurrencyCodeType - |
Must conform to ISO 4217 - Representation of Currency and Funds. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PlanSummaryInformation/ PlanInformation/ |
Id - xsd:string - S (0/1) |
Gives the loan information such as ID and amount. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ Loan/ |
- xsd:string - S (0/1) |
Unique identifier. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ Loan/ |
- xsd:string - S (0/1) |
Unique identifier. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ Loan/ |
xsd:extension base: xsd:decimal |
The goal amount for the loan. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ Loan/ LoanPaymentAmount/ |
xsd:restriction base: xsd:string (enumeration) |
Describes the Loan Payment amount. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PlanSummaryInformation/ PlanInformation/ |
xsd:extension base: xsd:decimal |
Describes the contribution or loan. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PlanSummaryInformation/ PlanInformation/
PersonContributionInformation/ |
xsd:restriction base: xsd:string (enumeration) |
Specifies whether the contribution is a percent or flat amount. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ PersonContributionInformation/ |
xsd:restriction base: xsd:string (enumeration) |
Describes whether pretax or posttax. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PlanSummaryInformation/ PlanInformation/
PersonContributionInformation/ |
xsd:restriction base: xsd:string (enumeration) |
Describes whether the contribution applies to a period or goal. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ |
xsd:extension base: LocalDateType |
Contains the effective date and type for the plan status for the person. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PlanSummaryInformation/ PlanInformation/ PlanStatus/ |
xsd:restriction base: xsd:string (enumeration) |
Intended to reflect common states that a given participant could be in relative to this plan. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ |
xsd:extension base: LocalDateType |
Contains various date information related to the person's eligibility within the plan. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ PlanDates/ |
xsd:restriction base: xsd:string (enumeration) |
Intended to house dates that may drive benefit levels or eligibility. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ |
- xsd:integer - S (0/1) |
Contains the number of years the person has been involved in the plan. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
PlanInformation/ |
- xsd:decimal - S (0/1) |
Contains the employer match percentage for this person's plan. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PlanSummaryInformation/ |
xsd:extension base: xsd:string |
Describes a variety of categories for the person. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
Flags/ |
- flagTypePatternExtensionType - |
Indicates the kind of flag data. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/ |
xsd:extension base: xsd:decimal |
Contains the number of service hours for the person. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PlanSummaryInformation/
ServiceHours/ |
xsd:restriction base: xsd:string (enumeration) |
If "YTD", the amount of ServiceHours is to be interpreted as a year-to-date figure (year relative to the CreateDate); if "period", it is an increment for the period in question. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ |
PersonId -
PayrollBenefitContributionsIdentifierType - S (1/*) |
Contains the information about the person such as name, governement id's, and date of birth. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/ |
- PayrollBenefitContributionsIdentifierType - S (1/*) |
Contains the person's identifier as it relates to the person within the organization. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/
PersonId/ |
- xsd:boolean - |
true/false. Identifies if this is the primary government Id. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PersonInformation/ PersonId/ |
- AnyDateTimeNaType - |
Beginning inclusive date for the ID. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/
PersonId/ |
- AnyDateTimeNaType - |
Ending inclusive date for the ID. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/
PersonId/ |
- xsd:string - S (1/1) |
Unique identifier. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PersonInformation/ PersonId/ |
IdIssuer -
xsd:string - S
(0/1) |
Contains the domain information for the Id. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PersonInformation/ PersonId/ Domain/ |
- xsd:string - S (0/1) |
The entity responsible for the issuing Id. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/ PersonId/
Domain/ |
- xsd:string - S (0/1) |
Information that can be used to help further identify the id. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/ |
- LocalDateType - S (0/1) |
The date of birth for the person. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/ |
MaritalStatusCode
- xsd:string - S
(1/1) |
Contains the marital status of the person such as the code and start date. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/
MaritalStatus/ |
xsd:restriction base: xsd:string (enumeration) |
Contains a text value of the marital status of the person. |
|
/
PayrollBenefitContributions/ VendorPlan/ Participant/ PersonInformation/
MaritalStatus/ |
- LocalDateType - S (0/1) |
Contains the begin date for the event. |
|
/ PayrollBenefitContributions/
VendorPlan/ Participant/ PersonInformation/ |
- GenderCodeType - S (0/1) |
Describes the sex of the person. |
|
/
PayrollBenefitContributions/ VendorPlan/ |
GovernmentId
- PayrollBenefitContributionsIdentifierType - S (1/1) |
Contains the organization information as it relates to the person. |
|
/ PayrollBenefitContributions/
VendorPlan/ OrganizationInformation/ |
- LocalDateType - |
The effective date for the organization information. This will help keep track if there are any organizational changes and when they occurred (including transfers). |
|
/
PayrollBenefitContributions/ VendorPlan/ OrganizationInformation/ |
- PayrollBenefitContributionsIdentifierType - S (1/1) |
An identification number issued by a government to identify a person. For example the CPF in Brazil, or the Social Security Number in the United States.. |
|
/
PayrollBenefitContributions/ VendorPlan/ OrganizationInformation/
GovernmentId/ |
- xsd:boolean - |
True/False. Identifies if this is the primary government Id. |
|
/ PayrollBenefitContributions/
VendorPlan/ OrganizationInformation/ GovernmentId/ |
- AnyDateTimeNaType - |
Beginning inclusive date for the ID. |
|
/
PayrollBenefitContributions/ VendorPlan/ OrganizationInformation/
GovernmentId/ |
- AnyDateTimeNaType - |
Ending inclusive date for the ID. |
|
/
PayrollBenefitContributions/ VendorPlan/ OrganizationInformation/
GovernmentId/ |
- xsd:string - S (1/1) |
Unique identifier. |
|
/ PayrollBenefitContributions/
VendorPlan/ OrganizationInformation/ GovernmentId/ |
IdIssuer -
xsd:string - S
(0/1) |
Contains the domain information for the Id. |
|
/
PayrollBenefitContributions/ VendorPlan/ OrganizationInformation/
GovernmentId/ Domain/ |
- xsd:string - S (0/1) |