ehrtslib (Electronic Health Record TypeScript Library)

Experimental website · Live demo · TAAAT

Frozen demo / TAAAT releases stay at /demo-vX.Y/ and /taaat-vX.Y/ when newer builds ship (releases).

TypeScript library for (to begin with) openEHR — usable in browsers and on Deno/Node. Import only what you need; rely on tree-shaking for client bundles.

Documentation map

Audience	Entry
Library users	docs/README.md
Maintainers / agents	docs/maintainers/README.md · CONTRIBUTING.md · AGENTS.md

Quick start

import { COMPOSITION } from "./openehr_rm.ts";
import { JsonConfigurableSerializer } from "./serialization/json/mod.ts";

const composition = new COMPOSITION({
  archetype_node_id: "openEHR-EHR-COMPOSITION.encounter.v1",
  name: "Blood Pressure Recording",
  language: "ISO_639-1::en",
  territory: "ISO_3166-1::GB",
  category: "openehr::433|event|",
  composer: { name: "Dr. Smith" },
});

const json = new JsonConfigurableSerializer({ prettyPrint: true })
  .serialize(composition);

Topic	Doc
Hello world, packages, limitations	docs/getting-started.md
Dual accessors (name vs $name)	docs/user/dual-accessors.md
Constructors + terse codes	docs/user/brief-property-styles.md
Serialization formats	serialization/README.md
FLAT / STRUCTURED / Web Template	docs/SIMPLIFIED_FORMATS.md
Clinical model file sets / GitHub load	docs/CLINICAL_MODEL_FILESETS.md
ADL 1.4 / 2 + OPT/OET + validation	docs/ADL_SUPPORT.md
Terminology lookup (at0001 is local)	docs/ADL_SUPPORT.md
Validation gaps	docs/VALIDATION_LIMITATIONS.md
RM attribute introspection	docs/RM_ATTRIBUTES.md

import { parseAdl } from "./parser/mod.ts";
import { TemplateValidator } from "./validation/mod.ts";

const { archetype } = parseAdl(adlText);
const validator = new TemplateValidator({ validateUnits: true });
await validator.initialize();
const result = validator.validate(rmInstance, template);

Examples and demo

• Deno scripts: examples/README.md
• Browser converter: examples/demo-app/README.md — primary clinical models from Ehrlibs/openEHR-model-examples
• TAAAT: examples/taaat-app/README.md
• Roadmap: docs/maintainers/roadmap.md

You can also visit to ask about how to use and understand Ehrtslib.