JSON Schema for 837I (Institutional Claim)

Overview

Resources:

Claim

NameDescriptionTypeEDI Reference

id

Unique payment identifier assigned by the converter

String

objectType

Type of this object, set to 'CLAIM'

String

patientControlNumber

Identifier used to track a claim from creation by the health care provider through payment

String

Required

CLM01

chargeAmount

Charge amount

Number

Required

CLM02

facilityCode

Place of service code (professional/dental) or UB facility code (institutional) from the original claim

View codes and descriptions

Code

Required

CLM05-1

frequencyCode

Frequency code

View codes and descriptions

Code

Required

CLM05-3

statementDateFrom

Statement date from

Date

DTP03*434

statementDateTo

Statement date to

Date

DTP03*434

serviceDateFrom

The earliest service date from service lines

Date

serviceDateTo

The latest service date from service lines

Date

subscriber

The insured (subscriber)

Subscriber

2000B

patient

Patient if different from the the insured (subscriber)

Patient

2110CA

otherSubscribers

Other subscribers and their payer's information

List of OtherSubscriber

2320

serviceLines

Service lines

List of InstLine

2400

transaction

Parent EDI transaction for this object

Transaction837

ST

assignmentParticipationCode

Assignment participation code

String

Required

CLM07

assignmentCertificationIndicator

Assignment certification indicator

String

Required

CLM08

releaseOfInformationCode

Release of information code

String

Required

CLM09

delayReasonCode

Delay reason code

String

CLM20

serviceAuthorizationExceptionCode

Service authorization exception code

String

REF02*4N

referralNumber

Referral number

String

REF02*9F

priorAuthorizationNumber

Prior authorization number

String

REF02*G1

originalReferenceNumber

Original reference number

String

REF02*F8

repricedReferenceNumber

Repriced reference number

String

REF02*9A

adjustedRepricedReferenceNumber

Adjusted repriced reference number

String

REF02*9C

clearinghouseTraceNumber

Clearinghouse trace number

String

REF02*D9

accidentState

Accident state

String

REF02*LU

medicalRecordNumber

Medical record number

String

REF02*EA

peerReviewAuthorizationNumber

Peer review authorization number

String

REF02*G4

demonstrationProjectIdentifier

Demonstration project identifier

String

REF02*P4

admissionDateAndHour

Admission date and hour

Date and Time

DTP03*435

dischargeTime

Discharge time

Time

DTP03*096

admissionTypeCode

Admission type code

String

CL101

admissionSourceCode

Admission source code

String

CL102

patientStatusCode

Patient status code

String

Required

CL103

patientResponsibilityAmount

Patient responsibility amount

Number

AMT02*F3

fixedFormatRecords

Fixed format records

List of String

K301

claimNote

Free-form comments or instructions. All note segments are concatenated together into this field

String

NTE02

billingNote

Billing note

String

NTE02*ADD

billingProvider

Billing provider

Provider

NM1*85

payToAddress

Pay to address

Party

NM1*87

payToPlan

Pay-to plan for subrogation claims

Party

NM1*PE

providers

Providers for this claim, except for the billing provider

List of Provider

diags

Diagnosis codes

List of InstDiagnosis

Required

HI

drg

Drg

Code

HI*DR

procs

Claim-level procedures

View codes and descriptions

List of CodeAndDate

HI

occurrenceSpans

Occurrence spans

View codes and descriptions

List of CodeAndDate

HI*BI

occurrences

Occurrences

View codes and descriptions

List of CodeAndDate

HI*BH

valueInfos

Value infos

View codes and descriptions

List of CodeAndAmount

HI*BE

conditions

Conditions

View codes and descriptions

List of Code

HI*BG

attachments

Attachments

List of Attachment

PWK

contractInfo

Contract info

ContractInfo

CN1

conditionsIndicators

Conditions indicators

List of ConditionsIndicator

CRC

Service Line

Loop: 2400, Segment: SV2 Open API Schema
NameDescriptionTypeEDI Reference

sourceLineId

Line item control number

String

REF02*6R

repricedReferenceNumber

Repriced reference number

String

REF02*9B

adjustedRepricedReferenceNumber

Adjusted repriced reference number

String

REF02*9D

chargeAmount

Charge amount

Number

Required

SV203

nonCoveredAmount

Non covered amount

Number

SV207

serviceTaxAmount

Service tax amount

Number

AMT02*GT

facilityTaxAmount

Facility tax amount

Number

