Skip to main content
Version: v0.0.3

Interface: Charge

FT1-derived charge entry (DFT financial breadth). Billing-critical fields surfaced with no billing logic and no money-as-float: the extended/unit amounts are the verbatim CP wire text, never parsed to a number.

Example

import type { Charge } from "@cosyte/hl7";
const c: Charge = {
transactionType: "CG",
transactionCode: { identifier: "80053", text: "Metabolic panel" },
amountExtended: "150.00^USD",
diagnoses: [{ identifier: "E11.9" }],
};

Properties

amountExtended?

readonly optional amountExtended?: string

FT1-11 transaction amount, extended (CP): canonical wire text (e.g. 150.00^USD, byte-exact for a plain amount); never parsed to a number.


amountUnit?

readonly optional amountUnit?: string

FT1-12 transaction amount, unit (CP): canonical wire text; never parsed to a number.


diagnoses

readonly diagnoses: readonly CWE[]

FT1-19 diagnosis code(s) linked to this charge (CE, repeating): billing diagnosis linkage. Always present (possibly empty).


quantity?

readonly optional quantity?: number

FT1-10 transaction quantity (NM; strict-parsed, never NaN).


transactionCode?

readonly optional transactionCode?: CWE

FT1-7 transaction code: the institution charge/procedure code (CWE, provenance-only, never validated).


transactionDate?

readonly optional transactionDate?: DtmParts

FT1-4 transaction date (fidelity TS).


transactionType?

readonly optional transactionType?: string

FT1-6 transaction type (HL7 Table 0017: CG charge, CD credit, PY payment, AJ adjustment). Verbatim.