Ruby

README.md

SyntheaTM Patient Generator Build Status

SyntheaTM is a Synthetic Patient Population Simulator. The goal is to output synthetic, realistic (but not real), patient data and associated health records in a variety of formats.

Read our wiki for more information.

Currently, SyntheaTM features:

  • Birth to Death Lifecycle
  • Configuration-based statistics and demographics (defaults with Massachusetts Census data)
  • Modular Rule System
    • Drop in Generic Modules
    • Custom Ruby rules modules for additional capabilities
  • Primary Care Encounters, Emergency Room Encounters, and Symptom-Driven Encounters
  • Conditions, Allergies, Medications, Vaccinations, Observations/Vitals, Labs, Procedures, CarePlans
  • Formats
    • FHIR (STU3 v3.0.1 and DSTU2 v1.0.2)
    • C-CDA
    • CSV
  • Rendering Rules and Disease Modules with Graphviz

Quick Start

Installation

System Requirements: SyntheaTM requires Ruby 2.1.0 or above.

To clone the SyntheaTM repo and install the necessary gems:

git clone https://github.com/synthetichealth/synthea.git
cd synthea
gem install bundler
bundle install

Generate Synthetic Patients

Generating the population one at a time...

bundle exec rake synthea:generate

Or generating the population for a county and time based on census statistics...

bundle exec rake synthea:generate['./config/Suffolk_County.json']

Some settings can be changed in ./config/synthea.yml.

SyntheaTM will output patient records in C-CDA (requires running instance of Mongo DB) and FHIR STU3 formats in ./output.

Upload to FHIR Server

After generating data, upload it to a STU3 FHIR server:

bundle exec rake synthea:fhirupload[http://server/fhir/baseDstu3]

SyntheaTM GraphViz

Generate graphical visualizations of SyntheaTM rules and modules. Requires GraphViz to be installed.

brew install graphviz
bundle exec rake synthea:graphviz

License

Copyright 2016-2017 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

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.