AMT02*N8

serviceDateFrom

Service date from

Date

DTP03*472

serviceDateTo

Service date to

Date

DTP03*472

unitType

Unit type

String

Required

SV204

unitCount

Unit count

Number

Required

SV205

thirdPartyNote

Third party note

String

NTE02*TPO

procedure

Procedure

View codes and descriptions

Procedure

SV202*HC
SV202*AD
SV202*WK
SV202*IV

revenueCode

Revenue code

View codes and descriptions

Code

SV201*RC,NU

attachments

Attachments

List of Attachment

PWK

contractInfo

Contract info

ContractInfo

CN1

providers

Providers for this service line

List of Provider

adjudications

Adjudications

List of Adjudication

2430

SVD

adjustments

Copy of line adjustments from the adjudication list for backward compatibility

List of Adjustment

CAS

fixedFormatRecords

Fixed format records

List of String

K301

Subscriber

NameDescriptionTypeEDI Reference

payerResponsibilitySequence

Payer responsibility sequence

Values:

EIGHT(E), ELEVEN(H), FIVE(B), FOUR(A), NINE(F), PRIMARY(P), SECONDARY(S), SEVEN(D), SIX(C), TEN(G), TERTIARY(T), UNCONFIRMED(N), UNKNOWN(U)

String (enum)

Required

SBR01

relationshipType

Relationship type

Values:

CADAVER_DONOR(40), CHILD(19), EMPLOYEE(20), LIFE_PARTNER(53), ORGAN_DONOR(39), OTHER(G8), SELF(18), SPOUSE(1), UNKNOWN(21)

String (enum)

SBR02
PAT01

groupOrPolicyNumber

Group or policy number

String

SBR03

groupName

Group name

String

SBR04

claimFilingIndicatorCode

Claim filing indicator code

String

SBR09

insurancePlanType

Insurance plan type

Values:

AUTOMOBILE_MEDICAL(AM), BCBS(BL), CHAMPUS(CH), COMMERCIAL(CI), EPO(14), FEDERAL_EMPLOYEE_PROGRAM(FI), HMO(HM), HMO_MEDICARE(16), INDEMNITY_INSURANCE(15), MEDICAID(MC), MEDICARE_A(MA), MEDICARE_B(MB), MUTUALLY_DEFINED(ZZ), OTHER_FEDERAL(OF), OTHER_NON_FEDERAL(11), POS(13), PPO(12), VETERAN_AFFAIRS(VA), WORKERS_COMPENSATION(WC)

String (enum)

SBR09

person

Person

PersonWithDemographic

NM1

deathDate

Death date

Date

PAT06

weight

Patient weight in pounds

Number

PAT08

pregnancyIndicator

Pregnancy indicator

String

PAT09

propertyCasualtyClaimNumber

Property casualty claim number

String

REF02*Y4

payer

Payer

Party

2330B

NM1*PR

Patient

NameDescriptionTypeEDI Reference

relationshipType

Relationship type

Values:

CADAVER_DONOR(40), CHILD(19), EMPLOYEE(20), LIFE_PARTNER(53), ORGAN_DONOR(39), OTHER(G8), SELF(18), SPOUSE(1), UNKNOWN(21)

String (enum)

SBR02
PAT01

person

Person

PersonWithDemographic

NM1

deathDate

Death date

Date

PAT06

weight

Patient weight in pounds

Number

PAT08

pregnancyIndicator

Pregnancy indicator

String

PAT09

Other Subscriber

NameDescriptionTypeEDI Reference

payerResponsibilitySequence

Payer responsibility sequence

Values:

EIGHT(E), ELEVEN(H), FIVE(B), FOUR(A), NINE(F), PRIMARY(P), SECONDARY(S), SEVEN(D), SIX(C), TEN(G), TERTIARY(T), UNCONFIRMED(N), UNKNOWN(U)

String (enum)

Required

SBR01

relationshipType

Relationship type

Values:

CADAVER_DONOR(40), CHILD(19), EMPLOYEE(20), LIFE_PARTNER(53), ORGAN_DONOR(39), OTHER(G8), SELF(18), SPOUSE(1), UNKNOWN(21)

String (enum)

SBR02
PAT01

groupOrPolicyNumber

Group or policy number

String

SBR03

groupName

Group name

String

SBR04

coordinationOfBenefitsCode

Coordination of benefits code, post-adjudicated claims only

String

SBR06

claimFilingIndicatorCode

Claim filing indicator code

