Interface: BuildCcdaFamilyHistory

One Family History Organizer (…22.4.45) for the Family History section, a single relative plus the observations (conditions) recorded for them. The relative's identity is carried once on the organizer (not flattened into each condition), so the parser reads every condition back grouped under its relative.

Example

import type { BuildCcdaFamilyHistory } from "@cosyte/ccda";
const father: BuildCcdaFamilyHistory = {
  relative: { relationship: { code: "9947008", displayName: "Father" }, deceased: true },
  observations: [
    { condition: { code: "22298006", displayName: "Myocardial infarction" }, causeOfDeath: true },
  ],
};

Properties

observations

readonly observations: readonly BuildCcdaFamilyHistoryObservation[]

The conditions recorded for the relative; each becomes a Family History Observation. Must be non-empty, the organizer SHALL carry at least one observation component; pass [{}] (an unknown condition) rather than an empty list, else buildCcda throws a TypeError.

---

relative

readonly relative: BuildCcdaFamilyMember

The family member this organizer describes.