Skip to content

kind-lab/voice-biomarker-fhir

Repository files navigation

Introduction

The Voice as a Biomarker for AI Health (VBAI) profiles are based on FHIR R4 and derived from US Core STU5 where possible. The profiles capture the data collected in the VBAI study.

What is Voice as a Biomarker for AI?

The National Institue of Health (NIH) started the Bridge2AI initiative to fund the creation of foundational datasets in the medical field. Voice as a Biomarker for AI(VBAI) is one of five foundational datasets being constructed currently. The VBAI project will capture multimodal data from vocal recordings, genomic screens, waveform profiles, and electronic health records. The goal of the VBAI project is to create a dataset that can be used to create applications to diagnose conditions based on voice recordings. The researchers creating the VBAI dataset are multidisciplinary and across multiple institutions in Canada, USA, and France.

Install Dependencies

  1. Set up FSH and SUSHI - SUSHI Setup Guide
  • Install Node.js (needed for SUSHI): https://nodejs.org/en/
    • Check node.js is properly set up: node --version or npm --version
  • Install SUSHI: npm install -g fsh-sushi
  1. Generate FHIR resources from FSH
  • In the main directory of the repo run sushi .
  • This command will generate the FHIR resources from the FSH files
  1. Set up the IG Publisher
  • Install Jekyll (need for the IG html output)
  • Run ./_updatePublisher.sh from the top of the repository to get the latest IG Publisher
    • If _updatePublisher.sh does not work you can manually download the IG publisher
  1. Install Fhir to FSH resource
  • Install GOFSH (need for generating fsh files)

Detailed Steps

  1. Retrieve FHIR JSON Files
  1. Generate the VBAI implementation guide
  • In voice-biomarker-fhir, run ./_genonce.sh from the top of the repository to generate the VBAI implementation guide

Quickstart:

mkdir quickstart-IG
cd quickstart-IG
git clone https://github.com/kind-lab/voice-biomarker-fhir.git
git clone https://github.com/kind-lab/reproschema-to-fhir.git --recursive
cd reproschema-to-fhir
pip install -e .
touch .env
git submodule update --init --recursive
echo -e "CODESYSTEM_URI = https://voicecollab.ai/fhir/CodeSystem/" >> .env
echo -e "VALUESET_URI = https://voicecollab.ai/fhir/ValueSet/" >> .env
echo -e "QUESTIONNAIRE_URI = https://kind-lab.github.io/vbai-fhir/" >> .env
echo -e "QUESTIONNAIRE_LANGUAGE = en" >> .env
echo -e "FHIR_QUESTIONNAIRE_MODE = AnswerOptions" >> .env
./job.sh
cd .. # quickstart-IG
cp -r ./reproschema-to-fhir/output/ fsh_files
gofsh fsh_files
rm -r ./voice-biomarker-fhir/input/fsh/instances
cp -r gofsh/input/fsh/instances ./voice-biomarker-fhir/input/fsh

cd voice-biomarker-fhir
mkdir ./input-cache
curl -sS -L https://github.com/HL7/fhir-ig-publisher/releases/latest/download/publisher.jar -o ./input-cache/publisher.jar
chmod +x ./input-cache/publisher.jar
java -jar -Xms4096M -Xmx6144M -XX:NewRatio=1 -XX:-UseAdaptiveSizePolicy input-cache/publisher.jar ig.ini