@cosyte/x12 0.1.2 → 0.1.3

package/dist/index.d.cts

@@ -1979,8 +1979,9 @@ interface X12ProfileSpec {
  * an 835 claim, a dropped decimal is the wrong dollar amount in someone's
  * cash post. `X12Decimal` preserves the inbound lexical form verbatim for
  * byte-exact round-trip and exposes exact `BigInt`-backed arithmetic for
- * balance invariants (CLP-04 + CLP-05 + ΣCAS = CLP-03;
- * ΣSVC paid + ΣCAS = CLP-04; Σclaim CLP-04 + PLB = BPR-02).
+ * the 835 balance invariants (`SVC-02 == SVC-03 + Σ(line CAS)`;
+ * `CLP-03 == CLP-04 + Σ(claim CAS + line CAS)`;
+ * `BPR-02 == Σ(CLP-04) - Σ(PLB amounts)`, each PLB amount in its raw EDI sign).
  *
  * Internal representation:
  *
@@ -5029,8 +5030,9 @@ interface X12Remittance {
  * Decoded BPR - Financial Information / payment header. The PAYMENT
  * MOVEMENT primitive: actual payment amount, credit/debit flag, method
  * (`ACH`/`CHK`/`NON`/`BOP`/`FWT`), payment date. **`totalActualPayment`
- * is the sum the bank actually moved** - `Σ(claim CLP-04) + Σ(PLB
- * adjustments) === BPR-02` is the top-level balance invariant.
+ * is the sum the bank actually moved**, and `BPR-02 === Σ(claim CLP-04) -
+ * Σ(PLB amounts)` is the top-level balance invariant, with each PLB amount
+ * in its raw EDI sign (a positive amount is a take-back).
  *
  * @example
  * ```ts
@@ -5376,9 +5378,10 @@ interface X12RemitRemark {
 }
 /**
  * Decoded Loop 2110 - Service Payment Information. One per service line
- * adjudicated. Line-level CAS adjustments roll up into the claim-level
- * balance invariant (`Σ(SVC paid) + Σ(line CAS) === CLP-04`); a mismatch
- * fires `X12_835_REMIT_BALANCE_MISMATCH` on the parent claim.
+ * adjudicated. Line-level CAS adjustments enter two balance invariants:
+ * this line's own `SVC-02 === SVC-03 + Σ(line CAS)`, and the parent claim's
+ * `CLP-03 === CLP-04 + Σ(claim CAS + line CAS)`. A mismatch in either fires
+ * `X12_835_REMIT_BALANCE_MISMATCH`.
  *
  * `productServiceIdQualifier` is the SVC-01-1 procedure-code system
  * (`HC` HCPCS/CPT, `AD` ADA dental, `N4` NDC, `WK` Advanced Billing
@@ -5457,12 +5460,15 @@ interface X12RemitServiceLine {
  * **Sign convention:** a POSITIVE PLB amount REDUCES the provider's
  * payment (recoupment / take-back); a NEGATIVE PLB amount ADDS to the
  * payment (interest / advance payment). The 835 balance invariant
- * `Σ(claim CLP-04) + Σ(PLB amounts) === BPR-02` works because PLB
- * amounts already carry the correct sign.
+ * `BPR-02 === Σ(claim CLP-04) - Σ(PLB amounts)` subtracts the amounts as
+ * the wire states them, so a positive PLB lowers BPR-02 and a negative one
+ * raises it.
  *
- * `reasonCode` is the **composite** PLB reason code (the qualifier +
- * optional reference together, e.g. `WO:123456` for "withholding for
- * claim 123456"); `subCode` carries the optional second component.
+ * `reasonCode` is the adjustment reason code, the first component of the
+ * PLB composite (e.g. `WO`, withholding); `subCode` is its optional second
+ * component, the reference identifier (e.g. `123456`, the claim the
+ * withholding relates to). A composite sent as `WO:123456` reads as
+ * `reasonCode: "WO"` and `subCode: "123456"`.
  *
  * @example
  * ```ts
@@ -18498,8 +18504,9 @@ declare const AUTH_278_LOOP_2000A: LoopSpec;
  * the host machine's zone would make the answer depend on where the code ran.
  * So `toDate` returns `undefined` unless the caller states the offset, and
  * nothing here ever reads `Intl`, `getTimezoneOffset` or the local zone. That
- * is the same stance `parseDocumentDate` already takes for the date-aware
- * code-list queries, and this module does not soften it.
+ * is the same stance the date-aware code-list queries, `checkCarcValidity` and
+ * `checkRarcValidity`, already take for a document date, and this module does
+ * not soften it.
  *
  * **What it decodes is exactly what this package already parses or builds.**
  * DTP-02 is the date/time period format qualifier, and the readers and
@@ -18517,12 +18524,12 @@ declare const AUTH_278_LOOP_2000A: LoopSpec;
  * **None of the three ever throws.** An undecodable carrier, a value whose
  * digits do not match the format its own qualifier declares, a calendar-invalid
  * day, `null` and `undefined` all answer `undefined`. That is the deliberate
- * divergence from {@link "../../code-lists/document-date.js".parseDocumentDate},
- * which THROWS on its own invalid input and keeps that contract unchanged: it
- * answers a caller who asked a validity question and cannot state the day,
- * while these three answer a caller reading a document that has already been
- * parsed leniently, where a warning has already been raised and an exception
- * would be a second, worse report of the same thing.
+ * divergence from `checkCarcValidity` and `checkRarcValidity`, which THROW an
+ * `X12CodeListError` on a document date they refuse and keep that contract
+ * unchanged: they answer a caller who asked a validity question and cannot
+ * state the day, while these three answer a caller reading a document that
+ * has already been parsed leniently, where a warning has already been raised
+ * and an exception would be a second, worse report of the same thing.
  */
 /**
  * Any date carrier this package's typed readers surface, read structurally

package/dist/index.d.ts

@@ -1979,8 +1979,9 @@ interface X12ProfileSpec {
  * an 835 claim, a dropped decimal is the wrong dollar amount in someone's
  * cash post. `X12Decimal` preserves the inbound lexical form verbatim for
  * byte-exact round-trip and exposes exact `BigInt`-backed arithmetic for
- * balance invariants (CLP-04 + CLP-05 + ΣCAS = CLP-03;
- * ΣSVC paid + ΣCAS = CLP-04; Σclaim CLP-04 + PLB = BPR-02).
+ * the 835 balance invariants (`SVC-02 == SVC-03 + Σ(line CAS)`;
+ * `CLP-03 == CLP-04 + Σ(claim CAS + line CAS)`;
+ * `BPR-02 == Σ(CLP-04) - Σ(PLB amounts)`, each PLB amount in its raw EDI sign).
  *
  * Internal representation:
  *
@@ -5029,8 +5030,9 @@ interface X12Remittance {
  * Decoded BPR - Financial Information / payment header. The PAYMENT
  * MOVEMENT primitive: actual payment amount, credit/debit flag, method
  * (`ACH`/`CHK`/`NON`/`BOP`/`FWT`), payment date. **`totalActualPayment`
- * is the sum the bank actually moved** - `Σ(claim CLP-04) + Σ(PLB
- * adjustments) === BPR-02` is the top-level balance invariant.
+ * is the sum the bank actually moved**, and `BPR-02 === Σ(claim CLP-04) -
+ * Σ(PLB amounts)` is the top-level balance invariant, with each PLB amount
+ * in its raw EDI sign (a positive amount is a take-back).
  *
  * @example
  * ```ts
@@ -5376,9 +5378,10 @@ interface X12RemitRemark {
 }
 /**
  * Decoded Loop 2110 - Service Payment Information. One per service line
- * adjudicated. Line-level CAS adjustments roll up into the claim-level
- * balance invariant (`Σ(SVC paid) + Σ(line CAS) === CLP-04`); a mismatch
- * fires `X12_835_REMIT_BALANCE_MISMATCH` on the parent claim.
+ * adjudicated. Line-level CAS adjustments enter two balance invariants:
+ * this line's own `SVC-02 === SVC-03 + Σ(line CAS)`, and the parent claim's
+ * `CLP-03 === CLP-04 + Σ(claim CAS + line CAS)`. A mismatch in either fires
+ * `X12_835_REMIT_BALANCE_MISMATCH`.
  *
  * `productServiceIdQualifier` is the SVC-01-1 procedure-code system
  * (`HC` HCPCS/CPT, `AD` ADA dental, `N4` NDC, `WK` Advanced Billing
@@ -5457,12 +5460,15 @@ interface X12RemitServiceLine {
  * **Sign convention:** a POSITIVE PLB amount REDUCES the provider's
  * payment (recoupment / take-back); a NEGATIVE PLB amount ADDS to the
  * payment (interest / advance payment). The 835 balance invariant
- * `Σ(claim CLP-04) + Σ(PLB amounts) === BPR-02` works because PLB
- * amounts already carry the correct sign.
+ * `BPR-02 === Σ(claim CLP-04) - Σ(PLB amounts)` subtracts the amounts as
+ * the wire states them, so a positive PLB lowers BPR-02 and a negative one
+ * raises it.
  *
- * `reasonCode` is the **composite** PLB reason code (the qualifier +
- * optional reference together, e.g. `WO:123456` for "withholding for
- * claim 123456"); `subCode` carries the optional second component.
+ * `reasonCode` is the adjustment reason code, the first component of the
+ * PLB composite (e.g. `WO`, withholding); `subCode` is its optional second
+ * component, the reference identifier (e.g. `123456`, the claim the
+ * withholding relates to). A composite sent as `WO:123456` reads as
+ * `reasonCode: "WO"` and `subCode: "123456"`.
  *
  * @example
  * ```ts
@@ -18498,8 +18504,9 @@ declare const AUTH_278_LOOP_2000A: LoopSpec;
  * the host machine's zone would make the answer depend on where the code ran.
  * So `toDate` returns `undefined` unless the caller states the offset, and
  * nothing here ever reads `Intl`, `getTimezoneOffset` or the local zone. That
- * is the same stance `parseDocumentDate` already takes for the date-aware
- * code-list queries, and this module does not soften it.
+ * is the same stance the date-aware code-list queries, `checkCarcValidity` and
+ * `checkRarcValidity`, already take for a document date, and this module does
+ * not soften it.
  *
  * **What it decodes is exactly what this package already parses or builds.**
  * DTP-02 is the date/time period format qualifier, and the readers and
@@ -18517,12 +18524,12 @@ declare const AUTH_278_LOOP_2000A: LoopSpec;
  * **None of the three ever throws.** An undecodable carrier, a value whose
  * digits do not match the format its own qualifier declares, a calendar-invalid
  * day, `null` and `undefined` all answer `undefined`. That is the deliberate
- * divergence from {@link "../../code-lists/document-date.js".parseDocumentDate},
- * which THROWS on its own invalid input and keeps that contract unchanged: it
- * answers a caller who asked a validity question and cannot state the day,
- * while these three answer a caller reading a document that has already been
- * parsed leniently, where a warning has already been raised and an exception
- * would be a second, worse report of the same thing.
+ * divergence from `checkCarcValidity` and `checkRarcValidity`, which THROW an
+ * `X12CodeListError` on a document date they refuse and keep that contract
+ * unchanged: they answer a caller who asked a validity question and cannot
+ * state the day, while these three answer a caller reading a document that
+ * has already been parsed leniently, where a warning has already been raised
+ * and an exception would be a second, worse report of the same thing.
  */
 /**
  * Any date carrier this package's typed readers surface, read structurally

package/dist/index.mjs

@@ -15393,7 +15393,7 @@ var profiles = Object.freeze({
 });
 
 // src/index.ts
-var VERSION = "0.1.2";
+var VERSION = "0.1.3";
 
 export { AAA_CONDITION_LEVELS, AAA_FOLLOW_UP_ACTION_CODES, AAA_LEVEL_CONTEXTS, AAA_REJECT_REASON_CODES, ACK_BUILD_ERROR_CODES, ALL_WARNING_MESSAGES, ATTACHMENT_275_BUILD_ERROR_CODES, AUTH_278_BUILD_ERROR_CODES, AUTH_278_LOOP_2000A, AUTH_278_LOOP_2000B, AUTH_278_LOOP_2000C, AUTH_278_LOOP_2000D, AUTH_278_LOOP_2000E, AUTH_278_LOOP_2000F, AckBuildError, Attachment275BuildError, BALANCE_INVARIANTS, BUILD_REFUSAL_VALUE_MAX_LENGTH, BUILD_REFUSAL_VALUE_MAX_RENDERED, CARC, CLAIM_837D_LOOP_2000A, CLAIM_837D_LOOP_2300, CLAIM_837D_LOOP_2400, CLAIM_837I_LOOP_2000A, CLAIM_837I_LOOP_2300, CLAIM_837I_LOOP_2400, CLAIM_837P_LOOP_2000A, CLAIM_837P_LOOP_2300, CLAIM_837P_LOOP_2400, CLAIM_837P_LOOP_2410, CLAIM_837_BUILD_ERROR_CODES, CLAIM_837_LOOP_1000A, CLAIM_837_LOOP_1000B, CLAIM_837_LOOP_2010AA, CLAIM_837_LOOP_2010BA, CLAIM_837_LOOP_2010BB, CLAIM_837_LOOP_2010CA, CLAIM_837_LOOP_2430, CLAIM_ADJUSTMENT_GROUP_CODES, CLAIM_STATUS_276_BUILD_ERROR_CODES, CLAIM_STATUS_277_BUILD_ERROR_CODES, CLAIM_STATUS_CATEGORY_CODES, CLAIM_STATUS_CODES, CLP_STATUS, CODE_VALIDITY, CODE_VALIDITY_REASONS, CONTROL_NUMBER_PAIRS, CORE_BUSINESS_SCENARIOS, CORE_CODE_COMBINATION_ERROR_CODES, CORE_CODE_COMBINATION_OUTCOMES, CORE_CODE_COMBINATION_UNEVALUATED_REASONS, Claim837BuildError, ClaimStatus276BuildError, ClaimStatus277BuildError, CoreCodeCombinationTableError, DELIMITER_POSITIONS, ELIGIBILITY_270_BUILD_ERROR_CODES, ELIGIBILITY_271_BUILD_ERROR_CODES, ELIGIBILITY_271_LOOP_2000A, ELIGIBILITY_271_LOOP_2000B, ELIGIBILITY_271_LOOP_2000C, ELIGIBILITY_271_LOOP_2000D, ELIGIBILITY_271_LOOP_2100C, ELIGIBILITY_271_LOOP_2100D, ELIGIBILITY_271_LOOP_2110, ENROLLMENT_834_BUILD_ERROR_CODES, ENROLLMENT_834_LOOP_1000A, ENROLLMENT_834_LOOP_1000B, ENROLLMENT_834_LOOP_2000, ENROLLMENT_834_LOOP_2100A, ENROLLMENT_834_LOOP_2300, ENROLLMENT_834_LOOP_2320, Eligibility270BuildError, Eligibility271BuildError, Enrollment834BuildError, FATAL_CODES, HI_QUALIFIERS, HL_LEVEL_CODES, IK3_SYNTAX_ERROR_CODES, IK4_SYNTAX_ERROR_CODES, INQUIRY_270_LOOP_2000A, INQUIRY_270_LOOP_2000B, INQUIRY_270_LOOP_2000C, INQUIRY_270_LOOP_2000D, INQUIRY_270_LOOP_2100C, INQUIRY_270_LOOP_2100D, INQUIRY_270_LOOP_2110, ISA_MIN_LENGTH, LoopSpecDefinitionError, MAINTENANCE_TYPE_CODES, NM1_QUALIFIERS, NON_SPEC_SEGMENT_ID, PREMIUM_820_BUILD_ERROR_CODES, PREMIUM_820_LOOP_1000A, PREMIUM_820_LOOP_1000B, PREMIUM_820_LOOP_2000A, PREMIUM_820_LOOP_2100A, PREMIUM_820_LOOP_2300A, PREMIUM_820_LOOP_2310A, Premium820BuildError, RARC, RELEASE_CHAR, REMIT_835_BUILD_ERROR_CODES, REMIT_835_LOOP_1000A, REMIT_835_LOOP_1000B, REMIT_835_LOOP_2000, REMIT_835_LOOP_2100, REMIT_835_LOOP_2110, REQUIRED_LOOPS, RFAI_277_BUILD_ERROR_CODES, RFAI_277_LOOP_1000, RFAI_277_LOOP_2000, RFAI_277_LOOP_2100, RFAI_277_LOOP_2200, RFAI_277_LOOP_2220, Remit835BuildError, Rfai277BuildError, SERVICE_TYPE_CODES, STATUS_276_LOOP_2000A, STATUS_276_LOOP_2000B, STATUS_276_LOOP_2000C, STATUS_276_LOOP_2000D, STATUS_276_LOOP_2000E, STATUS_276_LOOP_2200, STATUS_276_LOOP_2210, STATUS_277_LOOP_2000A, STATUS_277_LOOP_2000B, STATUS_277_LOOP_2000C, STATUS_277_LOOP_2000D, STATUS_277_LOOP_2000E, STATUS_277_LOOP_2200, STATUS_277_LOOP_2220, ServicesReview278BuildError, TA1_ACK_CODES, TA1_NOTE_CODES, UNEXPECTED_SEGMENT_CONTEXTS, VERSION, WARNING_CODES, X12AttachmentData, X12BuildError, X12CodeListError, X12Decimal, X12ParseError, X12ProfileError, X12_ACK_DISPOSITION_CODES, X12_BUILD_ERROR_CODES, X12_CODE_LIST_ERROR_CODES, X12_TR3_CONFORMANCE, aaaLoopUnidentified, aaaProvenanceIsComplete, aaaRejectReasonAbsent, aaaSegmentMalformed, aaaUnknownCode, ambiguous837Variant, amountRowDropped, attachmentAbsent, balanceNotEvaluable, binaryDataTruncated, binaryLengthInvalid, binaryLengthMismatch, binaryLengthUnverifiable, build270, build271, build275, build276, build277, build277CA, build277RequestForAdditionalInformation, build278Request, build278Response, build820, build834, build835, build837D, build837I, build837P, build999, buildInterchange, buildTA1, bundleAaaCodes, checkCarcValidity, checkClaimBalance, checkCoreCodeCombination, checkRarcValidity, checkRemitTotalBalance, checkServiceLineBalance, codeListRedistributionIsPermitted, collectElementValues, componentOptional, controlNumberMismatch, danglingReleaseChar, dateRowDropped, decodeSegment, defineLoopSpec, defineProfile, detectDelimiters, duplicateHierarchyId, elementDecimal, elementDecimalOrZero, elementOptional, elementValue, entitySegmentDiscardedAfterLx, escapeRelease, get270Inquiry, get271Eligibility, get275Attachments, get276StatusInquiry, get277CADisposition, get277RequestForAdditionalInformation, get277Status, get278Request, get278Response, get820Payments, get834Enrollments, get834Header, get835, get837Claims, getAllSegmentValues, getDefaultProfile, getSegmentValue, groupCountMismatch, guideNotDeclared, guideNotImplemented, hierarchyCycle, hlParentLevelInvalid, hlParentMismatch, interSegmentLineBreak, isAcceptDisposition, isClaimAdjustmentGroupCode, isDiagnosisQualifier, isProcedureQualifier, isaExtraElementSeparator, levelDetached, lookupAaaFollowUpAction, lookupAaaRejectReason, lookupCarc, lookupClaimStatus, lookupClaimStatusCategory, lookupClpStatus, lookupMaintenanceType, lookupRarc, lookupServiceType, missingGe, missingIea, missingRequiredLoop, missingSe, nonConventionalDelimiter, parse270Inquiries, parse276StatusInquiries, parse999, parseTA1, parseX12, partitionWarnings, payToAddressRepeated, pre005010, profiles, readElementDecimal, remitBalanceMismatch, renderCallerValue, resolveHiQualifier, rfaiHeaderAbsent, rfaiLevelAbsent, rfaiRequestAbsent, segmentCountMismatch, serializeX12, serviceLineDropped, serviceLineNotDecoded, serviceSegmentRepeated, serviceSegmentWithoutLx, setDefaultProfile, statedAmountDiscarded, statusInquiryDateRowDropped, statusInquiryDuplicateHierarchyId, statusInquiryHierarchyCycle, statusInquiryLevelDetached, statusInquiryReferenceRowDropped, toDate, toISO, toObject, trailingGarbage, transactionCountMismatch, unescapeRelease, unexpectedSegment, unknown837Variant, unknownCarc, unknownClaimStatus, unknownClaimStatusCategory, unknownHiQualifier, unknownMaintenanceType, unknownRarc, unparseableDecimal };
 //# sourceMappingURL=index.mjs.map