Interface: CcdaPosition

Structural locator attached to every warning and fatal error. Every field is optional and PHI-free by construction, a path carries element names and positional indices (never attribute values or narrative text), and templateId / sectionCode are OIDs / LOINC codes, not patient data. For a top-level fatal like INPUT_SIZE_LIMIT_EXCEEDED no field need be populated; for a section warning deep in the body the path, templateId, and sectionCode may all be set.

Remarks

With exactOptionalPropertyTypes: true, do not pass line: undefined explicitly, omit the key instead.

Example

import type { CcdaPosition } from "@cosyte/ccda";
const pos: CcdaPosition = {
  path: "/ClinicalDocument/component/structuredBody/component[3]/section",
  sectionCode: "11450-4",
};

Properties

column?

readonly optional column?: number

---

line?

readonly optional line?: number

---

path?

readonly optional path?: string

---

sectionCode?

readonly optional sectionCode?: string

---

templateId?

readonly optional templateId?: string