Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/dhanyasukumaran1/fhir_query_validator/llms.txt

Use this file to discover all available pages before exploring further.

FHIR Query Validator is a Python package distributed via PyPI. This page covers installation requirements, recommended setup using virtual environments, and how to verify your installation is working correctly.

​
Requirements

  • Python: 3.8 or later
  • pip: 21.0 or later (comes with Python 3.8+)
  • Operating system: Linux, macOS, or Windows

​
Install with pip

The recommended way to install FHIR Query Validator is with pip: 
pip install fhir-query-validator
To install a specific version: 
pip install fhir-query-validator==1.0.0
To upgrade to the latest version: 
pip install --upgrade fhir-query-validator
Using a virtual environment keeps your project dependencies isolated. This is especially important in data science and healthcare environments where dependency conflicts can be subtle.
1

Create a virtual environment

python -m venv fhir-env
2

Activate the environment

source fhir-env/bin/activate
3

Install FHIR Query Validator

pip install fhir-query-validator

​
Install in a Jupyter notebook

If you’re using FHIR Query Validator in a Jupyter notebook, install the package from within the notebook to ensure it’s available in the correct kernel:
Jupyter cell
import sys
!{sys.executable} -m pip install fhir-query-validator
Then import and use normally:
Jupyter cell
from fhir_query_validator import FHIRQueryValidator

validator = FHIRQueryValidator()
result = validator.validate_query("Patient?family=Smith")
print(result.is_valid)

​
Verify your installation

After installation, verify the package is available: 
python -c "from fhir_query_validator import FHIRQueryValidator; print('Installation successful')"
You should see: 
Installation successful
To check the installed version: 
pip show fhir-query-validator

​
Troubleshooting

This usually means the package was installed in a different Python environment than the one you’re running. Check which Python is active:
which python  # Linux/macOS
where python  # Windows
Make sure you’ve activated your virtual environment before running your script, and that pip installed into the correct environment.
Avoid using sudo pip install as this modifies your system Python. Instead, use a virtual environment (recommended) or install with the --user flag:
pip install --user fhir-query-validator
Try installing in a fresh virtual environment to avoid conflicts with other packages. If you need FHIR Query Validator alongside specific library versions, check the package’s dependency requirements with:
pip show fhir-query-validator

​
Next steps

Quickstart

Validate your first FHIR query with a step-by-step working example.

Build docs developers (and LLMs) love

Get started for freeTalk to us