Benefits Enrollment

Recommendation, 2007 April 15

Editors:

Suneel Mendiratta, Employease

Kelly Cohen, Hewitt Associates

Kim Bartkus, HR-XML Consortium

Schema Editors:

Dan Diman, eBenX

Kim Bartkus, HR-XML Consortium

Contributors:

Members of the Benefits Enrollment workgroup

Copyright © 2007, HR-XML Consortium, Inc. 

Abstract

This document describes an XML Schema that supports the transfer of benefits enrollment data between organizations (for example, a benefits administrator and an insurance carrier).  This schema is part of the HR-XML Consortium effort to define an XML vocabulary to support business transactions in the Human Resource domain.

 

Table of Contents

1     Overview.. 4

1.1      Objective. 4

1.1.1        Changes in This Version. 4

1.1.2        Domain Issues. 5

1.1.3        Business Reasons. 5

1.2      Scope. 6

1.2.1        Major Components. 6

2     Supported Business Processes. 6

2.1      Trading Partner Roles. 6

2.2      Business Process Name. 7

2.2.1        Summary. 7

2.2.2        Use Case Scenarios. 7

2.2.3        Diagrams. 7

3     Schema Design. 9

3.1      Component Schemas. 9

3.2      Overview.. 10

3.3      The Enrollment Element 11

3.4      The BenefitsAdiminstrativeAffiliate Element 14

3.5      The Subscriber Element 15

3.6      Global Types. 18

3.6.1        The Coordination of Benefits Info Global Type. 18

3.6.2        The Dependent Data Global Type. 19

3.6.3        The Coverage Global Type. 23

3.6.4        The USTierCoverage Global Type. 24

3.6.5        The USSpendingAccountCoverage Global Type. 33

3.6.6        The USRateBasedCoverage Global Type. 38

3.6.7        The EmploymentData Global Type. 44

3.6.8        The MedicareData Global Type. 47

3.6.8.1     MedicarePartA.. 49

3.6.8.2     MedicarePartB.. 49

3.6.8.3     MedicarePartD.. 50

3.6.9        The MedicaidData Global Type. 50

3.6.10      The HIPAAData Global Type. 51

3.6.11      The PersonData Global Type. 51

3.6.12      The LanguageData Global Type. 56

3.6.13      The CarrierData Global Type. 57

3.6.14      The IdCardData Global Type. 57

3.6.15      The SchoolData Global Type. 58

4     Implementation Considerations. 59

4.1      Introduction. 59

4.2      Update versus Replacement File Reporting. 59

4.3      Complete Family Reporting versus Individual Changes Only. 60

4.4      Correcting Person Identifier, Name and Demographic Data. 60

4.5      Coverage Level for Dependents. 61

4.6      COBRA Eligible; Not Enrolled. 61

4.7      COBRA Enrolled; Premium Not Paid. 61

4.8      COBRA Enrolled; Premium Paid. 61

4.9      Receiving System Derives Group or Policy Numbers. 62

4.10    Coverage Terminations. 62

4.11    Split Family Enrollment 62

4.12    Originating SSN for Surviving Dependents. 63

4.13    Spending Account Enrollments. 63

4.14    Healthcare Spending Accounts (HSAs) 63

4.15    Dependent Life Enrollments. 64

4.16    Optional Information – not known by source system.. 64

4.17    Required Date Information – not known by source system.. 64

4.18    Current vs. Historical Tier Coverage. 64

4.19    Contact Information Use. 64

5     Appendix A - Document Version History. 64

6     Appendix B – Related Documents. 66

7     Appendix C - Business and Life Events. 67

8     Appendix D – Benefit Enrollment Glossary. 70

9     Appendix E – Component Enumerations. 71

10       Appendix F - Messaging Considerations. 74

 

1         Overview

1.1        Objective

This document describes HR-XML’s Enrollment schema, which is designed to support the transfer of benefits enrollment data between organizations (see Section 2, Supported Business Processes).  A second document, Enrollment Reference Examples (see Appendix B – Related Documents), contains annotated examples illustrating how the specification can be used.

The current specification is largely focused on employee benefit plan enrollment scenarios within the United States. Some initial steps to localize US-only content have been taken in this version of the schema. As demand dictates, the workgroup (working with relevant HR-XML chapters) will add support for enrollment scenarios elsewhere in the Americas, Europe, Japan, or in other jurisdictions. The non-backwardly compatible changes for full localization will be made as additional jurisdiction-specific content is identified and added.

1.1.1          Changes in This Version

This version of the HR-XML Enrollment specification includes the following changes:

1.      Gave names to certain anonymous types. This allows for better modularization, reuse, and handling by class generation tools.

2.      Added “HSAVendor” element to “TierCoverage”.to better support enrollments in Healthcare Spending Account (HSA) programs. See Section 4.14, Healthcare Spending Accounts (HSAs) and Section 3.6.4, USTierCoverage Global Type.  HSAVendorType extends the existing CarrierData data type.  In addition to OrganizationName, OrganizationCode, and ContactMethod available in CarrierData, the HSAVendorType adds a UseDefaultAccountSponsor and a SignatureDate. The UseDefaultAccountSponsor is a Boolean that may be used to indicate whether the subscriber has elected the health plan’s default HSA vendor. SignatureDate indicates that the benefits administrator has obtained and has on file, the beneficiary’s signed election of the designated HSA vendor.

3.      Added “Health Reimbursement Account” to existing enumerated SpendingAccountCoverage types.  Existing enumerations were: FSA Health Care and FSA Dependent Care.

4.      Added optional PlanStartDate and PlanEndDate elements under SpendingAccountCoverage.  These elements are intended to be used when finer-grained  “plan year” information is required. This might be necessary to handle special circumstances such as when the plan year may be less than a full year.

5.      Within ContributionData, made the following changes:

·         Made GoalAmount element optional (not relevant for all spending account coverage types)

·         Added optional StartDate (LocalDateType). This is the date on which contribution changes become effective.

·         Added optional FirstPayrollDate (LocalDateType).  This would be an indication of the first payroll date on which contributions would start.

6.      Added an optional AutoReimbursementIndicator element. This has enumerated values of “all”; “none”; and “byClaim”.

1.1.2          Domain Issues

Systems that store benefits enrollment data belong to many different types of organizations.  These systems may belong to employers, third party administrators (TPAs), benefit suppliers/vendors, or other parties involved in the administration or provision of benefits to employees or other human resources.  There exists significant variation in the capabilities, the structural organization of data, and (beyond a certain core set) the individual data elements stored in such systems.  By solicitation of input from a cross section of organizations which store benefits enrollment data, the Benefits Enrollment schema aims to provide low barriers to adoption of this standard for many disparate system types while providing a rich structure capable of supporting complex transactions.

Benefits provided by organizations to their employees or other human resources are of many types:  medical insurance, flexible spending accounts, life insurance, short term disability insurance, 401(k), employee stock purchase and many others.  Furthermore, the universe of benefits is not static: it grows as new products enter the market.  The schema design must take these domain facts into account; the schema must be easy to extend to new benefit types and must support a wide range of benefit types.

Many underlying business events and situations affect the enrollment of human resources in benefits.  These events and situations may originate with the individual (birth, marriage, death, change of address, etc.), the organization (merger, location closure, new product offering, etc.) or another entity (government regulation change, union certification, etc.).

1.1.3          Business Reasons

1.1.3.1       Why should there be a standard?

The provision of benefits by employers to employees and their dependents is a large industry and accounts for millions of dollars.  The communication of individuals enrolled in benefits and the data which describe their enrollments determines how and when money changes hands as well as ensures that subscribers get the services in which they have enrolled when they need them.  The workgroup envisions a day when reliable, low-overhead electronic connections between plan sponsors, TPAs, insurers, payers, and other trading partners allow cost savings for all parties and improve the quality, cleanliness, and delivery time of enrollment data.  In turn, the accuracy of payments made for the provision of benefits and the quality of the benefit experience for the subscriber is improved.  To that end, the workgroup advances an XML standard for the exchange of enrollment information.  Such a standard will facilitate the creation of an environment where it is possible for trading partners to quickly create durable, reliable electronic connections.  Furthermore, work done to create one trading partner connection is re-usable with subsequent trading partners.  These benefits translate into reduced cost to create a new connection and reduced costs to maintain and run an existing connection.

1.1.3.2       What do I have to gain as an employer/HRIS solution provider/benefits provider from adopting this standard?

The goal of this standard is to make it possible for adopters to use electronic media for the reliable, low cost transmission of benefits enrollment data, and to commoditize electronic trading partner connections.  The value proposition of any such electronic communication channel lies in how the trading partners use this capability to improve the efficiency and capability of their shared business processes.  To support this, the standard ensures consistency of implementation across trading partners while still supporting the flexibility that different types of trading partners might require to achieve their business goals.  The end result of this effort is reduced entry cost, reduced maintenance cost, and greater consistency of implementation across trading partners.

1.2        Scope

The Benefits Enrollment schema supports enrollment and maintenance of human resources in tier-based coverage (such as medical, dental and vision), spending accounts (more commonly known as flexible spending accounts (FSA)), rate-based coverage (such as life, short term disability, and long term disability) and stock purchase plan coverage.

The Benefits Enrollment team recognizes that the Benefits Enrollment schema and the TierCoverage element in particular represent American benefit enrollment models.  As the Benefits Enrollment team recruits international members, it plans to release subsequent versions with either a modified TierCoverage element or multiple Coverage elements representing other countries' benefit enrollment requirements.  Until that time, the data type, 'USTierCoverage' best models American benefit enrollment requirements.

1.2.1          Major Components

The major components of an enrollment transaction payload are:

·         Subscriber

·         Dependent

·         Coverage

2         Supported Business Processes

2.1        Trading Partner Roles

The Benefits Enrollment schema supports the exchange of enrollment information between trading partners.  Trading partners may be large employers, HR software vendors, third party administrators, or insurance carriers.

The role of the trading partner within the context of the Benefits Enrollment schema is to communicate and/or receive benefit enrollment information as it relates to a subscriber or dependent. 

2.2        Business Process Name

2.2.1          Summary

The Benefits Enrollment schema supports the exchange of enrollment information between trading partners.  Typical uses of the schema are described below and are depicted in the following diagram:

·         The exchange of information between a large employer and third party administrator to pass enrollment information for all coverages across all carriers.

·         The exchange of information between a large employer (using HR software) and an insurance carrier to pass enrollment information for that carrier/administrator.

·         The exchange of information between a third party administrator and an insurance carrier to pass single or multiple employers’ enrollment information for that carrier.

2.2.2          Use Case Scenarios

Many employee life and business events and employer events drive enrollment-related events.  Version 2.1 of the Benefits Enrollment schema supports the exchange of tier-based, spending account, and rate-based enrollment information initiated by these events.  Section 7 (Appendix C - Business and Life Events) lists the specific events, categorized as enrollment changes, personal life events, work life events, data changes, or organizational events.

2.2.3          Diagrams

The marriage life event provides a specific example for communicating enrollment-related information between entities.  This section describes the specific processes.  The actual XML examples are found in the Enrollment Reference Examples document (see Appendix B – Related Documents).

Upon a marriage event, a Person elects to add his/her spouse to medical coverage.  The Person sends enrollment to the Employer’s Human Resources department, Administrator, or Carrier.  Any of these three recipients can then inform the other two, depending on the division of administrative responsibilities.


2.3.3.1  Marriage Life Event Diagram


3         Schema Design

3.1        Component Schemas

The Enrollment schema is componsed of a number of component schemas. These schemas are detailed below.

o        Enrollment/EnrollmentTypes.xsd.  This a collection of reusable types used within the enrollment schema.

o        Enrollment/Localizations.xsd.  This schema would be edited by implementers to include the appropriate local content. This schema will become more relevant as additional local content is added.

US-Only Components

o        Enrollment/US/USLocalizations.xsd.  This contains certain components related to US social insurance programs and mandates (e.g., Medicare, Medicaid, “HIPAA”, COBRA”).

o        Enrollment/US/USRateBasedCoverage.xsd.  This contains components related to rate-based coverages, such as life and accident insurance.

o        Enrollment/US/USSpendingAccountCoverage.xsd.  This contains components related to spending account coverages, such as “flexible spending accounts,” a type of account given certain preferences under US tax law.    

o        Enrollment/US/USTierCoverage.xsd.  

Stock Purchase Plan Coverage Schema

