Skip to main content
Version: v0.0.2

Interface: Build837ClaimSpec

Loop 2300 claim. The builder REFUSES a claim with an empty claimId or no service lines (a CLM requires ≥ 1 LX/SVx loop). Mirrors "./types.js".X12Claim minus the HL-resolved context the spine supplies.

Example

import type { Build837ClaimSpec } from "@cosyte/x12";
import { X12Decimal } from "@cosyte/x12";
const claim: Build837ClaimSpec = {
claimId: "PT-ACCT-001", totalCharge: X12Decimal.fromString("150.00")!,
placeOfServiceCode: "11", facilityCodeQualifier: "B", claimFrequencyCode: "1",
providerSignatureOnFile: "Y", providerAcceptAssignment: "A",
benefitsAssignment: "Y", releaseOfInformationCode: "Y",
diagnoses: [{ qualifier: "ABK", code: "J20.9" }],
serviceLines: [{
variant: "P", procedureQualifier: "HC", procedureCode: "99213",
charge: X12Decimal.fromString("150.00")!, unitOfMeasure: "UN",
units: X12Decimal.fromString("1")!, diagnosisPointers: ["1"],
}],
};

Properties

amounts?

readonly optional amounts?: readonly Build837AmountSpec[]

AMT claim-level amounts.


benefitsAssignment?

readonly optional benefitsAssignment?: string

CLM-08 - benefits assignment certification indicator.


claimFrequencyCode?

readonly optional claimFrequencyCode?: string

CLM-05-3 - claim frequency type code.


claimId

readonly claimId: string

CLM-01 - patient account / claim id.


dates?

readonly optional dates?: readonly Build837DateSpec[]

DTP claim-level dates.


diagnoses?

readonly optional diagnoses?: readonly Build837HiCodeSpec[]

HI diagnoses.


facilityCodeQualifier?

readonly optional facilityCodeQualifier?: string

CLM-05-2 - facility code qualifier.


notes?

readonly optional notes?: readonly Build837NoteSpec[]

NTE claim-level notes.


otherHi?

readonly optional otherHi?: readonly Build837HiCodeSpec[]

HI other code-set entries (value information, condition, occurrence, …).


otherSubscribers?

readonly optional otherSubscribers?: readonly Build837OtherSubscriberSpec[]

Loop 2320 other subscribers.


placeOfServiceCode?

readonly optional placeOfServiceCode?: string

CLM-05-1 - place of service code.


procedures?

readonly optional procedures?: readonly Build837HiCodeSpec[]

HI procedures.


providerAcceptAssignment?

readonly optional providerAcceptAssignment?: string

CLM-07 - provider accept assignment code.


providers?

readonly optional providers?: readonly Build837EntitySpec[]

Loop 2310x claim provider names (NM1 fields round-trip).


providerSignatureOnFile?

readonly optional providerSignatureOnFile?: string

CLM-06 - provider/supplier signature on file.


references?

readonly optional references?: readonly Build837ReferenceSpec[]

REF claim-level identifiers.


releaseOfInformationCode?

readonly optional releaseOfInformationCode?: string

CLM-09 - release of information code.


serviceLines

readonly serviceLines: readonly Build837ServiceLineSpec[]

Loop 2400 service lines (≥ 1 required).


totalCharge

readonly totalCharge: X12Decimal

CLM-02 - total claim charge amount.