fhir-server/samples/docker

Running Azure FHIR Server with Docker

IMPORTANT: This sample has been created to enable Dev/Test scenarios and is not suitable for production scenarios. Passwords are contained in deployment files, the SQL server connection is not encrypted, authentication on the FHIR Server has been disabled, and data is not persisted between container restarts.

The following instructions detail how to build and run the FHIR Server in Docker on Linux.

Use CI image

If it is not desirable to clone this repository and build locally an image of the most recent CI build is available from the Microsoft Container Registry(mcr.microsoft.com/healthcareapis). Both of the following methods will generate a R4 server, but a STU3 or R5 server can be created by changing which image is pulled.

Using docker-compose this image can be started with the following steps:

1. Open a terminal window.
2. Set the enviornment variable SAPASSWORD to what you want the SQL access password to be. Be sure to follow the SQL server password complexity requirements.
3. Copy & save a local version of the docker-compose file from the release directory of the fhir-server project.
4. Run the command:

docker-compose up -d .

5. After giving the container a minute to start up it should be accessable at http://localhost:8080/metadata.

Using just docker this image can be started with the following steps. Replace the <SA_PASSWORD> below with your chosen SQL connection password, following the complexity rules linked above.

1. Open a terminal window.
2. Run the command:

docker network create fhir_network

3. Run the command:

docker run --net fhir_network --name fhir_sql -e SA_PASSWORD=<SA_PASSWORD> -e ACCEPT_EULA="Y" -d mcr.microsoft.com/mssql/server

4. Give the SQL server a minute to start up.
5. Run the command:

docker run --net fhir_network -e FhirServer__Security__Enabled="false" -e SqlServer__ConnectionString="Server=tcp:fhir_sql,1433;Initial Catalog=FHIR;Persist Security Info=False;User ID=sa;Password=<SA_PASSWORD>;MultipleActiveResultSets=False;Connection Timeout=30;" -e SqlServer__AllowDatabaseCreation="true" -e SqlServer__Initialize="true" -e SqlServer__SchemaOptions__AutomaticUpdatesEnabled="true" -e DataStore="SqlServer" -p 8080:8080 -d mcr.microsoft.com/healthcareapis/r4-fhir-server azure-fhir-api

6. After giving the container a minute to start up it should be accessible at http://localhost:8080/metadata.

Build and run with SQL Server using Docker Compose

Another way to get the Azure FHIR Server up and running on Docker is to build and run the Azure FHIR Server with a SQL server container using docker compose. Run the following command, replacing <SA_PASSWORD> with your chosen password (be sure to follow the SQL server password complexity requirements), from the root of the microsoft/fhir-server repository:

env SAPASSWORD='<SA_PASSWORD>' docker-compose -f samples/docker/docker-compose.yaml up -d

Given the FHIR API is likely to start before the SQL server is ready, you may need to restart the API container once the SQL server is healty. This can be done using docker restart <container-name>, i.e. docker restart docker restart docker_fhir-api_1.

Once deployed the FHIR Server metadata endpoint should be avaialble at http://localhost:8080/metadata/.

Run in Docker with a custom configuration

To build the azure-fhir-api image run the following command from the root of the microsoft/fhir-serverrepository:

The default configuration builds an image with the FHIR R4 API:

docker build -f samples/docker/Dockerfile -t azure-fhir-api .

For STU3 use the following command:

docker build -f samples/docker/Dockerfile -t azure-fhir-api --build-arg FHIR_VERSION=Stu3 .

The container can then be run, specifying configuration details such as:

docker run -d \
    -e FHIRServer__Security__Enabled="false"
    -e SqlServer__ConnectionString="Server=tcp:<sql-server-fqdn>,1433;Initial Catalog=FHIR;Persist Security Info=False;User ID=sa;Password=<sql-sa-password>;MultipleActiveResultSets=False;Connection Timeout=30;" \
    -e SqlServer__AllowDatabaseCreation="true" \
    -e SqlServer__Initialize="true" \
    -e SqlServer__SchemaOptions__AutomaticUpdatesEnabled="true" \
    -e DataStore="SqlServer" \
    -p 8080:8080
    azure-fhir-api azure-fhir-api