Skip to main content
Version: v0.0.4

Interface: LivdAnnotation

One record's LIVD annotation - which record, the code that was looked up (verbatim), how it was recognized, and the mapping outcome. Additive: it points at the record by index and never replaces it.

Example

import type { LivdAnnotation } from "@cosyte/astm";
const a: LivdAnnotation = {
recordIndex: 3,
recordType: "R",
reportedCode: "687",
provenance: "local-code",
mapping: { status: "mapped", loinc: "1920-8", source: "livd", derived: true },
};

Properties

mapping

readonly mapping: LivdMapping

The mapping outcome - never a guessed LOINC.


provenance

readonly provenance: UniversalTestIdProvenance

How the reported code was recognized in the Universal Test ID (provenance only, never a lookup).


recordIndex

readonly recordIndex: number

The recordIndex of the annotated R/O record.


recordType

readonly recordType: "O" | "R"

The annotated record's type.


reportedCode?

readonly optional reportedCode?: string

The reported primary code that was looked up, verbatim; absent when the record carried no code.