Skip to content

docs(tooling): add Libraries & SDKs section and move oehrpy there #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
platzhersh merged 1 commit into from
Sep 28, 2026
Merged

docs(tooling): add Libraries & SDKs section and move oehrpy there #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions docs/tooling/developer-tooling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,6 @@

**What it is:** A Java SDK for working with openEHR artefacts: parsing and serialising compositions, working with templates, and building AQL queries. EHRbase uses it internally.

## oehrpy

| | |
| --- | --- |
| Status | Active (alpha) |
| Cost | Free (Apache 2.0) |
| Open source | Yes |
| Language | Python |
| Owner and developer | [platzhersh](https://github.com/platzhersh) |
| Available from | [PyPI](https://pypi.org/project/oehrpy/) (`pip install oehrpy`) |
| Source | [github.com/platzhersh/oehrpy](https://github.com/platzhersh/oehrpy) |
| Documentation | [oehrpy.dev](https://oehrpy.dev/) |

**What it is:** A Python SDK for openEHR. It provides Pydantic models for the Reference Model 1.1.0, template-specific composition builders, FLAT and canonical JSON serialisation, a fluent AQL builder, an OPT parser and validator, and an async REST client for EHRbase.

**Who should use it:** Python developers building applications, data pipelines, or scripts against an openEHR CDR who want typed RM objects and IDE autocomplete instead of hand-assembling composition JSON. Its REST client and FLAT format support currently target EHRbase 2.26 and later.

## Archie

| | |
Expand Down
20 changes: 20 additions & 0 deletions docs/tooling/libraries-and-sdks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Libraries & SDKs

Libraries and software development kits (SDKs) that developers embed in their own applications to work with openEHR artefacts, data, and APIs.

## oehrpy

| | |
| --- | --- |
| Status | Active (alpha) |
| Cost | Free (Apache 2.0) |
| Open source | Yes |
| Language | Python |
| Owner and developer | [platzhersh](https://github.com/platzhersh) |
| Available from | [PyPI](https://pypi.org/project/oehrpy/) (`pip install oehrpy`) |
| Source | [github.com/platzhersh/oehrpy](https://github.com/platzhersh/oehrpy) |
| Documentation | [oehrpy.dev](https://oehrpy.dev/) |

**What it is:** A Python SDK for openEHR. It provides Pydantic models for the Reference Model 1.1.0, template-specific composition builders, FLAT and canonical JSON serialisation, a fluent AQL builder, an OPT parser and validator, and an async REST client for EHRbase.

**Who should use it:** Python developers building applications, data pipelines, or scripts against an openEHR CDR who want typed RM objects and IDE autocomplete instead of hand-assembling composition JSON. Its REST client and FLAT format support currently target EHRbase 2.26 and later.
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ nav:
- Clinical Data Repositories: tooling/clinical-data-repositories.md
- Knowledge Management: tooling/knowledge-management.md
- Developer Tooling: tooling/developer-tooling.md
- Libraries & SDKs: tooling/libraries-and-sdks.md
- Query Tools: tooling/query-tools.md
- Deprecated Tools: tooling/deprecated-tools.md
- Comparison Table: tooling/comparison-table.md
Expand Down