Skip to main content
Version: v0.0.3

Interface: TerminologyCoding

A single coded value handed to a TerminologyAdapter. Mirrors FHIR R4 Coding (and @cosyte/terminology's Coding), except system is the C-CDA @codeSystem OID exactly as it appears in the document (e.g. 2.16.840.1.113883.6.96 for SNOMED CT), not a canonical URI, the parser hands the adapter what the wire actually carries and never invents a URI. A consumer bridging to a URI-based engine (such as @cosyte/terminology's resolveSystem) performs that OID→URI mapping inside their adapter.

Example

import type { TerminologyCoding } from "@cosyte/ccda";
const snomed: TerminologyCoding = {
system: "2.16.840.1.113883.6.96",
code: "38341003",
display: "Hypertension",
};

Properties

code

readonly code: string

The symbol within the code system (the C-CDA @code). Required, a coding without one is meaningless.


display?

readonly optional display?: string

The human-readable label (the C-CDA @displayName), when present. Carried verbatim.


system?

readonly optional system?: string

The code system's OID, as carried by the C-CDA @codeSystem (never a URI). May be absent.


version?

readonly optional version?: string

The code-system version the code is drawn from, when known.