JSON Schema for 834 (Benefits and Enrollment)

Resources:

Member Coverage

Main object for 834, contains the member and their health coverage information.
NameDescriptionTypeEDI Reference

id

Unique identifier assigned by the converter

String

objectType

Type of this object, always set to 'MEMBER_COVERAGE'

String

fileName

Converted X12 EDI file name

String

fileEffectiveDates

File effective dates

List of Date

DTP

masterPolicyNumber

Master policy number

String

REF02*34

sponsor

Sponsor

PartyIdName

1000A

insurer

Insurer

PartyIdName

1000B

tpas

Tpas

List of Tpa

1000C

memberIndicator

Member indicator

String

INS01

relationshipCode

Relationship code

String

INS02

maintenanceTypeCode

Maintenance type code

String

INS03

maintenanceReasonCode

Maintenance reason code

String

INS04

benefitStatusCode

Benefit status code

String

INS05

medicarePlanCode

Medicare plan code

Since: v2.14.8

String

INS06-1

medicareEligibilityReasonCode

Medicare eligibility reason code

Since: v2.14.8

String

INS06-2

cobraEventCode

Cobra event code

String

INS07

employmentStatusCode

Employment status code

String

INS08

studentStatusCode

Student status code

String

INS09

handicapIndicator

Handicap indicator

String

INS10

deathDate

Death date

Since: v2.14.8

Date

INS12

confidentialityCode

Confidentiality code

String

INS13

birthSequenceNumber

Birth sequence number

Integer

INS17

identifier

Member identifier

String

REF02*0F

groupOrPolicyNumber

Group or policy number

String

REF02*1L

supplementalIdentifiers

Supplemental identifiers

List of Reference

REF

statusInfoEffectiveDates

Status info effective dates

List of Date

DTP

member

Member

Member

2100A

NM1*IL

incorrectMember

Incorrect member

Member

2100B

NM1*70

contractAmounts

Member policy amounts from the member loop 2100A

List of Amount

AMT

mailingAddress

Member mailing address

Address

employers

Employers

List of Party

2100D

schools

Schools

List of Party

2100E

custodialParent

Custodial parent

Party

2100F

responsiblePersons

Responsible persons

List of Party

2100G

dropOffLocation

Drop off location

Party

2100H

disabilities

Disabilities

List of Disability

2200

reportingCategories

Reporting categories

List of ReportingCategory

2750

healthCoverages

Health coverages

List of HealthCoverage

2300

transaction

Parent EDI transaction for this object

Transaction834

ST

Member

Loop: 2100A, Segment: NM1 Open API Schema
NameDescriptionTypeEDI Reference

maritalStatusCode

Marital status code

String

DMG04

ethnicityCode

Ethnicity code

Deprecated: Use 'ethnicityCodes' instead

String

DMG05

ethnicityCodes

Ethnicity codes

Since: v2.14.8

List of String

DMG05

citizenshipCode

Citizenship code

String

DMG06

employmentClassCodes

Employment class codes

List of String

EC01
EC02
EC03

wageFrequencyCode

Wage frequency code

String

ICM01

wageAmount

Wage amount

Number

ICM02

workHoursCount

Work hours count

Number

ICM03

employerLocationIdentificationCode

Employer location identification code

String

ICM04

salaryGradeCode

Salary grade code

String

ICM05

healthRelatedCode

Health related code

String

HLH01

height

Height

Number

HLH02

weight

Weight

Number

HLH03

languageInfo

Language info

Deprecated: Use 'languages' instead

LanguageInfo

LUI

languages

Languages

Since: v2.14.8

List of LanguageInfo

LUI

Health Coverage

Loop: 2300, Segment: HD Open API Schema
NameDescriptionTypeEDI Reference

maintenanceTypeCode

Maintenance type code

String

HD01

insuranceLineCode

Insurance line code

String

HD03

planDescription

Plan description

String

HD04

coverageLevelCode

Coverage level code

String

HD05

lateEnrollmentIndicator

Late enrollment indicator

String

HD09

coverageDates

Coverage dates

List of Date

DTP

contractAmounts

Contract amounts

List of Amount

AMT

groupOrPolicyNumbers

Group or policy numbers

List of Reference

REF

priorCoverageMonthCount

Prior coverage month count

String

REF02*QQ

providers

Providers

List of Party

cobs

Coordination of Benefits

List of CoordinationOfBenefits

Organization ID and Name

NameDescriptionTypeEDI Reference

entityRole

Entity role

View codes and descriptions

String

Required

NM101
N101

entityType

Type of this entity: 'BUSINESS' for organization, 'INDIVIDUAL' for person

Values:

BUSINESS(2), INDIVIDUAL(1)

String (enum)

Required

NM102

identificationType

Identification type, e.g., NPI or EIN. This is a qualifier code translated to a string constant (enum)

View codes and descriptions

String

NM108
N103

identifier

Identifier

String

NM109
N104

taxId

Tax id

String

REF02*TJ
REF02*SY
REF02*EI

lastNameOrOrgName

Organization name or person last name

String

NM103
N102

firstName

First name

String

NM104

middleName

Middle name

String

NM105

Organization or Person (Party)

Extends: PartyIdName
NameDescriptionTypeEDI Reference

address

Address

Address

contacts

Contacts

List of ContactInfo

additionalIds

Other identifications

List of Reference

REF

TPA

Loop: 1000C,1100C Open API Schema
Extends: Party
NameDescriptionTypeEDI Reference

accountNumber

