MITRE Interoperability Playbook

The purpose of the MITRE Interoperability Playbook is to create a web application that captures the learnings of the MITRE FHIR teams as they developed mCODE and other FHIR-based efforts – what worked well and what did not – and to provide a recipe to successfully launch and implement new healthcare interoperability initiatives.

You can see it up and running at https://mitre.github.io/playbook/

Installation

These installation instructions may seem verbose as they were written to be accessible to most anyone. It should go quickly if you already have the necessary tools installed and follow the jumps provided!

MacOS

It is most likely the case that these steps are incredibly similar for all other unix based operating systems

1. Open Terminal

2. Check if you have Git installed by inputting:

   git --version
   

   • If Git is already installed, Terminal should output something like:

     git version 2.37.1
     

     Jump to step 6 if this is the case.

   • If Terminal responded with anything that might indicate it did not recognize Git, such as:

     -bash: git: command not found
     

     continue to step 3.

3. Check if you have Homebrew installed by inputting:

   brew -v
   

   • If Homebrew is already installed, Terminal should output something like:

     Homebrew 4.2.19
     

     Jump to step 5 if this is the case.

   • If Terminal responded with anything that might indicate it did not recognize Homebrew, such as:

     -bash: brew: command not found
     

     continue to step 4.

4. Install Homebrew by inputting:

   /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
   

5. Install Git by inputting:

   brew install git
   

6. Configure Git to match your Github account:

   git config --global user.name "YOUR NAME"
   git config --global user.email "[email protected]"
   

   (Don't have a Github account? Register here then run the above commands)

7. Create a new directory to store this web app. Feel free to put this directory wherever makes sense. For the sake of simplicity, the following commands will create it directly in the home directory:

   cd ~
   

8. Clone the DEL Demo repository into your new directory by inputting:

   git clone https://github.com/CodeX-HL7-FHIR-Accelerator/playbook.git
   

9. Check if you have Ruby installed by inputting:

   ruby -v 
   

   • If Ruby is already installed, Terminal should output something like:

     ruby 3.2.2
     

     Jump to step 13 if this is the case.

   • If Terminal responded with anything that might indicate it did not recognize Ruby, such as:

     -bash: ruby: command not found
     

     continue to step 10.

10. Check if you have the Ruby Version Manager (RVM) by inputting:

    rvm -v
    

    • If RVM is already installed, Terminal should output something like:

      rvm 1.29.12 (latest) by Michal Papis, Piotr Kuczynski, Wayne E. Seguin [https://rvm.io]
      

      Jump to step 12 if this is the case.

    • If Terminal responded with anything that might indicate it did not recognize RVM, such as:

      -bash: rvm: command not found
      

      continue to step 11

11. Install RVM by inputting:

    \curl -L https://get.rvm.io | bash -s stable
    

    If it asks for your password, provide it. Once downloading RVM, you will need to close and reopen Terminal. Input:

    exit
    

    Then close Terminal, and open Terminal again.

12. Install Ruby by inputting:

    rvm install ruby-3.2.2
    

13. Install Rails.

    First, input the following to ensure that Ruby's package manager RubyGems is up to date:

    gem update --system
    

14. Set up your local instance of the app.

    First, make sure you're in the correct directory (Remember to change the cd path if you chose to set up the app in a different location):

    cd ~/playbook
    

    Create a gemset for the project:

    rvm gemset create playbook
    

    Switch to the RVM gemset you just created:

    rvm @playbook
    

    Next, ensure you have the Bundler gem installed by inputting:

    gem install bundler
    

    Finally, use Bundler to install the DEL Demo's gems:

    bundle install
    

Run Application

Once installation is complete, you can run the app by following these steps:

1. Open Terminal

2. Make sure your working directory is where the app is stored. If you followed the MacOS installation directions above with no variation, inputting the following will get you there:

   cd ~/playbook
   

   If that is not where your playbook directory is, instead input cd <path> where <path> is the path to your playbook directory.

3. Build the web site using middleman. You will also need to run this command every time you update the files in the source directory.

   middleman build
   

4. Start the middleman server.

   middleman server
   

5. The playbook web site should be running! Open a browser (I suggest Chrome) and type the following into the address bar:

   localhost:4567
   

6. When you're done using the app, you need to make sure the server stops running. To do this gracefully, you need to do two things:

   • First, go back to your Terminal window and stop the web site by using the hotkey:

     control-C
     

Copyright

Copyright 2024 The MITRE Corporation. All rights reserved.