String

SBR09

insurancePlanType

Insurance plan type

Values:

AUTOMOBILE_MEDICAL(AM), BCBS(BL), CHAMPUS(CH), COMMERCIAL(CI), EPO(14), FEDERAL_EMPLOYEE_PROGRAM(FI), HMO(HM), HMO_MEDICARE(16), INDEMNITY_INSURANCE(15), MEDICAID(MC), MEDICARE_A(MA), MEDICARE_B(MB), MUTUALLY_DEFINED(ZZ), OTHER_FEDERAL(OF), OTHER_NON_FEDERAL(11), POS(13), PPO(12), VETERAN_AFFAIRS(VA), WORKERS_COMPENSATION(WC)

String (enum)

SBR09

person

Person

PersonWithDemographic

NM1

adjustments

Claim-level adjustments from this payer

List of Adjustment

CAS

payerPaidAmount

Payer paid amount

Number

AMT02*D

nonCoveredAmount

Non covered amount

Number

AMT02*A8

remainingPatientLiabilityAmount

Remaining patient liability amount

Number

AMT02*EAF

outpatientAdjudication

Outpatient adjudication

OutpatientAdjudication

MOA

payerPriorAuthorizationNumber

Payer prior authorization number

String

REF02*G1

payerReferralNumber

Payer referral number

String

REF02*9F

payerClaimControlNumber

Payer claim control number

String

REF02*F8

payer

Payer

Party

2330B

NM1*PR

patient

Patient's information; post-adjudicated claims only

Party

2330C

NM1*QC

providers

Other payer's providers

List of Party

NM1

Outpatient Adjudication

Contains Remittance Advice Remark Codes at the claim level and/or Medicare or Medicaid-specific amounts for outpatient claims
Segment: MOA Open API Schema
NameDescriptionTypeEDI Reference

reimbursementRate

Reimbursement rate

Number

MOA01

hcpcsPayableAmount

Claim HCPCS Payable Amount

Number

MOA02

esrdPaymentAmount

Esrd payment amount

Number

MOA08

nonPayableProfessionalComponentAmount

Nonpayable Professional Component Amount

Number

MOA09

remarks

Remark codes

View codes and descriptions

List of Code

MOA3:7

Inpatient Adjudication

Contains Remittance Advice Remark Codes at the claim level and/or Medicare or Medicaid-specific amounts for inpatient institutional claims
Segment: MIA Open API Schema
NameDescriptionTypeEDI Reference

coveredDaysOrVisitsCount

Covered days or visits count

Integer

Required

MIA01

ppsOperatingOutlierAmount

Pps operating outlier amount

Number

MIA02

lifetimePsychiatricDaysCount

Lifetime psychiatric days count

Integer

MIA03

drgAmount

Drg amount

Number

MIA04

disproportionateShareAmount

Disproportionate share amount

Number

MIA06

mspPassThroughAmount

Msp pass through amount

Number

MIA07

ppsCapitalAmount

Pps capital amount

Number

MIA08

ppsCapitalFspDrgAmount

Pps capital fsp drg amount

Number

MIA09

ppsCapitalHspDrgAmount

Pps capital hsp drg amount

Number

MIA10

ppsCapitalDshDrgAmount

Pps capital dsh drg amount

Number

MIA11

oldCapitalAmount

Old capital amount

Number

MIA12

ppsCapitalImeAmount

Pps capital ime amount

Number

MIA13

ppsOperatingHospitalSpecificDrgAmount

Pps operating hospital specific drg amount

Number

MIA14

costReportDayCount

Cost report day count

Integer

MIA15

ppsOperatingFederalSpecificDrgAmount

Pps operating federal specific drg amount

Number

MIA16

ppsCapitalOutlierAmount

Pps capital outlier amount

Number

MIA17

indirectTeachingAmount

Indirect teaching amount

Number

MIA18

nonPayableProfessionalComponentAmount

Non payable professional component amount

Number

MIA19

ppsCapitalExceptionAmount

Pps capital exception amount

Number

MIA24

remarks

Remark codes

View codes and descriptions

List of Code

MIA05
MIA20
MIA21
MIA22
MIA23

Organization Or Person 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

Provider

Extends: Party
NameDescriptionTypeEDI Reference

providerTaxonomy

Provider's specialty information (taxonomy). Populated only for billing, rendering, operating providers.

View codes and descriptions

Code

PRV

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

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

Adjudication

