Skip to main content

Getting Started

Choose your path based on what you want to do.

Run the FHIR Server

Deploy a fully-featured FHIR R4/R5 server.

The fastest way to run locally with SQL Server included:

git clone https://github.com/brendankowitz/ignixa-fhir.git
cd ignixa-fhir
echo "SQL_SA_PASSWORD=<your-password>" > .env
docker compose up -d

Access at http://localhost:8080/metadata

See Docker Deployment for configuration options.

Azure

One-click deployment to Azure App Service:

Deploy to Azure

See Azure Deployment for CLI options.

From Source

git clone https://github.com/brendankowitz/ignixa-fhir.git
cd ignixa-fhir
dotnet build All.sln
cd src/Application/Ignixa.Web
dotnet run

Requires SQL Server configured in appsettings.Development.json.

Use the Core SDK

Build custom FHIR applications with standalone NuGet packages. No server required.

dotnet add package Ignixa.Serialization   # JSON parsing
dotnet add package Ignixa.FhirPath # FHIRPath evaluation
dotnet add package Ignixa.Validation # Resource validation
dotnet add package Ignixa.FhirFakes # Test data generation

See Core SDK Overview for all packages.

CLI Tools

Standalone command-line tools:

dotnet tool install --global Ignixa.FhirFakes.Cli     # Generate test data
dotnet tool install --global Ignixa.Validation.Cli # Validate resources
dotnet tool install --global Ignixa.SqlOnFhir.Cli # Transform to Parquet/CSV

Next Steps

GoalNext Step
Try the FHIR APIQuick Start
Configure the serverServer Configuration
Build with the SDKCore SDK Overview