-
Notifications
You must be signed in to change notification settings - Fork 655
Records
The overall objective of Synthea is to produce synthetic health records from generated patients. Synthea accomplishes this by keeping track of a barebones record for each patient throughout its generation. All record-related code can be found in the class org.mitre.synthea.world.concepts.HealthRecord with the exception of patient information such as birthdate, race, ethnicity, sex, etc. These are instead stored in an attributes map for each person object.
The class for the Synthea patient record can be found in src/main/java/org/mitre/synthea/world/concepts/HealthRecord.java.
At a high level, the record is structured as follows:
- death (date of death)
- encounters
- observations
- reports
- conditions
- allergies
- procedures
- immunizations
- medications
- careplans
- claim
- present
Note: present is a map that references active condition or procedures. This map allows for easy lookup to determine if a patient has a certain condition, as well as modification of the condition. Procedures and conditions are being tracked by this hash.
The resources appended to these arrays should be appended throughout the patient generation process, such that the array contents are always sorted in chronological order.
An important note: the record and arrays should NOT be manipulated directly. When writing to the record, use the record functions provided.
The FHIR Record uses the HAPI FHIR library to generate a FHIR Bundle which is exported to JSON format afterwards.
Supported FHIR Resources:
BundlePatientEncounterConditionAllergyIntoleranceObservationDiagnosticReportProcedureImagingStudyImmunizationCarePlanMedicationRequestOrganizationPractitionerClaim-
ExplanationOfBenefit(R4 and STU3 only, Blue Button 2.0 Implementation Guide in STU3) -
Coverage(R4 and STU3 only)
Encounters are processed to the FHIR record one at a time. When an encounter is processed, all the other unprocessed events/resource in procedures, conditions, observations, and immunizations that occur before the encounter are written to the FHIR record. This simulates the diagnoses and recording that takes place during medical encounters.
The CCDA Record uses the MDHT CDA Tools library along with templates from the health-data-standards gem to export patients in CCDA XML.
Supported CCDA Entries:
- Vital Signs
- Conditions
- Encounters
- Immunizations
- Procedures
- Care Plans
- Medications
You can enable text records in src/main/resources/synthea.properties by setting exporter.text.export = true. The Text Exporter will output a UTF-8 text file that lists a human-readable text file containing the patient record.
You can enable Comma-Separated Value (CSV) records in src/main/resources/synthea.properties by setting exporter.csv.export = true. The CSV Exporter will output a collection of UTF-8 CSV files that lists patients, encounters, medications, and so forth in separate files -- where patients and encounters have unique identifiers and other resources (such as conditions and medications) are appropriately linked to the patients and encounters. The exported files are suitable for an Extract-Transform-Load (ETL) process to import them into a relational database. See the CSV File Data Dictionary for definitions of the CSV files.
CPCDS is a data standard for exporting Common Payer Clinical Data Sets in a flat CSV file with repeating line numbers for multiple entries. Its primary role is to assist in transferring insurance data into FHIR Explanation of Benefits. See CPCDS Export.
The JSON Export is somewhat close to a Synthea "object dump". It uses the Gson library to serialize instances of the Person class into JSON. Each Person is written into a single JSON file in a directory called json, where ever Synthea is configured to output records. See JSON Export