Account number

String

ACT01

accountNumber2

Account number2

String

ACT06

Disability

Loop: 2200 Open API Schema
NameDescriptionTypeEDI Reference

typeCode

Type code

String

DSB01

diagnosisCode

Diagnosis code

String

DSB08

dateFrom

Date from

Date

DTP03*360

dateTo

Date to

Date

DTP03*361

Coordination of Benefits

Loop: 2320, Segment: COB Open API Schema
NameDescriptionTypeEDI Reference

payerResponsibilitySequenceCode

Payer responsibility sequence code

String

COB01

groupOrPolicyNumber

Group or policy number

String

COB02

coordinationOfBenefitsCode

Coordination of benefits code

String

COB03

serviceTypeCodes

Service type codes

Since: v2.14.8

List of String

COB04

additionalIdentifiers

Additional identifiers

List of Reference

REF

dateFrom

Date from

Date

DTP03*344

dateTo

Date to

Date

DTP03*345

insurers

Insurers

List of Party

Person with Demographic Info

Extends: Party
NameDescriptionTypeEDI Reference

birthDate

Birth date

Date

DMG02

gender

Gender

Values:

FEMALE(F), MALE(M), UNKNOWN(U)

String (enum)

DMG03

Address

NameDescriptionTypeEDI Reference

line

Line

String

Required

N301

line2

Line2

String

N302

city

City

String

Required

N401

stateCode

State code

String

N402

zipCode

Zip code

String

N403

countryCode

Country code

String

N404

locationQualifier

Location qualifier; only used for 834 transaction

Since: v2.14.8

String

N405

locationIdentifier

Location identifier; only used for 834 transaction

Since: v2.14.8

String

N406

countrySubdivisionCode

Country subdivision code; only used for 834 transaction

Since: v2.14.8

String

N407

Contact Info

Segment: PER Open API Schema
NameDescriptionTypeEDI Reference

functionCode

Function code

String

Required

PER01

name

Name

String

PER02

contactNumbers

Contact numbers

List of ContactNumber

Contact Number

Segment: PER Open API Schema
NameDescriptionTypeEDI Reference

type

Type of contact number

Values:

ALTERNATE_PHONE, BEEPER, CELL_PHONE, EMAIL, EXTENSION, FAX, HOME_PHONE, PHONE, UNKNOWN, URL, WORK_PHONE

String (enum)

Required

PER03
PER05
PER07

number

Number

String

Required

PER04
PER06
PER08

Reporting Category

NameDescriptionTypeEDI Reference

name

Name

String

N102

identifierQualifierCode

Identifier qualifier code

String

REF01

identifierType

Identifier type

String

REF01

identifier

Identifier

String

REF02

date

Effective date

Date

DTP03*007

dateTo

End date

Date

DTP03

Language Info

Segment: LUI Open API Schema
NameDescriptionTypeEDI Reference

codeQualifier

Code qualifier

String

LUI01

code

Code

String

LUI02

languageDescription

Language description

String

LUI03

languageUseIndicator

Language use indicator

String

LUI04

Date

Segment: DTP Open API Schema
NameDescriptionTypeEDI Reference

qualifierCode

Code specifying type of date or time

String

DTP01

type

Type of date; qualifier code translated to a mnemonic string constant (enum)

View codes and descriptions

String

DTP01

date

The date value or the first date of the date range ('RD8' qualifier)

Date

DTP03

dateTo

The second date if the value is the date range ('RD8' qualifier), otherwise null

Date

DTP03

Reference Identifications

Segment: REF Open API Schema
NameDescriptionTypeEDI Reference

qualifierCode

Code qualifying the reference identification

String

Required

REF01

type

Type of reference; qualifier code as a string constant (enum)

View codes and descriptions

String

REF01

identification

Reference identification

String

Required

REF02

Amount

Segment: AMT Open API Schema
NameDescriptionTypeEDI Reference

qualifierCode

Code specifying the type of amount (amount qualifier code)

String

Required

AMT01

type

Type of amount; qualifier code translated to a mnemonic string constant (enum)

View codes and descriptions

String

AMT01

amount

Amount

Number

Required

AMT02

Quantity

Segment: QTY Open API Schema
NameDescriptionTypeEDI Reference

qualifierCode

Code specifying the type of quantity (quantity qualifier code)

String

Required

QTY01

type

Type of quantity; qualifier code translated to a mnemonic string constant (enum)

View codes and descriptions

String

QTY01

quantity

Quantity

Number

Required

QTY02

EDI Transaction Info

NameDescriptionTypeEDI Reference

controlNumber

Control number

String

ST02

transactionType

Transaction type translated to string constant, PROF for 837P, INST for 837I, etc.

String

ST01
ST03

purposeCode

Purpose code

String

BGN01

originatorApplicationTransactionId

Originator application transaction id

String

BGN02

creationDate

Creation date

Date

BGN03

creationTime

Creation time

Time

BGN04

originalTransactionSetReferenceNumber

Original transaction set reference number

String

BGN06

actionCode

Action code

String

BGN08

transactionSetIdentifierCode

Transaction set identifier code

String

ST01

implementationConventionReference

Implementation convention reference

String

ST03

fileEffectiveDates

File effective dates

List of Date

DTP

controlTotals

Control totals

List of Quantity

QTY

fileInfo

File info

FileInfo

File Info

NameDescriptionType

name

File name

String

url

URL of the file, including the full path

String

lastModifiedDateTime

Last modified date and time of the file

Date and Time