A web application that allows you to build healthcare surveys using the HL7® FHIR® Questionnaire international data standard using an interactive, drag-and-drop interface, and export JSON to be used in Stanford Spezi iOS and Android applications to deliver surveys to patients.
- Drag and drop survey creation
- Exports surveys as HL7® FHIR® Questionnaires
- Upload and continue editing existing surveys
- Set skip logic and validation rules
- Node.js (version 24 or greater) & npm
- To use the application online, visit https://stanfordbdhg.github.io/phoenix.
First, ensure that Node.js (version 24 or greater) and npm are installed on your system.
In your terminal, clone this repository from GitHub to your local computer.
git clone https://github.com/StanfordBDHG/phoenix.gitRun the following command in the project directory to install dependencies.
npm installNow, run the following command to start the application in development mode.
npm run devYou should see the following message in your terminal if the application is running successfully.
VITE v6.4.1 ready in 133 ms
➜ Local: http://localhost:3000/
➜ Network: use --host to expose
➜ press h + enter to show helpYou can now open http://localhost:3000/phoenix in your browser to view the application.
Run the unit tests with Jest:
npm testThe end-to-end tests in e2e/ use Playwright to drive the app in a real browser, covering drag-and-drop in the survey tree and the reordering of answer options. They start their own development server. The first time, install Playwright's browser:
npx playwright install chromium
npm run test:e2eTo run them against your installed Google Chrome instead, use PLAYWRIGHT_CHANNEL=chrome npm run test:e2e.
The animated demo at the top of this README (figures/survey-builder-demo.gif) is recorded by scripts/record-readme-demo.mjs. To re-record it after UI changes, start the development server with npm run dev, then run the following in a second terminal. This requires ffmpeg.
npm run record:demoFirst, ensure that Node.js (version 24 or greater) and npm are installed on your system.
In your terminal, clone this repository from GitHub to your local computer.
git clone https://github.com/StanfordBDHG/phoenix.gitRun the following command in the project directory to install dependencies.
npm installNow, run the following command to build the application for production.
npm run buildThe build files will be found in the build/ subdirectory. You may deploy these files to the static web hosting service of your choice.
First, build the Docker image:
docker build -t phoenix-survey-builder .Then, run the Docker image:
docker run -p 8080:80 phoenix-survey-builderTip
You may also substitute 8080 in the command above with a different port of your choice.
Open http://localhost:8080/phoenix in your browser to view the application.
The repository contains a GitHub Action that will deploy the application to GitHub pages: deploy.yml.
Before using the action:
- Update
package.jsonwith the full GitHub pages URL for your repository in thehomepagekey, i.e.https://username.github.io/repository. - Update the main route path in
src/router/index.tsxwith your repository name:
<Route path="/YOUR_REPOSITORY_NAME" element={
// remainder of code is unchangedThe Phoenix Survey Builder is licensed under the MIT license. For a full list of contributors, see CONTRIBUTORS.md.
Phoenix was originally forked from the Structor project in August 2022. We are grateful to the Helse Norge team for open-sourcing their work.
HL7®, and FHIR® are the registered trademarks of Health Level Seven International and their use of these trademarks does not constitute an endorsement by HL7.
This software is not intended to be a medical device.


