837I Health Care Claim: Institutional (005010X223A2)

Hospitals and other facilities send the 837I to submit institutional claims, the electronic UB-04, to payers and clearinghouses. This is the standard X12 HIPAA 005010 spec, with 59 loops and 273 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.

Loading the spec…
The spec as an OpenAPI 3 schema with x-openedi-* extensions, for ediFabric Native, ediFabric Cloud and the EDI Spec Builder. Download OpenEDI (492 KB) Generate classes
The ediFabric .NET template, class TS837I. The download includes the common segments, composites and codes it needs. Download C# (95 KB)
The intermediary model ediFabric Native loads with set_map. Download Native (225 KB)

Use the 837I spec in your code

ediFabric .NET

Add the C# template and its common files to your project, or reference the template NuGet package, and read 837I files into TS837I objects. See ediFabric .NET.

ediFabric Native

Map version 005010X223A2 to the Native model with set_map, then parse 837I files to JSON from Python, Java, C or C#. See Convert between EDI and JSON.

OpenEDI

Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.

Generate 837I classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 837I as JSON, with the property names of the OpenEDI schema. To work with that JSON as typed objects, generate classes from the OpenEDI file in your language and deserialize the JSON into TS837I. Serialize the objects back to JSON to build EDI with ediFabric Native. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats, so validate files with ediFabric Native. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

For a sample file, the same data as JSON, and code to parse, validate and generate the 837I, see the 837I transaction guide.

837I structure

Loops and segments of the standard 837I, with their usage and maximum repeats.

