lx-data-models

lx-dtypes is the reusable data-model package for Lux Group medical research projects. It provides typed Pydantic contracts, versioned clinical terminology, report-template validation, FHIR interoperability, and optional Django host integration.

[!IMPORTANT] This project is research software. It is not a medical device and must not be used as the sole basis for clinical decisions.

Highlights

Strict, reusable contracts for knowledge-base, ledger, reporting, and host integration boundaries.
Version-aware YAML knowledge bases and deterministic loaders.
Report-template graph, structure, coverage, and runtime validation.
FHIR clinical and terminology conversion contracts.
Typed package data with Pyright, pytest, and documentation checks in CI.

The package is currently in alpha. Public imports are kept stable where possible, but releases before 1.0 may contain documented breaking changes.

Installation

lx-dtypes supports Python 3.12.

python -m pip install lx-dtypes

Quick start

Load a knowledge-base module shipped with the package:

from lx_dtypes import load_knowledge_base

knowledge_base = load_knowledge_base("report_template_examples")

print(knowledge_base.config.knowledge_base_identity)
print(sorted(knowledge_base.report_template))

Registry-backed deployments should supply the exact module version. See the knowledge-base authoring guide and graph API guide for the complete workflow.

Provision the packaged catalog before starting a registry-backed host:

export LX_DTYPES_KB_REGISTRY=/var/lib/my-host/terminology/registry.json
lx-dtypes-kb-registry bootstrap

This boundary is strict: invalid registry state or an unloadable packaged identity exits nonzero and must block host startup.

Documentation

Start with the documentation index. Key guides include:

Build the documentation locally with:

python -m pip install -e ".[docs]"
make -C docs html

Development

git clone https://github.com/wg-lux/lx-data-models.git
cd lx-data-models
uv sync --extra dev
uv run pyright
uv run pytest -q
uv run make -C docs html

Knowledge-base fixtures and tests must not contain patient data, credentials, or machine-local paths. Generated output belongs in temp/generated_exports/ or a test-local temporary directory.

See CONTRIBUTING.md for the full contributor and release workflow, CHANGELOG.md for release notes, and SECURITY.md for responsible vulnerability reporting.

License and citation

Distributed under the MIT License. If you use lx-dtypes in published work, cite the project using CITATION.cff.

Metadata

Release files for lx-dtypes 0.2.28

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lx-dtypes 0.2.28
File	Size	Uploaded
lx_dtypes-0.2.28.tar.gz	2.6 MB	Aug 26, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for lx-dtypes 0.2.28
File	Interpreter	ABI	Platform	Reset
lx_dtypes-0.2.28-py3-none-any.whl 783.5 kB Aug 26, 2026	Python 3	none	any	Details

Total release size: 3.4 MB

Release files / lx_dtypes-0.2.28.tar.gz

Download URL	lx_dtypes-0.2.28.tar.gz
Size	2.6 MB
Tags	Source
SHA-256 checksum How to use checksums	`a2ad7552925cf2b690e6e4d4b29181d99f61f7227f406088dd1685fe763c7105`
BLAKE2b-256 checksum How to use checksums	`e61f880909429eae4fea21417a0b41dcea6877fe0a04e2f55f31eb42dd61f173`
Upload date	Aug 26, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.13`

Release files / lx_dtypes-0.2.28-py3-none-any.whl

Download URL	lx_dtypes-0.2.28-py3-none-any.whl
Size	783.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`36177d41f0d1f9e20bb6f35db287a2caead58bc79e4314d92edd181c9baebe85`
BLAKE2b-256 checksum How to use checksums	`710df889297ad7e5c53cbb55c6304790cce107f473bc0504e6f94dc38630a0c2`
Upload date	Aug 26, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.13`