Loop: 2430, Segment: SVD Open API Schema
NameDescriptionTypeEDI Reference

payerIdentifier

Payer identifier

String

SVD01

paidAmount

Paid amount

Number

SVD02

unitCount

Unit count

Number

SVD05

bundledOrUnbundledLineNumber

Bundled or unbundled line number

Integer

SVD06

procedure

Procedure

View codes and descriptions

Procedure

SVD03

adjustments

Line adjustments

List of Adjustment

CAS

adjudicationOrPaymentDate

Adjudication or payment date

Date

DTP03*573

remainingPatientLiabilityAmount

Remaining patient liability amount

Number

AMT02*EAF

Adjustment

Segment: CAS Open API Schema
NameDescriptionTypeEDI Reference

group

Claim adjustment group code as a string constant

Values:

CONTRACTUAL(CO), CORRECTION(CR), OTHER(OA), PATIENT_RESPONSIBILITY(PR), PAYOR_INITIATED(PI)

String (enum)

Required

CAS01

reason

Claim adjustment reason code

View codes and descriptions

Code

Required

CAS02

amount

Adjustment amount

Number

Required

CAS03

quantity

Adjustment quantity

Number

CAS04

Attachment

Segment: PWK Open API Schema
NameDescriptionTypeEDI Reference

reportTypeCode

Report type code

String

Required

PWK01

reportTransmissionCode

Report transmission code

String

Required

PWK02

controlNumber

Control number

String

PWK06

Contract Info

Required when the submitter is contractually obligated to supply this information on post-adjudicated claims
Segment: CN1 Open API Schema
NameDescriptionTypeEDI Reference

contractTypeCode

Contract type code

String

Required

CN101

amount

Amount

Number

CN102

percentage

Percentage

Number

CN103

contractCode

Contract code

String

CN104

termDiscountPercentage

Term discount percentage

Number

CN105

versionIdentifier

Version identifier

String

CN106

Conditions Indicator

Conditions Indicator: ambulance, patient, homebound, EPSDT
Segment: CRC Open API Schema
NameDescriptionTypeEDI Reference

categoryCode

Category code

String

Required

CRC01

category

Category code as constant (enum)

Values:

AMBULANCE_CERTIFICATION(07), DME_CERTIFICATION(09), EPSDT_MUTUALLY_DEFINED(ZZ), FUNCTIONAL_LIMITATIONS(75), HOSPICE(75), VISION_CONTACT_LENSES(E2), VISION_SPECTACLE_FRAMES(E3), VISION_SPECTACLE_LENSES(E1)

String (enum)

CRC01

yesOrNoCondition

Yes or no condition

Values:

Y, N

String

Required

CRC02

conditionCodes

Condition codes

List of String

CRC03
CRC04
CRC05
CRC06
CRC07

Diagnosis

Extends: Code
NameDescriptionTypeEDI Reference

presentOnAdmissionIndicator

Present on admission indicator

String

HI01-9

Procedure

Procedure code with description and optional modifiers
Segment: HI,SV1,SV2,SV3,SVC Open API Schema
Extends: Code
NameDescriptionTypeEDI Reference

modifiers

Modifiers

List of Code

837P:SV101-3-6
837I:SV201-3-6
835:SVC01-3-6
277:SVC01-3-6

Code with Date

The date is provided for procedures at a claim level and for occurrence codes.

Extends: Code
NameDescriptionTypeEDI Reference

occurrenceDate

Occurrence date

Date

Required

HI01-4

Code with Amount

The amount is provided for value codes

Extends: Code
NameDescriptionTypeEDI Reference

amount

Amount

Number

HI01-5

Code

Code and description
NameDescriptionType

subType

Healthcare code subtype, such as CPT, HCPCS, ICD_10, NDC

String

code

Healthcare code

String

Required

desc

Code description

String

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

hierarchicalStructureCode

Hierarchical structure code

String

BHT01

purposeCode

Purpose code

String

BHT02

originatorApplicationTransactionId

Originator application transaction id

String

BHT03

creationDate

Creation date

Date

BHT04

creationTime

Creation time

Time

BHT05

claimOrEncounterIdentifierType

Claim or encounter identifier type

String

BHT06

transactionSetIdentifierCode

Transaction set identifier code

String

ST01

implementationConventionReference

Implementation convention reference

String

ST03

fileInfo

File info

FileInfo

sender

Submitter or sender of this transaction

PartyIdName

receiver

Receiver of this transaction

PartyIdName

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