Interface: ConformanceFinding

One typed conformance finding. Carries the FindingCode, a FindingSeverity, the structural FindingLocus, and a human-readable message describing the rule that fired.

The message is PHI-safe by construction: it names the locus, the rule, and (for a value-set miss) the SIZE of the value set, but never the offending field value.

Example

import type { ConformanceFinding } from "@cosyte/hl7";
const f: ConformanceFinding = {
  code: "PROFILE_VALUE_NOT_IN_SET",
  severity: "error",
  locus: { segment: "PID", field: 8, component: 1 },
  message: 'PID-8 component 1 value is not in the profile value set (3 permitted codes).',
};

Properties

code

readonly code: FindingCode

---

locus

readonly locus: FindingLocus

---

message

readonly message: string

---

severity

readonly severity: FindingSeverity