Interface: CcdaProfile

A frozen, immutable vendor/conformance profile. Produced by defineCcdaProfile; consumers pass it to parseCcda(raw, { profile }) (or register it as the process default). Hand-authoring the object literal is supported but discouraged, the factory validates the safety rules and attaches describe().

Example

import { parseCcda, ccdaProfiles } from "@cosyte/ccda";
const doc = parseCcda(xml, { profile: ccdaProfiles.smartScorecard });
console.log(doc.profile?.name); // "smartScorecard"

Properties

describe?

readonly optional describe?: () => string

Multi-line human-readable summary; always present on factory-built profiles.

Returns

string

---

description?

readonly optional description?: string

Optional human-readable description.

---

lineage

readonly lineage: readonly string[]

Resolved lineage, [...parents, name], first-occurrence deduped.

---

name

readonly name: string

The profile's unique name (registry key / attribution label).

---

provenance?

readonly optional provenance?: ProfileProvenance

The cited public grounding for this profile's quirks (absent for default).

---

tolerate

readonly tolerate: readonly QuirkTolerance[]

The expected, non-safety-critical deviations this profile tolerates.