IDNameUsageMax use
STTransaction Set HeaderOptional1
BHTBeginning Of Hierarchical TransactionMandatory1
Loop 1000ASubmitter NameMandatory1
NM1Submitter NameMandatory1
PERSubmitter EDI Contact InformationMandatory2
Loop 1000BReceiver NameMandatory1
NM1Receiver NameMandatory1
Loop 2000ABilling Provider Hierarchical LevelMandatory>1
HLBilling Provider Hierarchical LevelMandatory1
PRVBilling Provider Specialty InformationOptional1
CURForeign Currency InformationOptional1
Loop 2010AABilling Provider NameMandatory1
NM1Billing Provider NameMandatory1
N3Billing Provider AddressMandatory1
N4Billing Provider City State ZIP CodeMandatory1
REFBilling Provider Tax IdentificationMandatory1
PERBilling Provider Contact InformationOptional2
Loop 2010ABPay Address NameOptional1
NM1Pay Address NameMandatory1
N3Pay To Address ADDRESSMandatory1
N4Pay Address City State ZIP CodeMandatory1
Loop 2010ACPay To Plan NameOptional1
NM1Pay To Plan NameMandatory1
N3Pay To Plan AddressMandatory1
N4Pay To Plan City State Zip CodeMandatory1
REFPay To Plan Secondary IdentificationOptional1
REFPay To Tax Identification NumberMandatory1
Loop 2000BSubscriber Hierarchical LevelMandatory>1
HLSubscriber Hierarchical LevelMandatory1
SBRSubscriber InformationMandatory1
Loop 2010BASubscriber NameMandatory1
NM1Subscriber NameMandatory1
N3Subscriber AddressOptional1
N4Subscriber City State ZIP CodeOptional1
DMGSubscriber Demographic InformationOptional1
REFSubscriber Secondary IdentificationOptional1
REFPropertyand Casualty Claim NumberOptional1
Loop 2010BBPayer NameMandatory1
NM1Payer NameMandatory1
N3Payer AddressOptional1
N4Payer City State ZIP CodeOptional1
REFPayer Secondary IdentificationOptional3
REFBilling Provider Secondary IdentificationOptional1
Loop 2300Claim InformationOptional100
CLMClaim InformationMandatory1
DTPDischarge HourOptional1
DTPStatement DatesMandatory1
DTPAdmission Date HourOptional1
DTPDate Repricer Received DateOptional1
CL1Institutional Claim CodeMandatory1
PWKClaim Supplemental InformationOptional10
CN1Contract InformationOptional1
AMTPatient Estimated Amount DueOptional1
REFService Authorization Exception CodeOptional1
REFReferral NumberOptional1
REFPrior AuthorizationOptional1
REFPayer Claim Control NumberOptional1
REFRepriced Claim NumberOptional1
REFAdjusted Repriced Claim NumberOptional1
REFInvestigational Device Exemption NumberOptional5
REFClaim Identifier For Transmission IntermediariesOptional1
REFAuto Accident StateOptional1
REFMedical Record NumberOptional1
REFDemonstration Project IdentifierOptional1
REFPeer Review Organization PRO Approval NumberOptional1
K3File InformationOptional10
NTEClaim NoteOptional10
NTEBilling NoteOptional1
CRCEPSDT ReferralOptional1
HIPrincipal DiagnosisMandatory1
HIAdmitting DiagnosisOptional1
HIPatient Reason For VisitOptional1
HIExternal Causeof InjuryOptional1
HIDiagnosis Related Group DRG InformationOptional1
HIOther Diagnosis InformationOptional2
HIPrincipal Procedure InformationOptional1
HIOther Procedure InformationOptional2
HIOccurrence Span InformationOptional2
HIOccurrence InformationOptional2
HIValue InformationOptional2
HICondition InformationOptional2
HITreatment Code InformationOptional2
HCPClaim Pricing Repricing InformationOptional1
Loop 2310AAttending Provider NameOptional1
NM1Attending Provider NameMandatory1
PRVAttending Provider Specialty InformationOptional1
REFAttending Provider Secondary IdentificationOptional4
Loop 2310BOperating Physician NameOptional1
NM1Operating Physician NameMandatory1
REFOperating Physician Secondary IdentificationOptional4
Loop 2310COther Operating Physician NameOptional1
NM1Other Operating Physician NameMandatory1
REFOther Operating Physician Secondary IdentificationOptional4
Loop 2310DRendering Provider NameOptional1
NM1Rendering Provider NameMandatory1
REFRendering Provider Secondary IdentificationOptional4
Loop 2310EService Facility Location NameOptional1
NM1Service Facility Location NameMandatory1
N3Service Facility Location AddressMandatory1
N4Service Facility Location City State ZIPMandatory1
REFService Facility Secondary IdentificationOptional3
Loop 2310FReferring Provider NameOptional1
NM1Referring Provider NameMandatory1
REFReferring Provider Secondary IdentificationOptional3
Loop 2320Other Subscriber InformationOptional10
SBROther Subscriber InformationMandatory1
CASClaim Level AdjustmentsOptional5
AMTCoordinationof Benefits COB Payer Paid AmountOptional1
AMTRemaining Patient LiabilityOptional1
AMTCoordinationof Benefits COB Total Non AmountOptional1
OIOther Insurance Coverage InformationMandatory1
MIAInpatient Adjudication InformationOptional1
MOAOutpatient Adjudication InformationOptional1
Loop 2330AOther Subscriber NameMandatory1
NM1Other Subscriber NameMandatory1
N3Other Subscriber AddressOptional1
N4Other Subscriber City State ZIP CodeOptional1
REFOther Subscriber Secondary InformationOptional2
Loop 2330BOther Payer NameMandatory1
NM1Other Payer NameMandatory1
N3Other Payer AddressOptional1
N4Other Payer City State ZIP CodeOptional1
DTPClaim Check Or Remittance DateOptional1
REFOther Payer Secondary IdentifierOptional2
REFOther Payer Prior Authorization NumberOptional1
REFOther Payer Referral NumberOptional1
REFOther Payer Claim Adjustment IndicatorOptional1
REFOther Payer Claim Control NumberOptional1
Loop 2330COther Payer Attending ProviderOptional1
NM1Other Payer Attending ProviderMandatory1
REFOther Payer Attending Provider Secondary IdentificationMandatory4
Loop 2330DOther Payer Operating PhysicianOptional1
NM1Other Payer Operating PhysicianMandatory1
REFOther Payer Operating Physician Secondary IdentificationMandatory4
Loop 2330EOther Payer Other Operating PhysicianOptional1
NM1Other Payer Other Operating PhysicianMandatory1
REFOther Payer Other Operating Physician Secondary IdentificationMandatory4
Loop 2330FOther Payer Service Facility LocationOptional1
NM1Other Payer Service Facility LocationMandatory1
REFOther Payer Service Facility Location Secondary IdentificationMandatory3
Loop 2330GOther Payer Rendering Provider NameOptional1
NM1Other Payer Rendering Provider NameMandatory1
REFOther Payer Rendering Provider Secondary IdentifierMandatory4
Loop 2330HOther Payer Referring ProviderOptional1
NM1Other Payer Referring ProviderMandatory1
REFOther Payer Referring Provider Secondary IdentificationMandatory3
Loop 2330IOther Payer Billing ProviderOptional1
NM1Other Payer Billing ProviderMandatory1
REFOther Payer Billing Provider Secondary IdentifierMandatory2
Loop 2400Service Line NumberMandatory999
LXService Line NumberMandatory1
SV2Institutional Service LineMandatory1
PWKLine Supplemental InformationOptional10
DTPDate Service DateOptional1
REFLine Item Control NumberOptional1
REFRepriced Line Item Reference NumberOptional1
REFAdjusted Repriced Line Item Reference NumberOptional1
AMTService Tax AmountOptional1
AMTFacility Tax AmountOptional1
NTEThird Party Organization NotesOptional1
HCPLine Pricing Repricing InformationOptional1
Loop 2410Drug IdentificationOptional1
LINDrug IdentificationMandatory1
CTPDrug QuantityMandatory1
REFPrescriptionor Compound Drug Association NumberOptional1
Loop 2420AOperating Physician NameOptional1
NM1Operating Physician NameMandatory1
REFOperating Physician Secondary IdentificationOptional20
Loop 2420BOther Operating Physician NameOptional1
NM1Other Operating Physician NameMandatory1
REFOther Operating Physician Secondary IdentificationOptional20
Loop 2420CRendering Provider NameOptional1
NM1Rendering Provider NameMandatory1
REFRendering Provider Secondary IdentificationOptional20
Loop 2420DReferring Provider NameOptional1
NM1Referring Provider NameMandatory1
REFReferring Provider Secondary IdentificationOptional20
Loop 2430Line Adjudication InformationOptional15
SVDLine Adjudication InformationMandatory1
CASLine AdjustmentOptional5
DTPLine Checkor Remittance DateMandatory1
AMTRemaining Patient LiabilityOptional1
Loop 2000CPatient Hierarchical LevelOptional>1
HLPatient Hierarchical LevelMandatory1
PATPatient InformationMandatory1
Loop 2010CAPatient NameMandatory1
NM1Patient NameMandatory1
N3Patient AddressMandatory1
N4Patient City State ZIP CodeMandatory1
DMGPatient Demographic InformationMandatory1
REFPropertyand Casualty Claim NumberOptional1
REFPropertyand Casualty Patient IdentifierOptional1
Loop 2300Claim InformationMandatory100
CLMClaim InformationMandatory1
DTPDischarge HourOptional1
DTPStatement DatesMandatory1
DTPAdmission Date HourOptional1
DTPDate Repricer Received DateOptional1
CL1Institutional Claim CodeMandatory1
PWKClaim Supplemental InformationOptional10
CN1Contract InformationOptional1
AMTPatient Estimated Amount DueOptional1
REFService Authorization Exception CodeOptional1
REFReferral NumberOptional1
REFPrior AuthorizationOptional1
REFPayer Claim Control NumberOptional1
REFRepriced Claim NumberOptional1
REFAdjusted Repriced Claim NumberOptional1
REFInvestigational Device Exemption NumberOptional5
REFClaim Identifier For Transmission IntermediariesOptional1
REFAuto Accident StateOptional1
REFMedical Record NumberOptional1
REFDemonstration Project IdentifierOptional1
REFPeer Review Organization PRO Approval NumberOptional1
K3File InformationOptional10
NTEClaim NoteOptional10
NTEBilling NoteOptional1
CRCEPSDT ReferralOptional1
HIPrincipal DiagnosisMandatory1
HIAdmitting DiagnosisOptional1
HIPatient Reason For VisitOptional1
HIExternal Causeof InjuryOptional1
HIDiagnosis Related Group DRG InformationOptional1
HIOther Diagnosis InformationOptional2
HIPrincipal Procedure InformationOptional1
HIOther Procedure InformationOptional2
HIOccurrence Span InformationOptional2
HIOccurrence InformationOptional2
HIValue InformationOptional2
HICondition InformationOptional2
HITreatment Code InformationOptional2
HCPClaim Pricing Repricing InformationOptional1
Loop 2310AAttending Provider NameOptional1
NM1Attending Provider NameMandatory1
PRVAttending Provider Specialty InformationOptional1
REFAttending Provider Secondary IdentificationOptional4
Loop 2310BOperating Physician NameOptional1
NM1Operating Physician NameMandatory1
REFOperating Physician Secondary IdentificationOptional4
Loop 2310COther Operating Physician NameOptional1
NM1Other Operating Physician NameMandatory1
REFOther Operating Physician Secondary IdentificationOptional4
Loop 2310DRendering Provider NameOptional1
NM1Rendering Provider NameMandatory1
REFRendering Provider Secondary IdentificationOptional4
Loop 2310EService Facility Location NameOptional1
NM1Service Facility Location NameMandatory1
N3Service Facility Location AddressMandatory1
N4Service Facility Location City State ZIPMandatory1
REFService Facility Secondary IdentificationOptional3
Loop 2310FReferring Provider NameOptional1
NM1Referring Provider NameMandatory1
REFReferring Provider Secondary IdentificationOptional3
Loop 2320Other Subscriber InformationOptional10
SBROther Subscriber InformationMandatory1
CASClaim Level AdjustmentsOptional5
AMTCoordinationof Benefits COB Payer Paid AmountOptional1
AMTRemaining Patient LiabilityOptional1
AMTCoordinationof Benefits COB Total Non AmountOptional1
OIOther Insurance Coverage InformationMandatory1
MIAInpatient Adjudication InformationOptional1
MOAOutpatient Adjudication InformationOptional1
Loop 2330AOther Subscriber NameMandatory1
NM1Other Subscriber NameMandatory1
N3Other Subscriber AddressOptional1
N4Other Subscriber City State ZIP CodeOptional1
REFOther Subscriber Secondary InformationOptional2
Loop 2330BOther Payer NameMandatory1
NM1Other Payer NameMandatory1
N3Other Payer AddressOptional1
N4Other Payer City State ZIP CodeOptional1
DTPClaim Check Or Remittance DateOptional1
REFOther Payer Secondary IdentifierOptional2
REFOther Payer Prior Authorization NumberOptional1
REFOther Payer Referral NumberOptional1
REFOther Payer Claim Adjustment IndicatorOptional1
REFOther Payer Claim Control NumberOptional1
Loop 2330COther Payer Attending ProviderOptional1
NM1Other Payer Attending ProviderMandatory1
REFOther Payer Attending Provider Secondary IdentificationMandatory4
Loop 2330DOther Payer Operating PhysicianOptional1
NM1Other Payer Operating PhysicianMandatory1
REFOther Payer Operating Physician Secondary IdentificationMandatory4
Loop 2330EOther Payer Other Operating PhysicianOptional1
NM1Other Payer Other Operating PhysicianMandatory1
REFOther Payer Other Operating Physician Secondary IdentificationMandatory4
Loop 2330FOther Payer Service Facility LocationOptional1
NM1Other Payer Service Facility LocationMandatory1
REFOther Payer Service Facility Location Secondary IdentificationMandatory3
Loop 2330GOther Payer Rendering Provider NameOptional1
NM1Other Payer Rendering Provider NameMandatory1
REFOther Payer Rendering Provider Secondary IdentifierMandatory4
Loop 2330HOther Payer Referring ProviderOptional1
NM1Other Payer Referring ProviderMandatory1
REFOther Payer Referring Provider Secondary IdentificationMandatory3
Loop 2330IOther Payer Billing ProviderOptional1
NM1Other Payer Billing ProviderMandatory1
REFOther Payer Billing Provider Secondary IdentifierMandatory2
Loop 2400Service Line NumberMandatory999
LXService Line NumberMandatory1
SV2Institutional Service LineMandatory1
PWKLine Supplemental InformationOptional10
DTPDate Service DateOptional1
REFLine Item Control NumberOptional1
REFRepriced Line Item Reference NumberOptional1
REFAdjusted Repriced Line Item Reference NumberOptional1
AMTService Tax AmountOptional1
AMTFacility Tax AmountOptional1
NTEThird Party Organization NotesOptional1
HCPLine Pricing Repricing InformationOptional1
Loop 2410Drug IdentificationOptional1
LINDrug IdentificationMandatory1
CTPDrug QuantityMandatory1
REFPrescriptionor Compound Drug Association NumberOptional1
Loop 2420AOperating Physician NameOptional1
NM1Operating Physician NameMandatory1
REFOperating Physician Secondary IdentificationOptional20
Loop 2420BOther Operating Physician NameOptional1
NM1Other Operating Physician NameMandatory1
REFOther Operating Physician Secondary IdentificationOptional20
Loop 2420CRendering Provider NameOptional1
NM1Rendering Provider NameMandatory1
REFRendering Provider Secondary IdentificationOptional20
Loop 2420DReferring Provider NameOptional1
NM1Referring Provider NameMandatory1
REFReferring Provider Secondary IdentificationOptional20
Loop 2430Line Adjudication InformationOptional15
SVDLine Adjudication InformationMandatory1
CASLine AdjustmentOptional5
DTPLine Checkor Remittance DateMandatory1
AMTRemaining Patient LiabilityOptional1
SETransaction Set TrailerOptional1