SyntheaTM Module Builder
The SyntheaTM Module Builder is a visual editor for creating and modifying SyntheaTM Patient Generator modules using the SyntheaTM Generic Module Framework. It supports the entire Generic Module Framework specification and allows users to create full-featured modules without needing to directly edit JSON files. It is preloaded with all modules contained within the current SyntheaTM Github Repository. Users can either edit these modules or create new ones to extend the capabilities of SyntheaTM.
Users are encouraged to use the hosted version of the Module Builder:
If you are new to authoring SyntheaTM modules, please review the Generic Module Framework (GMF) Documentation. Some familiarity with the GMF is required before beginning the authoring process.
npm install npm start
This will start a local copy running at
Modules created and edited through the Module Builder must be downloaded and saved as a JSON file.
The Module Builder currently does not persist local changes across browser sessions, so do not close or navigate
away from the page without first saving your work as a local file first. Click the
Download button at the
top of the interface, and you can either copy the JSON in the modal text box, or click the
Download button on the bottom
of the modal to save as a local file.
Once saved as a JSON file (using the
.json extension), you can use the module within your own local installation of Synthea.
See the Generic Module Framework for information on where to place the file.
The following information is only relevant to developers improving the Module Builder itself.
Synchronizing Generic Modules in Synthea
This application currently embeds all generic modules within the application. In order to
update these modules to match the most recent ones available in the Synthea repository,
build-modules script, pointing to the modules directory within a local copy of
npm run build-modules ../synthea/src/main/resources/modules # Point to the modules directory of synthea git status # This should have changed ./src/data/modules.js npm test # Run tests to ensure the new modules file valid
To run tests on the Module Builder, execute the following command:
Deploying Updated Version of Synthea
If you have administrative access to the Generic Module Builder repository, you can deploy updates to the Module Builder site. Before deploying, you should consider synchronizing the modules in the repository and must run the tests.
npm run deploy
This updates the
gh-pages branch on the repository with the new build, and changes will be reflected on the
site within a few minutes.
Copyright 2016-2018 The MITRE Corporation
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
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.