Installation

Requirements

Fhircraft requires a recent version of Python (3.10 or higher) and a Python package manager (e.g., pip) to be installed on your system.

Internet Connection (optional)

Fhircraft works completely offline. An internet connection is only needed if you want to dynamically download external FHIR resources and definitions at runtime.

Pydantic Knowledge

Fhircraft is built on Pydantic, meaning all FHIR resource models are Pydantic models with full access to their API. This documentation assumes basic Pydantic familiarity, so we recommend reviewing the Pydantic documentation if you're new to it.

Installation

Latest Release

Fhircraft is provided as a Python package and can be installed with your preferred package manager of choice, ideally by using a virtual environment. Open up a terminal and install the latest Fhircraft version with:

pip Poetry uv pipenv

pip install fhircraft

poetry add fhircraft

uv add fhircraft

pipenv install fhircraft

Development Version

Install the latest development version directly from the GitHub repository:

pip Poetry uv

pip install git+https://github.com/luisfabib/fhircraft.git

poetry add git+https://github.com/luisfabib/fhircraft.git

uv add git+https://github.com/luisfabib/fhircraft.git

Development installation

If you want to contribute to Fhircraft or work with a customized version:

Clone the Fhircraft repository

git clone https://github.com/luisfabib/fhircraft.git
cd fhircraft

Install in editable mode along with the development dependencies
```
pip install -e .[dev]
```

For detailed instructions on developing and contributing to Fhircraft, see the Contributing Guide.