Interface: DeidentifyReport

The audit trail returned alongside the de-identified dataset. Contains no decoded values - only tags, keywords, action codes, and the UID map (whose keys/values are UIDs, not patient data).

Example

import { deidentify, parseDicom, type DeidentifyReport } from "@cosyte/dicom";
const { report }: { report: DeidentifyReport } = deidentify(parseDicom(buf));
console.log(report.attributes.length, "attributes acted on");
console.log(report.warnings.map((w) => w.code)); // e.g. burned-in annotation

Properties

attributes

readonly attributes: readonly DeidentifiedAttribute[]

Per-attribute outcomes for every attribute Annex E acted on.

---

removedPrivateTags

readonly removedPrivateTags: readonly string[]

Private tags removed under the Basic Profile (kept ones are omitted).

---

retained

readonly retained: readonly DeidentifyOption[]

The Retain/Clean options that were active for this run.

---

uidMap

readonly uidMap: ReadonlyMap<string, string>

Source UID → replacement UID, for cross-file consistency.

---

warnings

readonly warnings: readonly DicomParseWarning[]

Safety warnings - notably burned-in-pixel annotation that cannot be cleaned.