Interface: BuildCcdaImmunization

An Immunization Activity for the Immunizations section. vaccine is the CVX coded product (CVX by default). dose and route are optional and never guessed, an omitted one is simply left absent. refused: true emits the administration with negationInd="true" (a not-administered / refused record), which the parser reads back as refused and flags IMMUNIZATION_REFUSED, the clinically load-bearing refusal is surfaced, never conflated with a nullFlavor "unknown". effectiveTime is the administration date; when omitted the SHALL slot is filled with nullFlavor="UNK".

Example

import type { BuildCcdaImmunization } from "@cosyte/ccda";
const flu: BuildCcdaImmunization = {
  vaccine: { code: "140", displayName: "Influenza, split virus, trivalent, injectable, preservative free" }, // CVX
  dose: { value: 0.5, unit: "mL" },
  route: { code: "C28161", displayName: "Intramuscular" }, // NCI Thesaurus
  effectiveTime: "20240101",
};
const refused: BuildCcdaImmunization = {
  vaccine: { code: "140", displayName: "Influenza, split virus, trivalent, injectable, preservative free" },
  refused: true,
};

Properties

dose?

readonly optional dose?: BuildQuantity

The amount administered (doseQuantity), optional, never defaulted.

---

effectiveTime?

readonly optional effectiveTime?: string

The administration date as an HL7 date string; nullFlavor="UNK" when omitted.

---

refused?

readonly optional refused?: boolean

Emit a refused / not-administered record (negationInd="true"); parser flags IMMUNIZATION_REFUSED.

---

route?

readonly optional route?: BuildCode

The administration route (routeCode); NCI Thesaurus by default.

---

status?

readonly optional status?: string

The statusCode; defaults to "completed".

---

vaccine

readonly vaccine: BuildCode

The CVX-coded vaccine product (CVX by default).