JSON Schema for 837P (Professional 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

patientPaidAmount

Patient paid amount

Number

AMT02*F5

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

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 ProfLine

2400

transaction

Parent EDI transaction for this object

Transaction837

ST

providerSignatureIndicator

Provider signature indicator

String

Required

CLM06

assignmentParticipationCode

Assignment participation code

String

Required

CLM07

assignmentCertificationIndicator

Assignment certification indicator

String

Required

CLM08

releaseOfInformationCode

Release of information code

String

Required

CLM09

patientSignatureSourceCode

Patient signature source code

String

CLM10

relatedCause

Related cause

RelatedCauseInfo

CLM11

specialProgramCode

Special program code

String

CLM12

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

medicalRecordNumber

Medical record number

String

REF02*EA

demonstrationProjectIdentifier

Demonstration project identifier

String

REF02*P4

onsetOfCurrentIllnessOrInjuryDate

Onset of current illness or injury date

Date

DTP03*431

initialTreatmentDate

Initial treatment date

Date

DTP03*454

lastSeenDate

Last seen date

Date

DTP03*304

acuteManifestationDate

Acute manifestation date

Date

DTP03*453

accidentDate

Accident date

Date

DTP03*439

lastMenstrualPeriodDate

Last menstrual period date

Date

DTP03*484

lastXRayDate

Last xray date

Date

DTP03*455

prescriptionDate

Hearing and vision prescription date

Date

DTP03*471

disabilityDateFrom

Disability date from

Date

DTP03*314

disabilityDateTo

Disability date to

Date

DTP03*361

lastWorkedDate

Last worked date

Date

DTP03*297

authorizedReturnToWorkDate

Authorized return to work date

Date

DTP03*296

admissionDate

Admission date for ambulance claims

Date

DTP03*435

dischargeDate

Discharge date

Date

DTP03*096

assumedCareDate

Assumed care date

Date

DTP03*090

relinquishedCareDate

Relinquished care date

Date

DTP03*091

propertyCasualtyFirstContactDate

Property casualty first contact date

Date

DTP03*444

repricerReceivedDate

Repricer received date

Date

DTP03*050

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

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

View codes and descriptions

List of Code

Required

HI

procs

Anesthesia-related procedures

View codes and descriptions

List of Code

HI

conditions

Conditions

View codes and descriptions

List of Code

HI*BG

attachments

Attachments

List of Attachment

PWK

contractInfo

Contract info

ContractInfo

CN1

ambulanceTransportInfo

Ambulance transport info

AmbulanceTransportInfo

CR1

spinalManipulationInfo

Spinal manipulation info

SpinalManipulationInfo

CR2

conditionsIndicators

Conditions indicators

List of ConditionsIndicator

CRC

Service Line

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

sourceLineId

Line item control number

String

REF02*6R

placeOfServiceCode

Place of service code

String

SV105

emergencyIndicator

Emergency indicator

String

SV109

epsdtIndicator

Epsdt indicator

String

SV111

familyPlanningIndicator

Family planning indicator

String

SV112

copayStatusCode

Copay status code

String

SV115

repricedReferenceNumber

Repriced reference number

String

REF02*9B

adjustedRepricedReferenceNumber

Adjusted repriced reference number

String

REF02*9D

priorAuthorization

Prior authorization

String

REF02*G1

referralNumber

Referral number

String

REF02*9F

chargeAmount

Charge amount

Number

Required

SV102

salesTaxAmount

Sales tax amount

Number

AMT02*T

purchasedServiceProviderIdentifier

Purchased service provider identifier

Since: v2.14.9

String

PS101

purchasedServiceChargeAmount

Purchased service charge amount

Since: v2.14.9

Number

PS102

serviceDateFrom

Service date from

Date

DTP03*472

serviceDateTo

Service date to

Date

DTP03*472

prescriptionDate

Prescription date

Date

DTP03*471

lastCertificationDate

Last certification date

Date

DTP03*461

certificationRevisionDate

Certification revision date

Date

DTP03*607

beginTherapyDate

Begin therapy date

Date

DTP03*463

lastSeenDate

Last seen date

Date

DTP03*304

testPerformedDate

Test performed date

Date

DTP03*738
DTP03*739

lastXRayDate

Last xray date

Date

DTP03*455

initialTreatmentDate

Initial treatment date

Date

DTP03*454

unitType

Unit type

String

Required

SV103

unitCount

Unit count

Number

Required

SV104

ambulancePatientCount

Ambulance patient count

Integer

QTY02*PT

drug

Drug code (NDC)

View codes and descriptions

Code

LIN03

drugQuantity

Drug quantity

Number

CTP04

drugUnitType

Drug unit type

String

CTP05-1

prescriptionNumber

Prescription number

String

REF02*XZ

lineNote

Line note

String

NTE02*ADD
NTE02*DCP

thirdPartyNote

Third party note

String

NTE02*TPO

procedure

Procedure

View codes and descriptions

Procedure

SV101*HC
SV101*AD
SV101*WK
SV101*IV

dmeService

Dme service

Since: v2.14.9

DmeService

SV5

attachments

Attachments

List of Attachment

PWK

contractInfo

Contract info

ContractInfo

CN1

ambulanceTransportInfo

Ambulance transport info

AmbulanceTransportInfo

CR1

dmeCertification

Dme certification

DmeCertification

CR3

conditionsIndicators

Conditions indicators

List of ConditionsIndicator

CRC

measurements

Measurements

Since: v2.14.9

List of Measurement

MEA

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

forms

Forms

Since: v2.14.9

List of FormResponse

LQ

diagPointers

Diagnosis pointers. Each pointer is an index of the diagnosis in the 'diags' array at the claim level.

List of Integer

Required

SV107

diags

Copy of diagnosis codes from the claim based on diagnosis pointers

View codes and descriptions

List of Code

SV107

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

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

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

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
NameDescriptionTypeEDI Reference

relatedCauseCode

Related cause code

String

CLM11-1

relatedCauseCode2

Related cause code2

String

CLM11-2

stateCode

State code

String

CLM11-4

countryCode

Country code

String

CLM11-5

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

Ambulance Transport Info

Information related to the ambulance service rendered to a patient. Required on all claims involving ambulance transport services.
Segment: CR1 Open API Schema
NameDescriptionTypeEDI Reference

patientWeight

Patient weight

Number

CR102

reasonCode

Reason code

String

Required

CR104

reason

Ambulance transport reason code as a string constant

Values:

FAMILY_MEMBER(C), NEAREST_FACILITY(A), PHYSICIAN(B), REHAB(E), RESIDENTIAL_FACILITY(618), SPECIALIST(D)

String (enum)

CR104

transportDistance

Transport distance

Number

Required

CR106

roundTripPurposeDescription

Round trip purpose description

String

CR109

stretcherPurposeDescription

Stretcher purpose description

String

CR110

DME Certification

DME Certification. Required when a Durable Medical Equipment Regional Carrier Certificate of Medical Necessity (DMERC CMN) or a DMERC Information Form (DIF) or Oxygen Therapy Certification is included on this service line
Segment: CR3 Open API Schema
NameDescriptionTypeEDI Reference

certificationTypeCode

Certification type code

String

Required

CR301

durationUnitType

Unit of measurement for the length of time for DME equipment

String

Required

CR302

duration

Length of time DME equipment is needed

Number

Required

CR303

DME Service

Durable medical equipment rental and purchase price information.
Segment: SV5 Open API Schema
NameDescriptionTypeEDI Reference

durationUnitType

Unit of measurement for the length of medical treatment

String

Required

SV502

lengthOfMedicalNecessity

Length of medical treatment required

Number

Required

SV503

rentalPrice

Rental price

Number

Required

SV504

purchasePrice

Purchase price

Number

Required

SV505

billingFrequencyCode

Frequency at which the rental equipment is billed

Values:

1, 4, 6

String

Required

SV506

billingFrequency

Frequency at which the rental equipment is billed, expressed as enum (string constant)

Values:

DAILY(6), MONTHLY(4), WEEKLY(1)

String (enum)

SV506

Spinal Manipulation Info

Spinal manipulation service info. Required on chiropractic claims involving spinal manipulation when the information is known to impact the payer’s adjudication process
Segment: CR2 Open API Schema
NameDescriptionTypeEDI Reference

conditionCode

Condition code

String

Required

CR208

description

Description of the patient’s condition

String

CR210

additionalDescription

Additional description of the patient’s condition

String

CR211

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

Measurement (Test Result)

Measurement, such as a test result for dialysis service lines or a patient's height for DMERC
Segment: MEA Open API SchemaSince: 2.14.9
NameDescriptionTypeEDI Reference

categoryCode

Code identifying the broad category to which a measurement applies

Values:

OG, TR

String

Required

MEA01

qualifierCode

Code identifying a specific product or process characteristic to which a measurement applies

String

Required

MEA02

type

Code identifying a specific product or process characteristic to which a measurement applies, expressed as enum (string constant)

Values:

CREATININE(R4), EPOETIN(R3), HEIGHT(HT), HEMATOCRIT(R2), HEMOGLOBIN(R1)

String (enum)

MEA02

value

The value of the measurement

Number

Required

MEA03

Form Response

Response to a standardized paper form, such as DMERC CMN
Segment: LQ Open API SchemaSince: 2.14.9
NameDescriptionTypeEDI Reference

formTypeCode

Form type

Values:

AS, UT

String

Required

LQ01

formIdentifier

Specific form number

String

Required

LQ02

responses

Responses

List of FormQuestionResponse

FRM

Form Question Response

Response to a question on a form
Segment: FRM Open API SchemaSince: 2.14.9
NameDescriptionTypeEDI Reference

questionIdentifier

Question identifier

String

Required

FRM01

yesOrNoResponse

Yes or no response

Values:

Y, N, W

String

FRM02

textResponse

Text response

String

FRM03

dateResponse

Date response

Date

FRM04

numberResponse

Number response

Number

FRM05

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

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