Skip to content

Latest commit

 

History

History
107 lines (93 loc) · 6.64 KB

README.md

File metadata and controls

107 lines (93 loc) · 6.64 KB
Raw

MyCarePlanner SMART on FHIR app

MyCarePlanner is a standards-based web application platform for patients and caregivers to engage in their care planning for multiple chronic conditions (MCC). The application is designed to be a proof-of-concept application to enable goal-oriented care planning. Patients and caregivers are granted the ability to write information into the application to share with their providers and see their health data from all their providers in one place.

MyCarePlanner supports both SMART standalone launch and EHR launch from a patient portal. It can connect to any Fast Healthcare Interoperability Resources (FHIR) endpoint based on 21st Century Cures Act access requirements for U.S. Core Data for Interoperability (USCDI) data elements. MyCarePlanner is one common app for patients and caregivers. A caregiver role is identified based on proxy user login in the EHR system.

MyCarePlanner is being developed as part of a broader Electronic Care Planning for People with Multiple Chronic Conditions project led by the National Institute of Diabetes and Digestive and Kidney Diseases (NIDDK) and the Agency for Healthcare Research and Quality (AHRQ). The project is supported by a multidisciplinary team including EMI Advisors, RTI International, and the Oregon Health and Sciences University (OHSU).

This code is under active development for pilot testing with patients and caregivers. To learn more about the e-Care Plan Project for MCC, visit: https://ecareplan.ahrq.gov/.

Development Details

Major dependencies

  • node.js
    • Minimum version that the team has tested
      • 16x
  • npm
    • Minimum version that the team has tested
      • 8x
  • yarn
    • Minimum version that the team has tested
      • 1.22.19

Branches

  • 'main' branch
    • The application itself
  • 'gh-pages' branch
    • Created automatically by the 'npm run deploy' command. Used to build and deploy the application for use in github.io
  • 'mui' branch
    • TODO: Dave to provide this information

Setup development environment

  1. Clone the application using https://github.com/chronic-care/mycareplanner.git
  2. Checkout the 'main' branch
  3. With administrative privileges, run:
    • npm install yarn -g
  4. Run yarn to install (Note: Running 'yarn' is a shortcut for running 'yarn install'):
    • yarn
  5. To run the application on localhost, run:
    • yarn start
  6. Open the following URL in a browser to test the local version in our test sandbox:
  7. Login with credentials
  8. Select Patricia Noelle, the primary test patient to load sample data so that it can be displayed/used in the application

Manage .env environment variables

  • .env is provided
  • .env.local can be created in the root folder (same level as .env) to override the properties in .env if desired
    • Note: This file is ignored by git

Manage 'package.json'

  • In general, do not commit updates to 'package.json' unless:
    • There is a valid and intentional dependency update
      • e.g. New dependencies are added, old dependencies are removed, dependency versions are updated for security or for preferential reasons
  • TODO: Create a combined ticket to address/update this and 'yarn.lock' maintenance

Mange 'yarn.lock'

Development environment setup after modifying 'package.json', 'yarn.lock', or checking out a new version of either

  1. Check out 'main' branch if needed
  2. Delete current 'yarn.lock' file
  3. Delete 'node_modules' folder
  4. Pull updates if needed
  5. Run yarn to install
    • yarn
  6. Refresh or restart development environment if there are any issues
  • TODO: Consider documenting/testing a faster yarn update version of this

Docker

  • To build with docker, run 'docker build .' from the root directory:
    • docker build .
  • This will build a container which serves content on port 80. Run this container with:
    • docker run -p 80:80 <hash>

Style guide

  • For consistent readability and isolated commit diffs, a specific style should be used for the project
    • TODO: Create a ticket to:
      • Define style
        • Potentially define it with a lint file and/or with VS Code settings
      • Lint can enforce the style but we would want to provide a way to keep the style synchronized in an automated fashion such as a script or by using the same development environment settings (e.g. using VS Code). It should be seamless so that one never sees a lint error to begin with simply by saving the file or running a script. Note: In VS Code this can even be done in real time as you type

Troubleshooting:

  • A yarn error similar to, "cannot find module yarn.js" is presented
    • With administrative privileges, run:
      • npm install yarn -g
  • A React error states that dependencies are missing when attempting to run yarn or npm install
    • Attempt to create a new React app to ensure that React will work on your device in general
      • Run the following:
        • npx create-react-app test
        • cd test
        • yarn start
      • Ensure the app launches in a browser
      • If the test app works, navigate back to the mycareplanner directory
      • Attempt to install the application
        • yarn
      • If there are no longer any errors installing, run:
      • If there are still errors installing, follow the directions in this Troubleshooting section titled, 'A yarn error similar to, "cannot find module yarn.js" is presented'
  • Typescript errors are presented which do not allow the application to compile