Interface: ProfileProvenance

Provenance for a CcdaProfile, the real, cited public artifact a profile's quirks are grounded in. A quirk is encoded only when a real document (including a public HL7/ONC/IHE sample or a published conformance study) grounds it; this record is where that grounding is stated, so a reviewer can trace every tolerated deviation back to evidence rather than invention.

Example

import type { ProfileProvenance } from "@cosyte/ccda";
const prov: ProfileProvenance = {
  source: "SMART C-CDA Scorecard",
  reference: "https://ccda-scorecard.smarthealthit.org/",
  retrieved: "2026-07-18",
};

Properties

note?

readonly optional note?: string

Optional clarifying note about what in the source grounds the quirks.

---

reference

readonly reference: string

A citation the grounding can be traced to, a URL, DOI, or repo+commit.

---

retrieved?

readonly optional retrieved?: string

When the grounding was last verified (ISO date) or the pinned commit SHA.

---

source

readonly source: string

Short human-readable name of the grounding source (corpus, study, or guide).