FSH Online is a web application for authoring FHIR Shorthand (FSH) and running the SUSHI compiler on the authored FSH directly in a web browser. It also runs the GoFSH decompiler to translate FHIR definitions into FSH. It is available on https://fshonline.fshschool.org/.
- Maintainers: This project is maintained by the HL7 community.
- Issues / Discussion: For FSH Online issues, such as bug reports, comments, suggestions, questions, and feature requests, visit FSH Online GitHub Issues. For discussion of FHIR Shorthand and its associated projects, visit the FHIR Community Chat @ https://chat.fhir.org. The #shorthand stream is used for all FHIR Shorthand questions and discussion.
- License: All contributions to this project will be released under the Apache 2.0 License, and a copy of this license can be found in LICENSE.
- Contribution Policy: The FSH Online Contribution Policy can be found in CONTRIBUTING.md.
- Security Information: The FSH Online Security Information can be found in SECURITY.md.
- Compliance Information: FSH Online uses SUSHI and GoFSH, which are designed for use with FHIR artifacts conforming to FHIR R4, FHIR R4B, or FHIR R5. For more details, see the README files for SUSHI and GoFSH.
To learn more about FSH Online, watch the Knowledge Sharing Sessions for Developing FSH Tools (view the slides here) and Developing FSH Online (view the slides here). These sessions provide a technical overview of the codebase, summarize key concepts for developers, and demonstrate how to add new FSH examples.
To run the project locally, Node.js must be installed on the user's system.
In order to install all the required dependencies for the project, clone the repository and run the following command:
npm installOnce the dependencies are installed, the application can be run in development mode by running the following command:
npm startOpen http://localhost:5173/ to view it in the browser. The page will reload if you make edits. Lint and prettier errors will appear in the console.
FSH Online supports easily adding FHIR Shorthand examples that can be viewed in the editor. All examples are kept in the FSHOnline-Examples repo, and FSH authors are encouraged to submit example FSH files to the FSHOnline-Examples repo.
The following NPM tasks are useful in development.
To run the project's tests, run the following command:
npm testThis will launch the test runner in the interactive watch mode. For more information, see the Vitest documentation.
To run the linter for the project, run the following command:
npm run lintAny issues will be listed. Some issues can be automatically fixed by lint. In order to fix these issues, run the following command:
npm run lint-fixTo run the prettier code formatting, run the following command:
npm run prettierTo build the app for production, run the following command:
npm run buildThis will bundle the project in production mode and optimize the build for the best performance. The build will be output to the dist folder. This build is minified and can be used to deploy the application. For more information, see Vite's Building for Production documentation and the build CLI options
To serve the built application locally for testing, run the following command:
npm run previewThis will serve the built application from the dist directory. It will be served on port 4173. You can access it at the following URL: http://localhost:4173/.
To learn more about FHIR Shorthand (FSH), check out the specification. To learn more about SUSHI, check out the documentation and to learn more about GoFSH, visit the documentation. For other resources and tools to use with FHIR Shorthand, check out FSH School.
To learn React, check out the React documentation.
Copyright 2019-2024 Health Level Seven International
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.