Interface: X12ProfileDescription

Structured describe() output - the "what this profile relaxes / adds / requires" record published with the package. Returned as DATA (not a formatted string, unlike hl7) so downstream tooling - docs generators, the pathways engine - can consume it programmatically.

Example

import { profiles } from "@cosyte/x12";
const d = profiles.availity.describe();
d.adds.map((q) => q.id);          // ["payer-loop-ref-2u", "service-line-ref-f8"]
d.expectedWarnings;               // readonly X12WarningCode[]

Properties

adds

readonly adds: readonly X12ProfileQuirk[]

---

description?

readonly optional description?: string

---

expectedWarnings

readonly expectedWarnings: readonly X12WarningCode[]

Sorted, de-duplicated union of every quirk's expectedWarnings.

---

lineage

readonly lineage: readonly string[]

---

name

readonly name: string

---

relaxes

readonly relaxes: readonly X12ProfileQuirk[]

---

requires

readonly requires: readonly X12ProfileQuirk[]