o        Stock/StockPurchasePlanCoverage.xsd

Separate documentation for the Stock Purchase Plan Coverage Schema is available in distribution packages that can be downloaded from the HR-XML website (http://www.hr-xml.org).

Cross-Process Objects

o        CPO/DateTimeDataTypes.xsd

o        CPO/ContactMethod.xsd

o        CPO/PostalAddress.xsd

o        CPO/OnlineAddress.xsd

o        CPO/TelcomNumber.xsd

o        CPO/PersonName.xsd

o        CPO/EntityIdType.xsd

Note that documentation for CPO schemas is available in distribution packages that can be downloaded from the HR-XML website (http://www.hr-xml.org).  Also see, Appendix B – Related Documents.

3.2        Overview

Below is a high-level diagram of the Benefit Enrollment schema.


 

3.3        The Enrollment Element

The Enrollment element is the root of the Benefits Enrollment schema.

Elements and Attributes

[Global types listed alphabetically in following table.]

ContentModel*
Data type
Occurrence:
Sequence | Choice | All
(minOccurs/maxOccurs)
Attributes

Definition

/
Enrollment

transactionType xsd:restriction base: xsd:string [Enumerations]: Change, Full
- -
creationDate - DateTimeType - required
originatorId - xsd:string -
originatorName - xsd:string -
baselineDate - LocalDateNkNaType -
recipientId - xsd:string -
recipientName - xsd:string -
xml:lang - -
UniquePayloadTrackingId - EntityIdType - S (0/1)
Organization - xsd:string - S (1/*)
UserArea - [see include/import] - S (0/1)

Container for the benefits enrollment specification.

/ Enrollment/
transactionType

xsd:restriction base: xsd:string [Enumerations]: Change, Full

In the context of a batch transaction, specifies if it is a full or changed payload. [BusinessRule(s): It is not intended as a processing instruction for the receiving system. ]
[Example(s): "Full" signifies the entire file is sent in the batch transaction. "Change" signifies that only changes are sent in the batch transaction. ]

/ Enrollment/
creationDate

- DateTimeType -

Date file was created.

/ Enrollment/
originatorId

- xsd:string -

Code identifying the transaction originator, typically the sender's taxpayer Id.

/ Enrollment/
originatorName

- xsd:string -

Name of the transaction originator.

/ Enrollment/
baselineDate

- LocalDateNkNaType -

Date representing baseline for change data.

/ Enrollment/
recipientId

- xsd:string -

Code identifying the transaction's recipient typically the recipient's taxpayer Id.

/ Enrollment/
recipientName

- xsd:string -

Name of the transaction recipient.

/ Enrollment/
UniquePayloadTrackingId

- EntityIdType - S (0/1)

An identifier to tie the original transmission to the acknowledgement of that transmission.
[BusinessRule(s): The sender in a trading partnership agreeing to use the acknowledgement will provide this value in the attribute of the same name on the original element; the value will be repeated in this element to produce an acknowledgement of a specific payload. ]

/ Enrollment/
Organization

organizationName - xsd:string - required
BenefitsAdministrativeAffiliate - xsd:string - S (0/*)
Subscriber - xsd:string - S (1/*)
OrganizationId - EntityIdType - S (0/*)

Contains information about the organization.

/ Enrollment/ Organization/
organizationName

- xsd:string -

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ Enrollment/ Organization/
BenefitsAdministrativeAffiliate

OrganizationName - xsd:string - C (1/1)
PersonName - PersonNameType - C (1/1)
EntityRole - xsd:string - S (1/1)
AccountNumber - xsd:string - S (0/1)
IdentificationCode - EntityIdType - S (0/1)
ContactInformation - ContactMethodType - S (0/*)

High level container to describe plan administration. Annotation: These entities provide service to the Organization related to the organization's provision of benefits to subscribers.

Enrollment/ Organization/
Subscriber

SubscriberType - xsd:string - S (1/1)
OriginatingSubscriberData - [complexType] - S (0/1)
Person - PersonData - S (1/1)
Coverage - CoverageType - S (1/1)
Employment - EmploymentData - S (0/1)
HIPAA - HIPAAData - S (0/1)
Medicare - MedicareData - S (0/1)
Medicaid - MedicaidData - S (0/1)
BenefitReportingInformation - [complexType] - S (0/*)
Dependent - xsd:string - S (0/*)
UserArea - [see include/import] - S (0/1)

Contains information about the person whose ability to enroll in benefits is based on his/her relationship to the organization.

/ Enrollment/ Organization/
OrganizationId

- EntityIdType - S (0/*)

Unique identifier for the organization. It may be an internal identifier assigned by the sender.

 


3.4        The BenefitsAdiminstrativeAffiliate Element

The BenefitsAdiminstrativeAffiliate element is an optional element containing information identifying the plan administrator.

Elements and Attributes

[Global types listed alphabetically in following table.]

ContentModel*
Data type
Occurrence:
Sequence | Choice | All
(minOccurs/maxOccurs)
Attributes

Definition

/ Enrollment/ Organization/
BenefitsAdministrativeAffiliate

OrganizationName - xsd:string - C (1/1)
PersonName - PersonNameType - C (1/1)
EntityRole - xsd:string - S (1/1)
AccountNumber - xsd:string - S (0/1)
IdentificationCode - EntityIdType - S (0/1)
ContactInformation - ContactMethodType - S (0/*)

High level container to describe plan administration.

/ Enrollment/ Organization/ BenefitsAdministrativeAffiliate/
OrganizationName

- xsd:string - C (1/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ Enrollment/ Organization/ BenefitsAdministrativeAffiliate/
PersonName

- PersonNameType - C (1/1)

The name of a person.

/ Enrollment/ Organization/ BenefitsAdministrativeAffiliate/
EntityRole

xsd:restriction base: xsd:string [Enumerations]: Plan Sponsor, Insurer, Broker or Sales Office, First Party Administrator, Second Party Administrator, Third Party Administrator, Other Affiliate

Describes the role played by the BenefitsAdministrativeAffiliate.
[Example(s): Plan Sponsor, Insurer, Broker, Sales Office, Third Party Administrator ]

/ Enrollment/ Organization/ BenefitsAdministrativeAffiliate/
AccountNumber

- xsd:string - S (0/1)

An account number for an institution.

/ Enrollment/ Organization/ BenefitsAdministrativeAffiliate/
IdentificationCode

- EntityIdType - S (0/1)

A unique identifier used to reference the entity. The Id is associated with the higher level element.

/ Enrollment/ Organization/ BenefitsAdministrativeAffiliate/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

3.5        The Subscriber Element

The Subscriber element is a required element containing information about the individual with an ability to enroll in the benefits program(s) based on a relationship with the Organization sponsoring the benefit program(s).

 

Elements and Attributes

[Global types listed alphabetically in following table.]

ContentModel*
Data type
Occurrence:
Sequence | Choice | All
(minOccurs/maxOccurs)
Attributes

Definition

/ Enrollment/ Organization/
Subscriber

SubscriberType - xsd:string - S (1/1)
OriginatingSubscriberData - [complexType] - S (0/1)
Person - PersonData - S (1/1)
Coverage - CoverageType - S (1/1)
Employment - EmploymentData - S (0/1)
HIPAA - HIPAAData - S (0/1)
Medicare - MedicareData - S (0/1)
Medicaid - MedicaidData - S (0/1)
BenefitReportingInformation - [complexType] - S (0/*)
CoordinationofBenefits - CoordinationOfBenefitsInfoType - S (0/*)
Dependent - DependentDataType - S (0/*)
UserArea - [see include/import] - S (0/1)

Contains information about the person whose ability to enroll in benefits is based on his/her relationship to the organization.

/ Enrollment/ Organization/ Subscriber/
SubscriberType

SubscriberTypeCode - xsd:string - S (1/1)
StartDate - LocalDateType - S (0/1)

Contains information describing the relationship between the subscriber and the Organization.

/ Enrollment/ Organization/ Subscriber/ SubscriberType/
SubscriberTypeCode

xsd:restriction base: xsd:string [Enumerations]: Employment, Survivorship, Dependent-only Coverage

This code indicates why this individual can enroll in benefits provided by the organization.

/ Enrollment/ Organization/ Subscriber/ SubscriberType/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ Enrollment/ Organization/ Subscriber/
OriginatingSubscriberData

IdentificationCode - EntityIdType - S (1/1)
PersonName - PersonNameType - S (0/1)

Provides a link from this subscriber to another subscriber. For use in elevated dependent situation such as survivorship.

/ Enrollment/ Organization/ Subscriber/ OriginatingSubscriberData/
IdentificationCode

- EntityIdType - S (1/1)

A unique identifier used to reference the entity. The Id is associated with the higher level element.

/ Enrollment/ Organization/ Subscriber/ OriginatingSubscriberData/
PersonName

- PersonNameType - S (0/1)

The name of a person.

/ Enrollment/ Organization/ Subscriber/
Person

- PersonData - S (1/1)

Contains various data about a person.

/ Enrollment/ Organization/ Subscriber/
Coverage

- CoverageType - S (1/1)

Identifies the type of coverage.
[Example(s): Coverage Global Complex Type describes four types of coverage: Coverage Global Complex Type describes four types of coverage: Tier-Based Coverage; Rate-Based Coverage; Spending Account Coverage; and Stock Purchase Coverage.]

/ Enrollment/ Organization/ Subscriber/
Employment

- EmploymentData - S (0/1)

Container for all employment-related information as it relates to the person.

/ Enrollment/ Organization/ Subscriber/
HIPAA

- HIPAAData - S (0/1)

Health Information Portability and Accountability Act. Container for HIPAA related elements.

/ Enrollment/ Organization/ Subscriber/
Medicare

- MedicareData - S (0/1)

Container for subscriber's Medicare information.

/ Enrollment/ Organization/ Subscriber/
Medicaid

- MedicaidData - S (0/1)

Container for subscriber's Medicaid information.

/ Enrollment/ Organization/ Subscriber/
BenefitReportingInformation

BenefitReportingType - xsd:string - S (1/1)
BenefitReportingValue - xsd:string - S (1/1)
StartDate - LocalDateType - S (0/1)

High level container to describe the benefits-related reporting required.

/ Enrollment/ Organization/ Subscriber/ BenefitReportingInformation/
BenefitReportingType

- xsd:string - S (1/1)

Indicates the type of benefit reporting.
[Example(s): Location, Division, Job ]

/ Enrollment/ Organization/ Subscriber/ BenefitReportingInformation/
BenefitReportingValue

- xsd:string - S (1/1)

Indicates the corresponding value of BenefitReportingType.

/ Enrollment/ Organization/ Subscriber/ BenefitReportingInformation/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ Enrollment/ Organization/ Subscriber/
CoordinationOfBenefits

- CoordinationOfBenefitsInfoType - S (0/1)

Contains information about other insurance coverage with which an insurer must coordinate payment. Contains an indicator of whether coordination of benefits is applicable and optionally the name of the other insurer and effective dating.

/ Enrollment/ Organization/ Subscriber/ Dependent

- DependentDataType - S (0/*)

The Dependent element (using the DependentDataType) is an optional child of the Subsriber element. It is a container for all information related to a Subscriber’s dependent. A Subcriber element may have from zero to an unlimited number of Dependent elements.

3.6        Global Types

3.6.1          The Coordination of Benefits Info Global Type

Used by CoordinationOfBenefits element under both Subscriber and Dependent. Contains information about other insurance coverage with which an insurer must coordinate payment.

/
[CoordinationOfBenefitsInfoType]

CoordinationOfBenefitsIndicator - CoordinationOfBenefitsIndicatorTypesType - S (1/1)
InsurerName - xsd:string - S (0/1)
StartDate - LocalDateType - S (0/1)
EndDate - LocalDateType - S (0/1)

Contains information about whether a coordination of benefits situation exists. Optionally allows the inclusion of the name of the relevant insurer and effective dating.

/ [CoordinationOfBenefitsInfoType]/
CoordinationOfBenefitsIndicator

- CoordinationOfBenefitsIndicatorTypesType - S (1/1)

Indicates whether there is other coverage with which payments must be coordinated. Enumerated values are: yes, no, and unknown.

/ [CoordinationOfBenefitsInfoType]/
InsurerName

- xsd:string - S (0/1)

The name of the insurer.

/ [CoordinationOfBenefitsInfoType]/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.

/ [CoordinationOfBenefitsInfoType]/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.

3.6.2          The Dependent Data Global Type

The Dependent element (using the DependentDataType) is an optional child of the Subsriber element. It is a container for all information related to a Subscriber’s dependent. A Subcriber element may have from zero to an unlimited number of Dependent elements. The Person element uses type DependentPersonData. This is a duplicate of the type PersonData used in Subscriber except the IdentificationCode is optional for a dependent.

Elements and Attributes

[Global types listed alphabetically in following table.]

ContentModel*
Data type
Occurrence:
Sequence | Choice | All
(minOccurs/maxOccurs)
Attributes

Definition

[ DependentDataType ]

relationshipCode xsd:restriction base: xsd:string
- - required
fullTimeStudent - xsd:boolean -
Person - DependentPersonData - S (1/1)
Coverage - CoverageType - S (1/1)
Medicare - MedicareData - S (0/1)
Medicaid - MedicaidData - S (0/1)
HIPAA - HIPAAData - S (0/1)
School - SchoolData - S (0/*)
ResponsiblePerson - [complexType] - S (0/1)
CustodialParent - [complexType] - S (0/1)
UserArea - [see include/import] - S (0/1

An element of Subscriber that captures all information related to the Dependent.

/ Enrollment/ Organization/ Subscriber/ Dependent/
relationshipCode

xsd:restriction base: xsd:string [Enumerations]: Adopted Child, Brother or Sister, Brother-in-Law or Sister-in-Law, Child, Collateral Dependent, Court Appointed Guardian, Cousin, Dependent of a Minor Dependent, Ex-Spouse, Father, Father or Mother, Father-in-Law or Mother-in-Law, Foster Child, Grandfather or Grandmother, Grandson or Granddaughter, Guardian, Life Partner, Mother, Nephew or Niece, Self, Son-in-Law or Daughter-in-Law, Sponsored Dependent, Spouse, Stepfather, Stepmother, Stepson or Stepdaughter, Uncle or Aunt, Ward

Indicates the relationship between subscriber and dependent.
[Example(s): Spouse, Father, Brother-in-Law ]

/ Enrollment/ Organization/ Subscriber/ Dependent/
fullTimeStudent

- xsd:boolean -

Indicates if a student is attending full time. True/False.

/ Enrollment/ Organization/ Subscriber/ Dependent/
Person

- DependentPersonData - S (1/1)

Contains various data about a person.

/ Enrollment/ Organization/ Subscriber/ Dependent/
Coverage

- CoverageType - S (1/1)

Identifies the type of coverage.
[Example(s): Coverage Global Complex Type describes four types of coverage: Coverage Global Complex Type describes four types of coverage: Tier-Based Coverage; Rate-Based Coverage; Spending Account Coverage; and Stock Purchase Coverage ]

/ Enrollment/ Organization/ Subscriber/ Dependent/
Medicare

- MedicareData - S (0/1)

Container for subscriber's Medicare information.

/ Enrollment/ Organization/ Subscriber/ Dependent/
Medicaid

- MedicaidData - S (0/1)

Container for subscriber's Medicaid information.

/ Enrollment/ Organization/ Subscriber/ Dependent/
HIPAA

- HIPAAData - S (0/1)

Health Information Portability and Accountability Act. Container for HIPAA related elements.

/ Enrollment/ Organization/ Subscriber/ Dependent/
CoordinationOfBenefits

- CoordinationOfBenefitsInfoType - S (0/1)

Contains information about other insurance coverage with which an insurer must coordinate payment. Contains an indicator of whether coordination of benefits is applicable and optionally the name of the other insurer and effective dating. See CoordinationOfBenefitsInfoType.

/ Enrollment/ Organization/ Subscriber/ Dependent/
School

- SchoolData - S (0/*)

Information about an educational institution.

/ Enrollment/ Organization/ Subscriber/ Dependent/
CustodyInfo

- CustodyInfoType - S (0/1)

An optional field indicateing the type of legal custody for a child dependent. Enumerated values are: "both parents", "former spouse", "subscriber only", and "other or unknown".

/ Enrollment/ Organization/ Subscriber/ Dependent/ School/
OrganizationName

- xsd:string - S (1/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ Enrollment/ Organization/ Subscriber/ Dependent/ School/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ Enrollment/ Organization/ Subscriber/ Dependent/ School/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ Enrollment/ Organization/ Subscriber/ Dependent/ School/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ Enrollment/ Organization/ Subscriber/ Dependent/
ResponsiblePerson

PersonName - PersonNameType - S (1/1)
ContactInformation - ContactMethodType - S (1/*)

Individual other than the parent responsible for the person.

/ Enrollment/ Organization/ Subscriber/ Dependent/ ResponsiblePerson/
PersonName

- PersonNameType - S (1/1)

The name of a person.

/ Enrollment/ Organization/ Subscriber/ Dependent/ ResponsiblePerson/
ContactInformation

- ContactMethodType - S (1/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ Enrollment/ Organization/ Subscriber/ Dependent/
CustodialParent

PersonName - PersonNameType - S (1/1)
ContactInformation - ContactMethodType - S (1/*)

Custodial parent of a minor dependent usually required when someone other than subscriber.

/ Enrollment/ Organization/ Subscriber/ Dependent/ CustodialParent/
PersonName

- PersonNameType - S (1/1)

The name of a person.

/ Enrollment/ Organization/ Subscriber/ Dependent/ CustodialParent/
ContactInformation

- ContactMethodType - S (1/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

 

 

 

 

3.6.3          The Coverage Global Type

/
[CoverageType]

TierCoverage - USTierCoverage - S (0/*)
SpendingAccountCoverage - USSpendingAccountCoverage - S (0/*)
RateBasedCoverage - USRateBasedCoverage - S (0/*)
StockPurchasePlanCoverage - [see include/import] - S (0/*)
UserArea - [see include/import] - S (0/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [Coverage]/
TierCoverage

- USTierCoverage - S (0/*)

Container for information about TierCoverages in which the person is enrolled.

/ [Coverage]/
SpendingAccountCoverage

- USSpendingAccountCoverage - S (0/*)

Contains information about Spending Accounts in which the individual is participating.

/ [Coverage]/
RateBasedCoverage

- USRateBasedCoverage - S (0/*)

Container for information about Rated Based Coverage in which the person is enrolled.

 

3.6.4          The USTierCoverage Global Type

 

/
[USTierCoverage]

type - USTierCoveragePlanType - required
TransactionCode - xsd:string - S (0/1)
ElectedPlanCode - xsd:string - S (0/1)
GroupNumber - xsd:string - S (0/1)
COBRAStatus - xsd:string - S (1/1)
StartDate - LocalDateType - S (1/1)
COBRAInformation - xsd:string - S (0/1)
EndDate - LocalDateType - S (0/1)
CoverageLevel - [complexType] - S (1/*)
Provider - xsd:string - S (0/*)
PlanParticipationSuspensionDate - LocalDateType - S (0/1)
EnrollmentSignatureDate - LocalDateType - S (0/1)
Carrier - CarrierData - S (0/1)
HSAVendor - HSAVendorType - S (0/1)
EligibilityPostalCode - xsd:string - S (0/1)
IdCard - IdCardData - S (0/1)
EligibilityRegion - xsd:string - S (0/1)
OriginalEffectiveDate - LocalDateType - S (0/1)
LateEntrantIndicator - xsd:boolean - S (0/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [USTierCoverage] /
type

xsd:restriction base: xsd:string [Enumerations]: 24 Care, Dental, Dental Capitation, Exclusive Provider Organization, Health, Health Maintenance Organization, Hearing, Long Term Care, Long Term Disability, Mail Order Drug, Major Medical, Medicare Risk, Mental Health, Point of Service, Preferred Provider Organization, Prescription Drug, Preventative Care, Short Term Disability, Utilization Review, Vision

Further defines the associated element in the context provided.
[BusinessRule(s): Additional values are permitted if preceded by an x: ]

/ [USTierCoverage]/
TransactionCode

xsd:restriction base: xsd:string [Enumerations]: Add, Audit, Change, Correction, Delete, Employee Information Not Available, Reinstatement, Termination

A code that applies to the individual records within a batch.
[BusinessRule(s): Not intended for use in determining the action to the receiving system. Informational only. ]
[Example(s): Add, Change, Delete, Termination, Reinstatement, Correction, Audit, Employee Information Not Available. ]

/ [USTierCoverage]/
ElectedPlanCode

- xsd:string - S (0/1)

Identifies the actual plan or option in which the person is enrolling.

/ [USTierCoverage]/
GroupNumber

- xsd:string - S (0/1)

Group number for the plan in which the subscriber or dependent is enrolled.  Group numbers may be constructed of a number of component parts. In such cases it recommended, but not required, that the components be separated with a colon - :

/ [USTierCoverage]/
COBRAStatus

xsd:restriction base: xsd:string [Enumerations]: COBRA, non-COBRA

Indicates whether a person is COBRA or non-COBRA.

/ [USTierCoverage]/
StartDate

- LocalDateType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USTierCoverage]/
COBRAInformation

COBRAStartDate - LocalDateType - S (0/1)
COBRAEndDate - LocalDateType - S (0/1)
PaidThroughDate - LocalDateType - S (0/1)
QualifyingEventDate - LocalDateType - S (0/1)
QualifyingEventCode - xsd:string - S (0/1)
AdditionalQualifyingEventData - xsd:string - S (0/1)

Contains information on the period of COBRA coverage and on the type and date of the qualifying event triggering COBRA eligibility.

/ [USTierCoverage]/ COBRAInformation/
COBRAStartDate

- LocalDateType - S (0/1)

The date COBRA coverage begins.

/ [USTierCoverage]/ COBRAInformation/
COBRAEndDate

- LocalDateType - S (0/1)

The date COBRA coverage ends.

/ [USTierCoverage]/ COBRAInformation/
PaidThroughDate

- LocalDateType - S (0/1)

The date through which this person's COBRA coverage is paid.
[BusinessRule(s): This is different than the COBRAEndDate. ]

/ [USTierCoverage]/ COBRAInformation/
QualifyingEventDate

- LocalDateType - S (0/1)

The reported date associated with the qualifying event.

/ [USTierCoverage]/ COBRAInformation/
QualifyingEventCode

xsd:restriction base: xsd:string [Enumerations]: Bankruptcy of a Retired Employee, Death, Divorce, Ineligible Child, Medicare, Reduction of work hours, Separation, Termination of Employment

Indicates the event qualifying the person for COBRA continuation of coverage.

/ [USTierCoverage]/ COBRAInformation/
AdditionalQualifyingEventData

- xsd:string - S (0/1)

Contains additional (non-regulatory) COBRA qualifying event data, as defined by the trading partner agreement.
[Business Rule(s): Extend COBRA coverage period beyond statuatory limits.]

/ [USTierCoverage]/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USTierCoverage]/
CoverageLevel

CoverageLevelCode - [complexType] - S (1/1)
StartDate - LocalDateType - S (1/1)

Container for all coverage information within USTierCoverage and USRateBasedCoverage.

/ [USTierCoverage]/ CoverageLevel/
CoverageLevelCode

- [Union]: CoverageLevelCodeType, xStringPatternExtensionType

Indicates coverage level.
[Example(s): Children Only, Employee and Two Dependents, Family, Individual ]

/ [USTierCoverage]/ CoverageLevel/
StartDate

- LocalDateType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USTierCoverage]/
Provider

providerType xsd:restriction base: xsd:string [Enumerations]: Obstetrics and Gynecology Facility, Doctor of Optometry, Primary Care Provider, Pharmacy, Dentist, Managed Care Organization
- -
providerTypeQualifier xsd:restriction base: xsd:string [Enumerations]: Person, Non Person Entity
- -
StartDate - LocalDateType - S (0/1)
OrganizationName - xsd:string - C (0/1)
PersonName - PersonNameType - C (0/1)
ContactInformation - ContactMethodType - S (0/*)
ProviderId - xsd:string - S (0/1)
ProviderRelationshipCode - xsd:string - S (0/1)
ProviderChangeReason - xsd:string - S (0/1)

Information about the provider associated with the coverage.
[Example(s): Physician, Clinic, Primary Care Provider, Other Provider ]

/ [USTierCoverage]/ Provider/
providerType

xsd:restriction base: xsd:string [Enumerations]: Obstetrics and Gynecology Facility, Doctor of Optometry, Primary Care Provider, Pharmacy, Dentist, Managed Care Organization

Indicates the type of provider.
[Example(s): Doctor of Optometry, Dentist, Managed Care Organization ]

/ [USTierCoverage]/ Provider/
providerTypeQualifier

xsd:restriction base: xsd:string [Enumerations]: Person, Non Person Entity

Indicates the type of provider.
[Example(s): Person, Non-Person Entity ]

/ [USTierCoverage]/ Provider/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USTierCoverage]/ Provider/
OrganizationName

- xsd:string - C (0/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ [USTierCoverage]/ Provider/
PersonName

- PersonNameType - C (0/1)

The name of a person.

/ [USTierCoverage]/ Provider/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ [USTierCoverage]/ Provider/
ProviderId

xsd:extension base: xsd:string
providerIdQualifier xsd:restriction base: xsd:string [Enumerations]: Social Security Number, Federal Taxpayer Identification Number, HCFA National Provider Identifier, Mutually Defined
- - required

A unique identifier for the provider.

/ [USTierCoverage]/ Provider/ ProviderId/
providerIdQualifier

xsd:restriction base: xsd:string [Enumerations]: Social Security Number, Federal Taxpayer Identification Number, HCFA National Provider Identifier, Mutually Defined

Indicates the type of provider identification number.
[Example(s): Federal Taxpayer Number, HCFA National Provider Identifier ]

/ [USTierCoverage]/ Provider/
ProviderRelationshipCode

xsd:restriction base: xsd:string [Enumerations]: Established Patient, Not Established Patient, Not Known

Indicates the type of relationship the person has with the provider.
[BusinessRule(s): Values are Established Patient, Not Established Patient, Not Known. ]

/ [USTierCoverage]/ Provider/
ProviderChangeReason

xsd:restriction base: xsd:string [Enumerations]: Appointment Times Not Met in a Timely Manner, Current Customer Information File in Error, Dissatisfaction with Medical Care/Services Rendered, Dissatisfaction with Office Staff, Dissatisfaction with Physician's Referral Policy, Dissatisfied with Office Hours, Inconvenient Office Location, Less Respect/Attention/Time Given Than to Other Patients, No Reason Given, Patient Moved to a New Location, Plan Change, Unable to Scheduled Appointments in a Timely Manner, Voluntary Withdrawal, Dissatisfaction with Medical Care or Services Rendered, Dissatisfaction with Physician Referral Policy, Less Respect ir Attention or Time Given Than to Other Patients

Reason why person is changing providers.

 

The following enumerations were deprecated because the special characters could cause errors with code generators.

 

Deprecated: Dissatisfaction with Medical Care/Services Rendered. Replaced by: Dissatisfaction with Medical Care or Services Rendered

 

Deprecated:  Dissatisfaction with Physician's Referral Policy

Replace by: Dissatisfaction with Physician Referral Policy

 

Deprecated: Less Respect/Attention/Time Given Than to Other Patients

Replaced by: Less Respect or Attention or Time Given Than to Other Patients

 

/ [USTierCoverage]/
PlanParticipationSuspensionDate

- LocalDateType - S (0/1)

A date indicating the last day in which participation in the plan is possible. The context of the date may be broader than the individual (organization or group level) but is provided here at the individual level.

/ [USTierCoverage]/
EnrollmentSignatureDate

- LocalDateType - S (0/1)

Indicates the date on file for the enrollment signature.

/ [USTierCoverage]/
Carrier

- CarrierData - S (0/1)

Contains information about the insurance carrier or other provider of benefits coverage.
[Example(s): Person's Name, Organization's Name, Additional Information ]

/ [USTierCoverage]/ Carrier/
OrganizationName

- xsd:string - S (0/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ [USTierCoverage]/ Carrier/
IdentificationCode

- EntityIdType - S (0/*)

A unique identifier used to reference the entity. The Id is associated with the higher level element.
[Synonym(s): Id ]
[BusinessRule(s): This should be used by the receiving system as the key subscriber identifier. ]

/ [USTierCoverage]/ Carrier/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ [ USTierCoverage ]/
HSAVendor

OrganizationName - xsd:string - S (0/1)
IdentificationCode - EntityIdType - S (0/*)
ContactInformation - ContactMethodType - S (0/*)
UseDefaultAccountSponsor - xsd:boolean - S (0/1)
SignatureDate - LocalDateType - S (0/1)

Contains identifying information related to the selection of a health care spending account (HSA) vendor. This element is used only if the tier coverage is elected in connection to a HSA offering.

/ [ USTierCoverage ]/
HSAVendor/ OrganizationName

- xsd:string - S (0/1)

The name of the HSA vendor elected by the subscriber.  Note that this usually would be used only if the elected vendor is other than the default HSA vendor.  See UseDefaultAccountSponsor.

/ [USSpendingAccountCoverage]/ HSAVendor/
IdentificationCode

- EntityIdType - S (0/*)

A unique identifier used to reference the entity. The Id is associated with the higher level element.

/ [USSpendingAccountCoverage]/ HSAVendor/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ [USSpendingAccountCoverage]/ HSAVendor/
UseDefaultAccountSponsor

- xsd:boolean - S (0/1)

A Boolean that may be used to indicate whether the subscriber has elected the health plan’s default HSA vendor.

/ [USSpendingAccountCoverage]/ HSAVendor/ SignatureDate

- LocalDateType - S (0/1)

Used to indicate that the subscriber’s signature selecting the indicated HSA vendor is on file with benefits administrator. Provides the signature date for that election.

/ [USTierCoverage]/
EligibilityPostalCode

- xsd:string - S (0/1)

Postal code used for eligibility determination.
[BusinessRule(s): When possible, this should be sent by the source system. Receiving system will determine how/if to use this information. ]

/ [USTierCoverage]/
IdCard

- IdCardData - S (0/1)

Container for capturing identification card insurance information.

/ [USTierCoverage]/ IdCard/
PlanCoverageDescription

- xsd:string - S (1/1)

Describes the plan coverage.

/ [USTierCoverage]/ IdCard/
Quantity

- xsd:nonNegativeInteger - S (0/1)

A numerical quantity that is assigned or determined by calculation or measurement.
[Example(s): The number of shares to be vested, number of produced pieces, number of benefit Id cards, or number of positions to be filled. ]

/ [USTierCoverage]/ IdCard/
ActionCode

xsd:restriction base: xsd:string [Enumerations]: Add, Change, Replace

A code indicating the reason an ID card is requested for this benefit.

/ [USTierCoverage]/
EligibilityRegion

- xsd:string - S (0/1)

The region which defines the location of the subscriber/dependent for purposes of plan eligibility in this coverage.

/ [USTierCoverage]/
OriginalEffectiveDate

- LocalDateType - S (0/1)

The date an event was originally became effective.
[BusinessRule(s):  Should represent the first date of continuous coverage with the carrier, as known by the source system. ]

/ [USTierCoverage]/
LateEntrantIndicator

- xsd:boolean - S (0/1)

A boolean value indicating whether the person is enrolling outside the normal enrollment period.

/
[CoverageLevelCodeType]

xsd:restriction base: xsd:string [Enumerations]: Children Only, Dependents Only, Employee and Children, Employee and Five or More Dependents, Employee and Four or More Dependents, Employee and One Dependent, Employee and One or More Dependents, Employee and Spouse, Employee and Three Dependents, Employee and Three or More Dependents, Employee and Two Dependents, Employee and Two or More Dependents, Employee Only, Family, Individual, Not Applicable, Spouse and Children, Spouse Only, Two Party, Employee and Domestic Partner, Domestic Partner and Children, Domestic Partner Only, Employee and Spouse or Domestic Partner, Child or Children of a Domestic Partner

Globally scoped data type. See element or attribute declaration for definition.

 

3.6.5          The USSpendingAccountCoverage Global Type

 

/
[USSpendingAccountCoverage]

type xsd:restriction base: xsd:string [Enumerations]: FSA Health Care, FSA Dependent Care
- - required
GroupNumber - xsd:string - S (0/1)
TransactionCode - xsd:string - S (0/1)
PlanParticipationSuspensionDate - DateNkNaType - S (0/1)
PlanYear - xsd:gYear - S (1/1)
StartDate - LocalDateType - S (1/1)
EndDate - LocalDateNkType - S (0/1)
ContributionData - xsd:double - S (1/*)
RolloverBalance - xsd:double - S (0/1)
Carrier - CarrierData - S (0/1)
DirectDepositData - xsd:string - S (0/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [USSpendingAccountCoverage] /
type

xsd:restriction base: xsd:string [Enumerations]: FSA Health Care, FSA Dependent Care, Health Reimbursement Account

Further defines the associated element in the context provided.
[BusinessRule(s): Additional values are permitted if preceded by an x: ]

/ [USSpendingAccountCoverage]/
GroupNumber

- xsd:string - S (0/1)

Group number of the plan in which the subscriber or dependent is enrolled.

/ [USSpendingAccountCoverage]/
TransactionCode

xsd:restriction base: xsd:string [Enumerations]: Add, Audit, Change, Correction, Delete, Employee Information Not Available, Reinstatement, Termination

A code that applies to the individual records within a batch.
[BusinessRule(s): This does not contemplate envelope-level verbs. ]
[Example(s): Add, Termination, Audit, Suspension ]

/ [USSpendingAccountCoverage]/
PlanParticipationSuspensionDate

- DateNkNaType - S (0/1)

A date indicating the last day in which participation in the plan is possible. The context of the date may be broader than the individual (organization or group level) but is provided here at the individual level.

/ [USSpendingAccountCoverage]/
PlanYear

- xsd:gYear - S (1/1)

Indicates the year for which this plan applies.

/ [USSpendingAccountCoverage]/
PlanStartDate

- LocalDateType - S (0/1)

The start date for the current plan year. Used with PlanEndDate when a finer-grain option to PlanYear is required (e.g., a partial year).

/ [USSpendingAccountCoverage]/
PlanStartDate

- LocalDateType - S (0/1)

The end date for the current plan year. Used with PlanStartDate when a finer-grain option to PlanYear is required (e.g., a partial year).

/ [USSpendingAccountCoverage]/
StartDate

- LocalDateType - S (1/1)

Start date for the Spending Account Coverage. Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USSpendingAccountCoverage]/
EndDate

- LocalDateType - S (0/1)

End date for the Spending Account Coverage. Contains the (inclusive) date, period, or interval the event becomes inactive or ends.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601.]

/ [USSpendingAccountCoverage]/
ContributionData

contributor xsd:restriction base: xsd:string [Enumerations]: Employer, Employee
- - required
GoalAmount - xsd:double - S (1/1)
PerPayPeriodAmount - xsd:double - S (0/1)
YTDContributionAmount - xsd:double - S (0/1)
Frequency - xsd:string - S (0/1)

Container for Spending Account contribution information.

/ [USSpendingAccountCoverage]/ ContributionData/
contributor

xsd:restriction base: xsd:string [Enumerations]: Employer, Employee

Indicates whether the contributor is the Employer or the Employee.

/ [USSpendingAccountCoverage]/ ContributionData/
GoalAmount

xsd:extension base: xsd:double
currency - CurrencyCodeType - required

Indicates the annual goal amount.

/ [USSpendingAccountCoverage]/ ContributionData/ GoalAmount/
currency

- CurrencyCodeType -

A three-letter code identifying the currency of a monetary amount.
[BusinessRule(s): Currency is represented in accordance with ISO 4217 ]

/ [USSpendingAccountCoverage]/ ContributionData/
PerPayPeriodAmount

xsd:extension base: xsd:double
currency - CurrencyCodeType - required

Indicates the amount per pay period.

/ [USSpendingAccountCoverage]/ ContributionData/ PerPayPeriodAmount/
currency

- CurrencyCodeType -

A three-letter code identifying the currency of a monetary amount.
[BusinessRule(s): Currency is represented in accordance with ISO 4217 ]

/ [USSpendingAccountCoverage]/ ContributionData/
YTDContributionAmount

xsd:extension base: xsd:double
currency - CurrencyCodeType - required

Indicates the year-to-date contribution amount.

/ [USSpendingAccountCoverage]/ ContributionData/ YTDContributionAmount/
currency

- CurrencyCodeType -

A three-letter code identifying the currency of a monetary amount.
[BusinessRule(s): Currency is represented in accordance with ISO 4217 ]

/ [USSpendingAccountCoverage]/ ContributionData/
Frequency

xsd:restriction base: xsd:string [Enumerations]: Annually, Bi-Weekly, Daily, Monthly, One Time Only, Quarterly, Semi-Annually, Semi-Monthly, Weekly

Indicates the frequency of the contribution.
[Example(s): Daily, Weekly, Bi-Weekly, Monthly, Annually ]

/ [USSpendingAccountCoverage]/
RolloverBalance

xsd:extension base: xsd:double
currency - CurrencyCodeType - required

Indicates the rollover balance, if any, from the previous year.

/ [USSpendingAccountCoverage]/ RolloverBalance/
currency

- CurrencyCodeType -

A three-letter code identifying the currency of a monetary amount.
[BusinessRule(s): Currency is represented in accordance with ISO 4217 ]

/ [USSpendingAccountCoverage]/
Carrier

- CarrierData - S (0/1)

Contains information about the insurance carrier or other provider of benefits coverage.
[Example(s): Person's Name, Organization's Name, Additional Information ]

/ [USSpendingAccountCoverage]/ Carrier/
OrganizationName

- xsd:string - S (0/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ [USSpendingAccountCoverage]/ Carrier/
IdentificationCode

- EntityIdType - S (0/*)

A unique identifier used to reference the entity. The Id is associated with the higher level element.

/ [USSpendingAccountCoverage]/ Carrier/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ [USSpendingAccountCoverage]/
DirectDepositData

AccountType - xsd:string - S (1/1)
ABARoutingNumber - xsd:string - S (1/1)
BankAccountNumber - xsd:string - S (1/1)

Container for all direct deposit information.

/ [USSpendingAccountCoverage]/ DirectDepositData/
AccountType

xsd:restriction base: xsd:string [Enumerations]: Checking, Savings

Indicates type of account.

/ [USSpendingAccountCoverage]/ DirectDepositData/
ABARoutingNumber

- xsd:string - S (1/1)

Indicates ABA bank routing number.

/ [USSpendingAccountCoverage]/ DirectDepositData/
BankAccountNumber

- xsd:string - S (1/1)

Indicates a bank account number.

/ [USSpendingAccountCoverage]/
AutoReimbursement

- AutoReimbursementType - S (0/1)

An indicator of how auto reimbursement of claims should be administered. Enumerated values are “all”; “none”; and “byClaim”.

 

3.6.6          The USRateBasedCoverage Global Type

/
[USRateBasedCoverage]

TransactionCode - EnrollmentTransactionType - S (0/1)
ElectedPlanCode - xsd:string - S (0/1)
GroupNumber - xsd:string - S (0/1)
CoverageType - xsd:string - S (0/1)
Carrier - CarrierData - S (0/1)
StartDate - LocalDateType - S (1/1)
EndDate - LocalDateType - S (0/1)
CoverageLevel - xsd:double - S (0/*)
Question - [complexType] - S (0/*)
EOIOnFileWithEmployer - xsd:boolean - S (0/1)
EOIRequired - xsd:boolean - S (0/1)
BeneficiaryData - BeneficiaryDataType - S (0/*)
EligibilityPostalCode - xsd:string - S (0/1)
LateEntrantIndicator - xsd:boolean - S (0/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [USRateBasedCoverage]/
TransactionCode

- EnrollmentTransactionType - S (0/1)

A code that applies to the individual records within a batch.
[BusinessRule(s): Not intended for use in determining the action to the receiving system. Informational only. ]
[Example(s): Add, Change, Delete, Termination, Reinstatement, Correction, Audit, Employee Information Not Available. ]

/ [USRateBasedCoverage]/
ElectedPlanCode

- xsd:string - S (0/1)

Identifies the actual plan or option in which the person is enrolling.

/ [USRateBasedCoverage]/
GroupNumber

- xsd:string - S (0/1)

Group number for the plan in which the subscriber or dependent is enrolled.

/ [USRateBasedCoverage]/
CoverageType

Product - [complexType] - S (1/1)
ProductType - [complexType] - S (1/1)
CoveredEntity - xsd:string - S (1/1)

Indicates the type of coverage.
[Example(s): Preventative care, Medicare Risk, Long Term Care ]

/ [USRateBasedCoverage]/ CoverageType/
Product

- [Union]: ProductType, xStringPatternExtensionType

Describes the product. [Example(s): Life Insurance, Accidental Death and Dismemberment Insurance, Long Term Disability ]

/ [USRateBasedCoverage]/ CoverageType/
ProductType

- [Union]: ProductTypeType, xStringPatternExtensionType

Indicates the product type.
[Example(s): Supplemental, Basic ]

/ [USRateBasedCoverage]/ CoverageType/
CoveredEntity

xsd:restriction base: xsd:string [Enumerations]: Self, Spouse, Common Law Spouse, Dependent, Child

Indicates who is covered.
[Example(s): Self, Spouse, Dependent ]

/ [USRateBasedCoverage]/
Carrier

- CarrierData - S (0/1)

Contains information about the insurance carrier or other provider of benefits coverage.
[Example(s): Person's Name, Organization's Name, Additional Information ]

/ [USRateBasedCoverage]/ Carrier/
OrganizationName

- xsd:string - S (0/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ [USRateBasedCoverage]/ Carrier/
IdentificationCode

- EntityIdType - S (0/*)

A unique identifier used to reference the entity. The Id is associated with the higher level element.
[BusinessRule(s): Enrollment: This should be used by the receiving system as the key subscriber identifier. ]

/ [USRateBasedCoverage]/ Carrier/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ [USRateBasedCoverage]/
StartDate

- LocalDateType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USRateBasedCoverage]/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601.]

/ [USRateBasedCoverage]/
CoverageLevel

ApprovedCoverage - xsd:double - S (0/1)
RequestedCoverage - xsd:double - S (0/1)
StartDate - LocalDateNaType - S (1/1)

Container for all coverage information within USTierCoverage and USRateBasedCoverage.

/ [USRateBasedCoverage]/ CoverageLevel/
ApprovedCoverage

Level - xsd:double - S (0/1)
Volume - xsd:double - S (0/1)

Container for information about the approved benefits coverage. ]
[Synonym(s): ApprovedCoverageInfo ]

/ [USRateBasedCoverage]/ CoverageLevel/ ApprovedCoverage/
Level

CoverageLevelValue - xsd:double - S (1/1)
CoverageLevelMultiplier - xsd:double - S (1/1)
CoverageLevelType - xsd:string - S (1/1)

Container for the level of coverage.

/ [USRateBasedCoverage]/ CoverageLevel/ ApprovedCoverage/ Level/
CoverageLevelValue

xsd:extension base: xsd:double
currency - CurrencyCodeType - required

Indicates the monetary value of the coverage.

/ [USRateBasedCoverage]/ CoverageLevel/ ApprovedCoverage/ Level/ CoverageLevelValue/
currency

- CurrencyCodeType -

A three-letter code identifying the currency of a monetary amount. 
[BusinessRule(s): Currency is represented in accordance with ISO 4217 ]

/ [USRateBasedCoverage]/ CoverageLevel/ ApprovedCoverage/ Level/
CoverageLevelMultiplier

- xsd:double - S (1/1)

Indicates the multiplier of the coverage.
[Example(s): 2 times Salary, 3 times Salary ]

/ [USRateBasedCoverage]/ CoverageLevel/ ApprovedCoverage/ Level/
CoverageLevelType

xsd:restriction base: xsd:string [Enumerations]: Salary, YearsOfService, Fixed

Indicates the type of coverage level.
[Example(s): Salary, Years of Service ]

/ [USRateBasedCoverage]/ CoverageLevel/ ApprovedCoverage/
Volume

xsd:extension base: xsd:double
currency - CurrencyCodeType - required

Indicates the total volume of the benefit.
[Example(s): $100,000 Life Insurace Coverage, $2,500 a Month Long Term Disability Amount ]

/ [USRateBasedCoverage]/ CoverageLevel/ ApprovedCoverage/ Volume/
currency

- CurrencyCodeType -

A three-letter code identifying the currency of a monetary amount.
[BusinessRule(s): Currency is represented in accordance with ISO 4217 ]

/ [USRateBasedCoverage]/ CoverageLevel/
RequestedCoverage

Level - xsd:double - S (0/1)
Volume - xsd:double - S (0/1)

Container for the requested coverage.

/ [USRateBasedCoverage]/ CoverageLevel/ RequestedCoverage/
Level

CoverageLevelValue - xsd:double - S (1/1)
CoverageLevelMultiplier - xsd:double - S (1/1)
CoverageLevelType - xsd:string - S (1/1)

Container for the level of coverage.

/ [USRateBasedCoverage]/ CoverageLevel/ RequestedCoverage/ Level/
CoverageLevelValue

xsd:extension base: xsd:double
currency - CurrencyCodeType - required

Indicates the monetary value of the coverage.

/ [USRateBasedCoverage]/ CoverageLevel/ RequestedCoverage/ Level/ CoverageLevelValue/
currency

- CurrencyCodeType -

A three-letter code identifying the currency of a monetary amount.
[BusinessRule(s): Currency is represented in accordance with ISO 4217 ]

/ [USRateBasedCoverage]/ CoverageLevel/ RequestedCoverage/ Level/
CoverageLevelMultiplier

- xsd:double - S (1/1)

Indicates the multiplier of the coverage.
[Example(s): 2 times Salary, 3 times Salary ]

/ [USRateBasedCoverage]/ CoverageLevel/ RequestedCoverage/ Level/
CoverageLevelType

xsd:restriction base: xsd:string [Enumerations]: Salary, YearsOfService, Fixed

Indicates the type of coverage level.
[Example(s): Salary, Years of Service ]

/ [USRateBasedCoverage]/ CoverageLevel/ RequestedCoverage/
Volume

xsd:extension base: xsd:double
currency - CurrencyCodeType - required

Indicates the total volume of the benefit.
[Example(s): $100,000 Life Insurace Coverage, $2,500 a Month Long Term Disability Amount ]

/ [USRateBasedCoverage]/ CoverageLevel/ RequestedCoverage/ Volume/
currency

- CurrencyCodeType -

A three-letter code identifying the currency of a monetary amount.
[BusinessRule(s): Currency is represented in accordance with ISO 4217 ]

/ [USRateBasedCoverage]/ CoverageLevel/
StartDate

- LocalDateNaType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USRateBasedCoverage]/
Question

questionID - xsd:int - required
QuestionText - xsd:string - S (0/1)
QuestionAnswer - xsd:string - S (1/1)

A textual query designed to generate an answer or response.
[BusinessRule(s): Frequently used within a question/answer pair. ]
[Example(s): Insurance related question: is the person a smoker? ]

/ [USRateBasedCoverage]/ Question/
questionID

- xsd:int -

Unique identifier for the question.

/ [USRateBasedCoverage]/ Question/
QuestionText

- xsd:string - S (0/1)

Text for a question.
[BusinessRule(s): This should be associated with a particular answer and be contained in a question/answer set. ]

/ [USRateBasedCoverage]/ Question/
QuestionAnswer

- xsd:string - S (1/1)

Textual response to a particular question.
[BusinessRule(s): This should be associated with a particular question and be contained in a question/answer pair. ]

/ [USRateBasedCoverage]/
EOIOnFileWithEmployer

- xsd:boolean - S (0/1)

A boolean value indicating whether the employer has Evidence of Insurability on File.

/ [USRateBasedCoverage]/
EOIRequired

- xsd:boolean - S (0/1)

A boolean value indicating whether the Evidence of Insurability (EOI) is required by the employer.

/ [USRateBasedCoverage]/
BeneficiaryData

PersonName - PersonNameType - C (1/1)
OrganizationName - xsd:string - C (1/1)
ContactInformation - ContactMethodType - S (0/*)
DateOfBirth - DateNkNaType - S (0/1)
Relationship - xsd:string - S (0/1)
IdentificationCode - EntityIdType - S (0/1)
InheritanceAmount - xsd:double - S (0/1)
BeneficiarySequence - xsd:integer - S (0/1)
StartDate - LocalDateNkNaType - S (1/1)
EndDate - LocalDateNaType - S (0/1)

High level container to describe the plan beneficiary.

/ [USRateBasedCoverage]/ BeneficiaryData/
PersonName

- PersonNameType - C (1/1)

The name of a person.

/ [USRateBasedCoverage]/ BeneficiaryData/
OrganizationName

- xsd:string - C (1/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ [USRateBasedCoverage]/ BeneficiaryData/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information. [Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ [USRateBasedCoverage]/ BeneficiaryData/
DateOfBirth

- DateNkNaType - S (0/1)

A person's birth date.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USRateBasedCoverage]/ BeneficiaryData/
Relationship

xsd:restriction base: xsd:string [Enumerations]: Adopted Child, Brother or Sister, Brother-in-Law or Sister-in-Law, Child, Collateral Dependent, Court Appointed Guardian, Cousin, Dependent of a Minor Dependent, Ex-Spouse, Father, Father or Mother, Father-in-Law or Mother-in-Law, Foster Child, Grandfather or Grandmother, Grandson or Granddaughter, Guardian, Life Partner, Mother, Nephew or Niece, Self, Son-in-Law or Daughter-in-Law, Sponsored Dependent, Spouse, Stepfather, Stepmother, Stepson or Stepdaughter, Uncle or Aunt, Ward

Context definition: Indicates the beneficiary's relationship to insured. For example, Spouse, Father, Brother-in-Law.

/ [USRateBasedCoverage]/ BeneficiaryData/
IdentificationCode

- EntityIdType - S (0/1)

A unique identifier used to reference the entity. The Id is associated with the higher level element.
[BusinessRule(s): Enrollment: This should be used by the receiving system as the key subscriber identifier. ]

/ [USRateBasedCoverage]/ BeneficiaryData/
InheritanceAmount

xsd:extension base: xsd:double
inheritanceType xsd:restriction base: xsd:string [Enumerations]: Percentage, MonetaryAmount
- - required

Amount of inheritance.
[BusinessRule(s): This may be a percentage or monetary amount, based on the type. ]

/ [USRateBasedCoverage]/ BeneficiaryData/ InheritanceAmount/
inheritanceType

xsd:restriction base: xsd:string [Enumerations]: Percentage, MonetaryAmount

Indicates the type of amount. This might be a percentage or monetary amount.

/ [USRateBasedCoverage]/ BeneficiaryData/
BeneficiarySequence

- xsd:integer - S (0/1)

Indicates the order in which the beneficiary receives the payments
[Example(s): 1 (Primary); 2 (Secondary), 3 (Terciery) ]

/ [USRateBasedCoverage]/ BeneficiaryData/
StartDate

- LocalDateNkNaType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [USRateBasedCoverage]/ BeneficiaryData/
EndDate

- LocalDateNaType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601.]

/ [USRateBasedCoverage]/
EligibilityPostalCode

- xsd:string - S (0/1)

Postal code used for eligibility determination.
[BusinessRule(s): Enrollment: When possible, this should be sent by the source system. Receiving system will determine how/if to use this information. ]

/ [USRateBasedCoverage]/
LateEntrantIndicator

- xsd:boolean - S (0/1)

A boolean value indicating whether the person is enrolling outside the normal enrollment period.

/
[EnrollmentTransactionType]

xsd:restriction base: xsd:string [Enumerations]: Add, Audit, Change, Correction, Delete, Employee Information Not Available, Reinstatement, Termination

Globally scoped data type. See element or attribute declaration for definition.

/
[ProductType]

xsd:restriction base: xsd:string [Enumerations]: Life Insurance, Accidental Death and Dismemberment Insurance, Long-Term Disability Insurance, Short-Term Disability Insurance

Globally scoped data type. See element or attribute declaration for definition.

/
[ProductTypeType]

xsd:restriction base: xsd:string [Enumerations]: Not Applicable, Supplemental, Basic, Group

Globally scoped data type. See element or attribute declaration for definition.

 

 

3.6.7          The EmploymentData Global Type

/
[EmploymentData]

employeeId - xsd:string -
EmploymentStatus - xsd:string - S (0/*)
EmploymentLevel - xsd:string - S (0/*)
EmploymentOrganization - [complexType] - S (0/*)
HireDate - LocalDateType - S (0/1)
OriginalHireDate - LocalDateType - S (0/1)
EmploymentTerminationDate - LocalDateType - S (0/1)
LastDayWorked - LocalDateType - S (0/1)
ReturnToWorkDate - LocalDateType - S (0/1)
EEOCCode - xsd:string - S (0/1)
VIPFlag - xsd:boolean - S (0/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [EmploymentData] /
employeeId

- xsd:string -

The identification code of the employee as defined by the employer.

/ [EmploymentData]/
EmploymentStatus

EmploymentStatusCode - xsd:string - S (1/1)
StartDate - LocalDateType - S (1/1)

Container for employment status information.

/ [EmploymentData]/ EmploymentStatus/
EmploymentStatusCode

xsd:restriction base: xsd:string [Enumerations]: Active Foreign Military, Active Domestic Military, Active, Leave of Absence, Short Term Disability, Long Term Disability, Retired, Terminated

Indicates the status of the employee.

/ [EmploymentData]/ EmploymentStatus/
StartDate

- LocalDateType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [EmploymentData]/
EmploymentLevel

EmploymentLevelCode - xsd:string - S (1/1)
StartDate - LocalDateType - S (1/1)

Container to indicate full-time or part-time employment.

/ [EmploymentData]/ EmploymentLevel/
EmploymentLevelCode

xsd:restriction base: xsd:string [Enumerations]: Full Time, Part Time

Code indicating whether an employee is full-time or part-time.

/ [EmploymentData]/ EmploymentLevel/
StartDate

- LocalDateType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [EmploymentData]/
EmploymentOrganization

EmploymentOrganizationGroup - xsd:string - S (1/1)
EmploymentOrganizationGroupType - xsd:string - S (1/1)
StartDate - LocalDateType - S (0/1)

Contains the information regarding how the subscriber belongs to the employer.

/ [EmploymentData]/ EmploymentOrganization/
EmploymentOrganizationGroup

- xsd:string - S (1/1)

Indicates the particular organization group.
[Example(s): Sales, Marketing, Atlanta, San Francisco ]

/ [EmploymentData]/ EmploymentOrganization/
EmploymentOrganizationGroupType

- xsd:string - S (1/1)

Indicates the particular organization group type.
[Example(s): Division, Location ]

/ [EmploymentData]/ EmploymentOrganization/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [EmploymentData]/
HireDate

- LocalDateType - S (0/1)

Date the person was originally hired by the organization.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [EmploymentData]/
OriginalHireDate

- LocalDateType - S (0/1)

The date this person was first hired by the organization.

/ [EmploymentData]/
EmploymentTerminationDate

- LocalDateType - S (0/1)

Contains the actual employment termination date, if applicable.

/ [EmploymentData]/
LastDayWorked

- LocalDateType - S (0/1)

Indicates the last day the subscriber worked for the employer.

/ [EmploymentData]/
ReturnToWorkDate

- LocalDateType - S (0/1)

The date on which a subscriber is expected to return to work.
[Example(s): Dated returned from Leave of Absence, Date returned from Military Reserve Duty. ]

/ [EmploymentData]/
EEOCCode

xsd:restriction base: xsd:string [Enumerations]: American Indian or Alaskan Native, Asian or Pacific Islander, Black, Black (Non-Hispanic), Caucasian, Hispanic, Not Provided, White (Non-Hispanic)

A code used to identify the race of the person as defined by the Equal Employment Opportunity Commission.
[Example(s): Asian, Pacific Islander, Blank, Caucasian, Hispanic ]

/ [EmploymentData]/
VIPFlag

- xsd:boolean - S (0/1)

Indicates whether the employee is considered a VIP (Very Important Person) by the employer.

3.6.8          The MedicareData Global Type

Note that the MedicareData GlobalType has been significantly revised. The pre-existing components have been maintained for backward compatibility, but have been deprecated. These deprecated components should be avoided in new implementations and will be removed in a future version of the schema.

 

/
Medicare

- MedicareData - (1/1)

Contains Medicare information for a subcriber or dependent.

/ Medicare/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.


[Deprecated:  Maintained for backward compatibility. Going forward implementers should use the effective dating available under the MedicarePartA, MedicarePartB, and MedicarePartD components. ]

/ Medicare/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.

[Deprecated:  Maintained for backward compatibility. Going forward implementers should use the effective dating available under the MedicarePartA, MedicarePartB, and MedicarePartD components. ]

/ Medicare/
MedicarePartANumber

- xsd:string - S (0/1)

Subscriber's Medicare Part A number.

 

[Deprecated:  Maintained for backward compatibility. Going forward implementers should use HealthInsuranceClaimNumber. ]

/ Medicare/
MedicarePartBNumber

- xsd:string - S (0/1)

Subscriber's Medicare Part B number.

 

[Deprecated:  Maintained for backward compatibility. Going forward implementers should use HealthInsuranceClaimNumber. ]

/ Medicare/
MedicareEntitlement

IsEligible - MedicareIsEligibleTypesType - S (0/1)
EntitlementReason - EntitlementReasonCodeTypesType - S (0/1)
StartDate - LocalDateType - S (0/1)
EndDate - LocalDateType - S (0/1)

Contains information indicating whether the individual is entitled to the U.S. Medicare program and relevant effective dating.

/ Medicare/ MedicareEntitlement/
IsEligible

- MedicareIsEligibleTypesType - S (0/1)

Indicates whether the individual is eligible for the program.

/ Medicare/ MedicareEntitlement/
EntitlementReason

- EntitlementReasonCodeTypesType - S (0/1)

A reason making a person eligible under the U.S. Medicare program. Enumerated values are: age; ESRD (end-stage renal disease); disabled; working disabled; unknown.

/ Medicare/ MedicareEntitlement/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.

/ Medicare/ MedicareEntitlement/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.

/ Medicare/
HealthInsuranceClaimNumber

- xsd:string - S (0/1)

A "Health Insurance Claim Number," sometimes referred to as a "HIC No," is the primary Medicare reference number. It is used when filing claims.

[Note: Replaces MedicarePartANumber and MedicarePartBNumber, which are deprecated.]
[Synonym(s): MedicarePartANumber, MedicarePartBNumber ]

 

3.6.8.1         MedicarePartA

 

/ Medicare/
MedicarePartA

- MedicareCoverageBaseType - S (0/1)

This element contains information about the individual's Medicare Part A eligibility and enrollment. Medicare Part A is the Hospital Insurance portion of the U.S. Medicare program.

/ Medicare/ MedicarePartA/
IsEnrolled

- MedicareIsEnrolledTypesType - S (0/1)

Indicates whether the individual is enrolled in the particular plan. Enumerated values are "yes," "no," "unknown," and "not applicable".

/ Medicare/ MedicarePartA/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.

/ Medicare/ MedicarePartA/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.

3.6.8.2         MedicarePartB

/ Medicare/
MedicarePartB

- MedicareCoverageBaseType - S (0/1)

This element contains information about the individual's Medicare Part B eligibility and enrollment. Medicare Part B is the portion of the U.S. Medicare program covering physician services.

/ Medicare/ MedicarePartB/
IsEnrolled

- MedicareIsEnrolledTypesType - S (0/1)

Indicates whether the individuals is enrolled in the particular plan. Enumerated values are "yes," "no," "unknown," and "not applicable".

/ Medicare/ MedicarePartB/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.

/ Medicare/ MedicarePartB/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.

 

 

3.6.8.3         MedicarePartD

 

/ Medicare/
MedicarePartD

- MedicareCoveragePartDType - S (0/1)

This element contains information about the individual's Medicare Part D program eligibility and enrollment as well as details about the specific drug plan in which the individual is enrolled.

/ Medicare/ MedicarePartD/
MedicareDrugPlanInfo

- MedicareDrugPlanInfoType - S (0/1)

Contains information about an individual's drug plan enrollment.

/ Medicare/ MedicarePartD/ MedicareDrugPlanInfo/
UniqueBenefitOptionId

- EntityIdType - S (0/1)

Identifies a benefit option available under the particular drug plan. A plan-defined value.

/ Medicare/ MedicarePartD/ MedicareDrugPlanInfo/
DrugPlanCoverage

DrugPlanCoverageType - MedicareDrugPlanTypesType - S (1/1)
StartDate - LocalDateType - S (0/1)
EndDate - LocalDateType - S (0/1)

Contains information about the individual's Medicare Part D drug plan coverage. Indicates the type of Part D coverage and relevant effective dating.

/ Medicare/ MedicarePartD/ MedicareDrugPlanInfo/ DrugPlanCoverage/
DrugPlanCoverageType

- MedicareDrugPlanTypesType - S (1/1)

Identifies the type of Medicare Part D coverage. Enumerated values are: Part D Subsidy Program; Integrated Wrapped Secondary Coverage; Not Participating Subsidy; Not Participating; and Unknown.

/ Medicare/ MedicarePartD/ MedicareDrugPlanInfo/ DrugPlanCoverage/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.

/ Medicare/ MedicarePartD/ MedicareDrugPlanInfo/ DrugPlanCoverage/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.

 

3.6.9          The MedicaidData Global Type

 

/
[MedicaidData]

StartDate - LocalDateType - S (1/1)
EndDate - LocalDateType - S (0/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [MedicaidData]/
StartDate

- LocalDateType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [MedicaidData]/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

3.6.10      The HIPAAData Global Type

/
[HIPAAData]

PriorCoverageMonths - xsd:nonNegativeInteger - S (1/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [HIPAAData]/
PriorCoverageMonths

- xsd:nonNegativeInteger - S (1/1)

Reports the number of prior months during which this person had medical coverage. The derivation of this value is related to HIPAA legislation regarding the portability of health insurance.

3.6.11      The PersonData Global Type

This structure is identical to the DependentPersonData type, with the exception of the Identification Code, which is required in the PersonData type and optional in the DependentPersonData type. For expediency, only the PersonData type is described.

/
[PersonData]

IdentificationCode - EntityIdType - S (1/1)
PriorIncorrectIdentificationCode - EntityIdType - S (0/1)
PersonName - PersonNameType - S (1/1)
PriorIncorrectPersonName - PersonNameType - S (0/1)
Gender - GenderCodeType - S (1/1)
PriorIncorrectGender - GenderCodeType - S (0/1)
DateOfBirth - LocalDateType - S (1/1)
PriorIncorrectDateOfBirth - LocalDateType - S (0/1)
DateOfDeath - LocalDateType - S (0/1)
ContactInformation - ContactMethodType - S (0/*)
Language - LanguageData - S (0/*)
Height - xsd:double - S (0/1)
Weight - xsd:double - S (0/1)
SubstanceAbuser - xsd:boolean - S (0/1)
TobaccoUser - xsd:boolean - S (0/1)
MaritalStatus - xsd:string - S (0/*)
Disability - xsd:string - S (0/*)
Employer - [complexType] - S (0/*)
StudentIndicator - xsd:boolean - S (0/1)
DisabilityIndicator - xsd:boolean - S (0/1)
PostalAddress - [see include/import] - S (0/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [PersonData]/
IdentificationCode

- EntityIdType - S (1/1)

A unique identifier used to reference the entity. The Id is associated with the higher level element.
[BusinessRule(s): This should be used by the receiving system as the key subscriber identifier. ]

/ [PersonData]/
PriorIncorrectIdentificationCode

- EntityIdType - S (0/1)

Used to report an identification code previously reported to the downstream partner later corrected by a subsequent transaction.
[BusinessRule(s): This is to allow proper keying. ]

/ [PersonData]/
PersonName

- PersonNameType - S (1/1)

The name of a person.

/ [PersonData]/
PriorIncorrectPersonName

- PersonNameType - S (0/1)

Used to report a person name previously reported to the downstream partner later corrected by a subsequent transaction.
[BusinessRule(s): This is to allow proper keying. ]

/ [PersonData]/
Gender

- GenderCodeType - S (1/1)

Signifies to the system the gender of the person.
[BusinessRule(s): Representation of Human Sexes values are represented in accordance with ISO 5218. ]

/ [PersonData]/
PriorIncorrectGender

- GenderCodeType - S (0/1)

Used to report a gender previously reported to the downstream partner later corrected by a subsequent transaction.
[BusinessRule(s): This is to allow proper keying. ]

/ [PersonData]/
DateOfBirth

- LocalDateType - S (1/1)

A person's birth date.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [PersonData]/
PriorIncorrectDateOfBirth

- LocalDateType - S (0/1)

Used to report a date of birth previously reported to the downstream partner later corrected by a subsequent transaction.
[BusinessRule(s): This is to allow proper keying. ]

/ [PersonData]/
DateOfDeath

- LocalDateType - S (0/1)

Date of death for subscriber or dependent.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [PersonData]/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ [PersonData]/
Language

- LanguageData - S (0/*)

Contains information about a single language.  
[BusinessRule(s): Proficiency in a language should be reported using the competency schema. ]

/ [PersonData]/ Language/
LanguageCode

xsd:restriction base: xsd:string

Code indicating a language.
[BusinessRule(s): Recommend using ISO 639-1 language set. ]

/ [PersonData]/ Language/
LanguageUsage

xsd:restriction base: xsd:string [Enumerations]: Written, Spoken

Indicates how a language is used or expressed.
[BusinessRule(s): This may include whether a person can speak, read, or write in the specified language, but does not indicate proficiency. ]

/ [PersonData]/
Height

xsd:extension base: xsd:double
units xsd:restriction base: xsd:string [Enumerations]: inches, centimeters
- - required

Specifies the height of a person.

/ [PersonData]/ Height/
units

xsd:restriction base: xsd:string [Enumerations]: inches, centimeters

Describes the quantity in which the item is measured.
[Example(s): Pounds, Kilograms, Inches, Centimeters ]

/ [PersonData]/
Weight

xsd:extension base: xsd:double
units xsd:restriction base: xsd:string [Enumerations]: pounds, kilograms
- - required

A number to indicate the physical weight of the person.
[BusinessRule(s): The unit of measure is stored in a separate element or attribute. ]
[Example(s): 30 Kilos, 180 Pounds ]

/ [PersonData]/ Weight/
units

xsd:restriction base: xsd:string [Enumerations]: pounds, kilograms

Describes the quantity in which the item is measured.
[Example(s): Pounds, Kilograms, Inches, Centimeters ]

/ [PersonData]/
SubstanceAbuser

- xsd:boolean - S (0/1)

Code indicating whether this person is a substance abuser. Included for 834 compatibility.

/ [PersonData]/
TobaccoUser

- xsd:boolean - S (0/1)

Indicates whether or not this person is a tobacco user.

/ [PersonData]/
MaritalStatus

MaritalStatusCode - xsd:string - S (1/1)
StartDate - LocalDateNkNaType - S (1/1)

Contains information on the marital status of the person.

/ [PersonData]/ MaritalStatus/
MaritalStatusCode

xsd:restriction base: xsd:string [Enumerations]: Divorced, Legally Separated, Married, Registered Domestic Partner, Separated, Single, Unmarried, Unreported, Widowed

Code indicating person's marital status.

/ [PersonData]/ MaritalStatus/
StartDate

- LocalDateNkNaType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [PersonData]/
Disability

DisabilityType - xsd:string - S (1/1)
StartDate - LocalDateNkNaType - S (1/1)

Relevant information about the person's disabilities.

/ [PersonData]/ Disability/
DisabilityType

xsd:restriction base: xsd:string [Enumerations]: Short Term Disability, Long Term Disability, Permanent or Total Disability, No Disability

Contains the type of disability. For example, short term disability or permanent.

/ [PersonData]/ Disability/
StartDate

- LocalDateNkNaType - S (1/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [PersonData]/
Employer

OrganizationName - xsd:string - C (1/1)
PersonName - PersonNameType - C (1/1)
ContactInformation - ContactMethodType - S (0/*)
StartDate - LocalDateType - S (0/1)

Container for employer-related information.

/ [PersonData]/ Employer/
OrganizationName

- xsd:string - C (1/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ [PersonData]/ Employer/
PersonName

- PersonNameType - C (1/1)

The name of a person.

/ [PersonData]/ Employer/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

/ [PersonData]/ Employer/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [PersonData]/
StudentIndicator

- xsd:boolean - S (0/1)

Indicates whether or not this person is considered a student.

/ [PersonData]/
DisabilityIndicator

- xsd:boolean - S (0/1)

Indicates whether or not this person is considered to be disabled.

 

3.6.12      The LanguageData Global Type

/
[LanguageData]

languageCodeQualifier - xsd:string -
use xsd:restriction base: xsd:string [Enumerations]: Native Language, Reading Language, Speaking Language
- -
LanguageCode - xsd:string - S (1/1)
LanguageUsage - xsd:string - S (1/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [LanguageData] /
languageCodeQualifier

- xsd:string -

Defines the language code used by the LanguageData element.
[BusinessRule(s): International Standards Organizations values are represented in accordance with ISO 639. ]

/ [LanguageData] /
use

xsd:restriction base: xsd:string [Enumerations]: Native Language, Reading Language, Speaking Language

Describes the purpose of language use.
[Example(s): Native Language, Reading Language, Speaking Language ]

/ [LanguageData]/
LanguageCode

xsd:restriction base: xsd:string

Code indicating a language.
[BusinessRule(s): Recommend using ISO 639-1 language set. ]

/ [LanguageData]/
LanguageUsage

xsd:restriction base: xsd:string [Enumerations]: Written, Spoken

Indicates how a language is used or expressed.
[BusinessRule(s): This may include whether a person can speak, read, or write in the specified language, but does not indicate proficiency. ]

 

3.6.13      The CarrierData Global Type

 

/
[CarrierData]

OrganizationName - xsd:string - S (0/1)
IdentificationCode - EntityIdType - S (0/*)
ContactInformation - ContactMethodType - S (0/*)

Globally scoped data type. See element or attribute declaration for definition.

/ [CarrierData]/
OrganizationName

- xsd:string - S (0/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ [CarrierData]/
IdentificationCode

- EntityIdType - S (0/*)

A unique identifier used to reference the entity. The Id is associated with the higher level element.

/ [CarrierData]/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

 

3.6.14      The IdCardData Global Type

/
[IdCardData]

idCardType xsd:restriction base: xsd:string [Enumerations]: Dental Insurance, Health Insurance, Prescription Drug Service Insurance
- - required
PlanCoverageDescription - xsd:string - S (1/1)
Quantity - xsd:nonNegativeInteger - S (0/1)
ActionCode - xsd:string - S (0/1)

Globally scoped data type. See element or attribute declaration for definition.

/ [IdCardData] /
idCardType

xsd:restriction base: xsd:string [Enumerations]: Dental Insurance, Health Insurance, Prescription Drug Service Insurance

Describes the type of insurance card.
[Example(s): Dental Insurance, Health Insurance, Prescription Drug Service Insurance. ]

/ [IdCardData]/
PlanCoverageDescription

- xsd:string - S (1/1)

Describes the plan coverage.

/ [IdCardData]/
Quantity

- xsd:nonNegativeInteger - S (0/1)

A numerical quantity that is assigned or determined by calculation or measurement.
[Example(s): The number of shares to be vested, number of produced pieces, number of benefit Id cards, or number of positions to be filled. ]

/ [IdCardData]/
ActionCode

xsd:restriction base: xsd:string [Enumerations]: Add, Change, Replace

A code indicating the reason an ID card is requested for this benefit.

 

3.6.15      The SchoolData Global Type

/
[SchoolData]

OrganizationName - xsd:string - S (1/1)
StartDate - LocalDateType - S (0/1)
EndDate - LocalDateType - S (0/1)
ContactInformation - ContactMethodType - S (0/*)

Globally scoped data type. See element or attribute declaration for definition.

/ [SchoolData]/
OrganizationName

- xsd:string - S (1/1)

The name by which an organization or enterprise is known as established under the laws of a country, state, province or ruling governmental body for the purpose of conducting business transactions.

/ [SchoolData]/
StartDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes active or begins.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601. ]

/ [SchoolData]/
EndDate

- LocalDateType - S (0/1)

Contains the (inclusive) date, period, or interval the event becomes inactive or ends.
[BusinessRule(s): This date is inclusive. Dates are represented in accordance with ISO 8601.]

/ [SchoolData]/
ContactInformation

- ContactMethodType - S (0/*)

Contains contact information.
[Example(s): Fax, E-mail, Telephone, Mobile Phone, Pager ]

 

4         Implementation Considerations

4.1        Introduction

The successful adoption of any benefit enrollment standard requires consistent interpretation among trading partners of certain enrollment situations. This section provides practical guidelines for using the HR-XML Benefit Enrollment schema in these situations. While an attempt is made to recommend a preferred approach for interpreting these situations, it is recognized that the capabilities of current source and receiving systems may vary widely from the suggested approach. For many situations an alternative approach is provided.

4.2        Update versus Replacement File Reporting

In most cases, an XML document conforming to the Benefits Enrollment schema will be used to transmit new or updated enrollment data. The TransactionCode element (an optional child element of the Coverage complex type) indicates the nature of the transaction as it is interpreted by the sender. The possible values of TransactionCode are:

·         Add

·         Change

·         Delete

·         Termination

·         Reinstatement

·         Correction

·         Audit

The Enrollment element has an optional TransactionType attribute (included in the schema primarily for compatibility with ANSI 834). This attribute has two possible values: “Change” or “Full.” TransactionType can be set to “Change” when the transmitted XML file includes only current period change activity and to “Full” when the data in the XML file is intended to replace the receiving system’s database with the current state of the sending system’s database. Because of the inefficiencies inherent in full-file processing, we do not recommend the use of Full files for regular maintenance.  However, for Full files, it is recommended that a receiving system not assume terminations based on the absence of an enrolled member. If terminations due to absence are to be used, it must be stipulated in a trading partner agreement.

The Benefits Enrollment schema also supports periodic audits to compare data between sending and receiving systems. To accomplish this, a conforming XML document should include all available information about subscribers and dependents with coverage as of an agreed-upon effective date. The Enrollment element’s TransactionType can optionally be set to “Full” and a TransactionCode with a value of “Audit” should be used for every instance of the Coverage complex type.

4.3        Complete Family Reporting versus Individual Changes Only

For the purposes of Update File reporting, it is RECOMMENDED that complete family units be sent whenever there is a change to any member of the family. In other words, the unit of work for an update transaction is all members of the family regardless of who or what is actually changing.

4.4        Correcting Person Identifier, Name and Demographic Data

Changing or correcting person data requires special attention to assure these changes are treated as “updates” and not “adds” by the receiving system. The Benefit Enrollment schema will always assume Person Identifier (typically Social Security Number in the USA), Person Name, Gender and Date of Birth are populated with the most current data from the source system. Because these fields, either individually or in combination, may be used as key identifiers by the receiving system, previous values SHOULD be provided when any of these change in the current reporting period. The Benefit Enrollment schema provides this capability through the use of corresponding “prior incorrect” fields. Prior Incorrect Identification Code, Prior Incorrect Person Name, Prior Incorrect Gender and Prior Incorrect Date of Birth SHOULD be populated with previously sent values by the source system whenever any of these values change for either a subscriber or dependent record. The receiving system is RECOMMENDED to evaluate these elements to determine the appropriate actions to take. The sending system will typically only send the prior incorrect values one time, in the first reporting period in which the changed is detected.

In the event that the source system does not store Prior Incorrect information, the receiving system must use the data provided to process the person changes.  The receiver should determine, based on their own processing, whether or not they require Prior Incorrect information for updates to key person data.

4.5        Coverage Level for Dependents

It is RECOMMENDED that the CoverageLevelCode be the same for the subscriber and all dependents when the subscriber and dependent(s) have coverage. However, when a dependent is terminated from a family unit that remains covered, the CoverageLevel for the terminated dependent should be the last coverage level code of record and the start date should be the last date of coverage.  If the prior CoverageLevelCode is not known by the sender, a value of "Not Applicable" should be sent.

See termination example in the Enrollment Reference Examples document (Appendix B – Related Documents).

4.6        COBRA Eligible; Not Enrolled

Source systems have the legal obligation to inform the health carrier that a terminated person may be eligible for COBRA – even before the person has elected COBRA. This is needed for health plans to accurately inform people of their COBRA status in a timely manner.

The Benefit Enrollment schema supports this requirement by providing a COBRA Qualifying Event Code and a COBRA Qualifying Event Date on coverage termination transactions. Source systems are RECOMMENDED to provide the COBRA Qualifying Event Code and COBRA Qualifying Event Date. Receiving systems are RECOMMENDED to use this information to terminate current coverage, while still accurately recognizing the person as COBRA eligible.

4.7        COBRA Enrolled; Premium Not Paid

Once a COBRA Eligible person has made a COBRA election, the source system is legally obligated to send the election to the health carrier system, regardless of whether or not the person has made their initial COBRA premium payment. The source system MUST support this requirement by sending an “add” enrollment transaction and including the following COBRA elements: COBRA Status of “COBRA”, COBRA Start Date equal to the date COBRA benefits commence, COBRA Qualifying Event Date and COBRA Qualifying Event Code.  If the COBRA Enrolled person has yet to make a COBRA payment, the COBRA  Paid Through Date element will not be available and therefore will not be sent. Receiving systems MUST interpret this as a bona fide election.

4.8        COBRA Enrolled; Premium Paid

COBRA enrollees with continuing coverage will be reported using all available COBRA information and including a current COBRA Paid Through Date. The COBRA Paid Through Date is interpreted as the date through which COBRA premiums have been paid and thus the date through which claims may be paid. The COBRA Paid Through Date MUST be updated by normal periodic maintenance. The receiving systems SHALL not terminate COBRA enrollments based on the COBRA Paid Through Date alone; instead the source system will explicitly terminate COBRA enrollees with delinquent premiums once all grace periods are exceeded. 

4.9        Receiving System Derives Group or Policy Numbers

The Benefit Enrollment schema supports the possibility that the receiving system may derive group or policy numbers in whole or in part based on information provided by the source system. The derivation by the receiving system of these group or policy numbers is typically based on a combination of Employment, Organization, Coverage and/or some other client specific reporting requirements.

The Employment Status, Employment Organization, Benefit Reporting Information and Elected Plan Code elements may be used individually or in combination to support this requirement. Specific agreements between trading partners will govern the source, use and interpretation of these elements to meet this requirement.

If the sending system derives the group or policy number, this data SHOULD be sent in the GroupNumber element.   A trading partner agreement will determine how this information is used by the receiving system.

4.10    Coverage Terminations

The RECOMMENDED approach for communicating explicit coverage terminations is to send the subscriber with a TransactionCode value of ‘Termination’ and a TierCoverage EndDate populated with the subscriber’s and/or dependent’s last date of coverage.

4.11    Split Family Enrollment

Split family enrollments occur in any situation where the dependent of a subscriber is enrolled in a different benefit plan than the subscriber.  The Benefit Enrollment schema recommendation is twofold, depending on the coverage scenario:

1) If a subscriber and dependent(s) are enrolled with coverage in the same carrier, but with different GroupNumbers (ie: pre/post 65), all covered family members should be reported within the same HR-XML transaction. The Benefit Enrollment schema supports this situation by reporting each family member with their respective GroupNumber value and a CoverageLevelCode reflecting all covered family members, regardless of GroupNumber variations.  

2) If a subscriber and dependents are enrolled with coverage in different carriers, or the subscriber elects dependent only coverage, the dependent coverage should be reported in a HR-XML transaction separate from the subscriber. The Benefit Enrollment schema supports this situation by reporting the dependent as a subscriber, with a "Dependent-only Coverage" SubscriberTypeCode and with the OriginatingSubscriberId set to the original subscriber's SSN (or the original subscriber's IdentificationCode value). The receiving system should enroll the covered dependent in manner that will maintain the claim history.

Any variations to the above process should be specified in a trading partner agreement.

4.12    Originating SSN for Surviving Dependents

Surviving dependent enrollments occur when the plan rules of the sponsor provide continued coverage for dependents in the event of the death of the originating subscriber.  The Benefit Enrollment schema supports this situation by reporting the surviving dependent as a subscriber, with a "Survivorship" SubscriberTypeCode and with the OriginatingSubscriberId set to the deceased subscriber's SSN (or the original subscriber's IdentificationCode value).  The receiving system will enroll the surviving dependent(s) in a manner that will maintain the claim history.   Any variations to the above process should be specified in a trading partner agreement.

4.13    Spending Account Enrollments

Enrollment information for a flexible spending account (FSA) contains a variety of attributes.  The schema accommodates up to four elements (GoalAmount, PerPayPeriodAmount, YTDContributionAmount, and Frequency) to capture FSA enrollment attributes.  However, only the GoalAmount and two of the other three are REQUIRED to calculate the enrollment.  For example, if an employee elects a $1200 GoalAmount, a $100 PerPayPeriodAmount, and a Frequency equal to “Monthly”, then one can assume that the YTDContributionAmount is zero.  In another example, if the GoalAmount is $260, the Frequency is “Weekly”, and the YTDContributionAmount is $130, then one can assume that the PerPayPeriodAmount is $5.

4.14    Healthcare Spending Accounts (HSAs)

A Healthcare Spending Account (HSA) is a tax-exempt account established exclusively for the purpose of paying qualified medical expenses of account beneficiaries. One condition for establishing HSA, is for the HSA beneficiary to be covered under a high-deductible health plan. Because an HSA is always paired with a high-deductible plan and because the HSA itself is typically maintained by a separate financial services company (referred to in this specification as the “HSA vendor”), the HSA-related information communicated within an enrollment between a benefits administrator and a health plan can be relatively thin.

The Tier Coverage component of HR-XML’s Enrollment schema is designed to communicate health and other tier-coverage enrollments from a benefit administer to a health plan. In the case of an HSA program, the high-deductible health plan enrollment is accomplished using the Tier Coverage component. In some cases, the HSA vendor could be a “preferred” or “default” HSA vendor with which the health plan has a pre-existing business arrangement. In such cases, the health plan, upon receiving notice of the employee’s election of the preferred HSA vendor, would communicate the information to the HSA vendor necessary to set up the account. In other cases, the selection and establishment of the HSA might take place “out of channel” directly between the employee and the financial institution. An HSAVendor element within the Tier Coverage component allows for the transmission information necessary to accommodate these contingencies.

4.15    Dependent Life Enrollments

Some dependent life enrollments are only captured as they relate to the subscriber.  For example, one may capture the fact that a subscriber has a dependent life plan for $10,000 but actual dependent information may not exist.  On the other hand, a subscriber may enroll the dependent with explicit dependent information.  The schema accommodates both scenarios and examples for each appear in section 7.9.

4.16    Optional Information – not known by source system

If an optional element is not known/captured by the source system, the corresponding tags and/or content SHOULD NOT be sent in the payload. 

4.17    Required Date Information – not known by source system

If the source system does not store a required date, but a “notKnown” enumeration is defined, ‘notKnown’ SHOULD be sent instead of a default date.  A trading partner agreement is required if a date is required, but the sender is not able to provide it. 

4.18    Current vs. Historical Tier Coverage

It is RECOMMENDED that the source system sends only the most current TierCoverage instance for a subscriber/dependent, unless there is a change to historical coverage data (i.e.: revised effective date). For changes to historical coverage information, the source system SHOULD send all TierCoverage instances from the point of change through the most current coverage.  Receiving systems SHOULD use the data provided to overlay historical and current coverage, beginning with the most historical coverage sent. The receiving system SHOULD sort all Tier Coverage instances as needed for processing.

4.19    Contact Information Use

It is RECOMMENDED that the source system sends the Use element (business, businessDirect, personal) to describe Contact Information whenever it is known.  If Use information is not known, it SHOULD NOT be sent/defaulted by the sender.  In this case, the receiving system MUST have business rules defined to facilitate processing of Contact Information.

5         Appendix A - Document Version History

Date

Description

2001-Oct-16

Approved Recommendation by HR-XML Consortium

2003-Feb-26

Approved recommendation by HR-XML Consortium. The default and targetNamespaces of all HR-XML schemas have been standardized to "http://ns.hr-xml.org". This recommendation is available as part of the HR-XML 2_0 architecture.

 

2004-Apr-05

Made backwards compatible changes based on implementor and benefit testing feedback. See overview section for details. Separated Enrollment document into two documents.  The second doc contains all of the examples.

2004-May-14

Renamed MailingAddress to PostalAddress and EligibilityState to EligibilityRegion. Changed  UniquePayloadTrackingId to an element. Extended coverageLevelCode and productType enumerations. Updated diagrams and definition tables as needed. Based on CPO feedback.

2004-May-24

Corrected overview section, added Enumerations table – based on TSC feedback.

2004-Jun-07

Updated survivorship implementation guidelines based on Benetest feedback. Added clarification regarding non-backwards compatible and other changes; updated tables to reflect multiple occurrences for ContactInfo. An optional attribute xml:lang was added to the root element.

2004-08-02

Approved by Membership.

2005-04-05

Schema changes:

·         Changed reusable structures to complex types. Moved to EnrollmentTypes schema, when appropriate.

·         Moved generic coverage types to Localizations schema.</