Class |
Description |
Actions |
The Actions class represents the set of all actions the Flexporter can perform.
|
App |
|
ASCVD |
|
Attributes |
Task class to export a report of all Person attributes
that Synthea is aware of.
|
BB2RIF2CCW |
Utility for converting from BB2 RIF file format to CCW RIF file format.
|
BB2RIFBeneSplitter |
Utility for converting from original BB2 RIF 3 file bene output to one bene file per year.
|
BB2RIFExporter |
BlueButton 2 RIF format exporter.
|
BB2RIFMinimizer |
Functionality to filter a set of RIF files to leave only enough beneficiaries to cover all
claim types.
|
BB2RIFStructure |
A collection of enums and related that describe the structure of RIF files.
|
BB2RIFStructure.BENEFICIARY |
|
BB2RIFStructure.CARRIER |
|
BB2RIFStructure.DME |
|
BB2RIFStructure.EXPORT_SUMMARY |
|
BB2RIFStructure.HHA |
|
BB2RIFStructure.HOSPICE |
|
BB2RIFStructure.INPATIENT |
|
BB2RIFStructure.NPI |
|
BB2RIFStructure.OUTPATIENT |
|
BB2RIFStructure.PDE |
|
BB2RIFStructure.SNF |
|
BeneficiaryExporter |
Export beneficiary and beneficiary history files.
|
BiometricsConfig |
Class exposing various configurable biometric settings,
which are set in resources/biometrics.yml.
|
BirthStatistics |
BirthStatistics determines when a mother will give birth, the sex of
the baby, and the newborn height and weight.
|
BloodPressureValueGenerator |
Generate realistic blood pressure vital signs,
with impacts from select medications.
|
BloodPressureValueGenerator.SysDias |
|
BMI |
|
C19ImmunizationModule |
A module to simulate COVID19 Immunizations in the United States.
|
C19ImmunizationModule.VaccinationStatus |
|
C19Vaccine |
This class provides information on the currently Emergency Use Authorized (EUA) vaccines in the
United States.
|
C19Vaccine.EUASet |
|
C19VaccineAgeDistributions |
This class parses the CSV file that is created by calling the CDC API for COVID-19 vaccination
information.
|
C19VaccineAgeDistributions.AgeRange |
Representation of an age range in years with logic for parsing the format used by the CDC API.
|
CardiovascularDiseaseModule |
|
CarrierExporter |
Exporter for RIF Carrier File.
|
CCDAExporter |
Export C-CDA R2.1 files using Apache FreeMarker templates.
|
CDWExporter |
This exporter attempts to export synthetic patient data into
comma-separated value (CSV) files that align with the Veteran's
Health Administration (VHA) Corporate Data Warehouse (CDW).
|
ChartRenderer |
|
ChartRenderer.Base64EncodedChart |
|
ChartRenderer.ChartConfig |
POJO configuration for a chart.
|
ChartRenderer.ChartType |
Enumeration of supported chart types.
|
ChartRenderer.MultiTableChartConfig |
POJO configuration for a chart with data from a MultiTable.
|
ChartRenderer.MultiTableSeriesConfig |
POJO configuration for a chart series with data from a MultiTable.
|
ChartRenderer.PersonChartConfig |
POJO configuration for a chart with data from a Person object.
|
ChartRenderer.PersonSeriesConfig |
POJO configuration for a chart series with data from a Person object.
|
Claim |
|
Claim.ClaimCost |
|
CLIA |
Utility class for working with CLIA Lab Numbers.
|
ClinicalNoteExporter |
Export Clinical Notes using Apache FreeMarker templates.
|
Clinician |
|
ClinicianSpecialty |
ClinicianSpecialty is an enumeration of Clinical Specialties that a
Clinician can possess.
|
CMSStateCodeMapper |
Utility class for converting between state names and abbreviations and CMS provider state codes.
|
CodeMapper |
Utility class for dealing with code mapping configuration writers.
|
Components |
Various components used in the generic module framework.
|
Components.Attachment |
Attachment class to support inline image file generation,
raw base64 data, or URLs of image attachments for Observations.
|
Components.DateInput |
|
Components.Exact<T> |
An Exact quantity representing a single fixed value.
|
Components.ExactWithUnit<T> |
Variant of the Exact class, where a unit is required.
|
Components.Range<R extends java.lang.Number> |
A Range of values, with a low and a high.
|
Components.RangeWithUnit<R extends java.lang.Number> |
Variant of the Range class, where a unit is required.
|
Components.SampledData |
|
Concepts |
Task class to export a report of all clinical concepts
(aka Codes) that Synthea is aware of.
|
Config |
|
ConsolidatedClaimLines |
Utility class for consolidating multiple claim lines of the same type for the same clinician.
|
ConsolidatedClaimLines.ConsolidatedClaimLine |
|
ConsolidatedServicePeriods |
Utility class to group encounters by provider that are separated by less than a configurable
amount of time.
|
ConsolidatedServicePeriods.ConsolidatedServicePeriod |
|
ConstantValueGenerator |
A value generator that returns a set constant value for all eternity.
|
ContractHistory<T extends FixedLengthIdentifier> |
Utility class to manage a beneficiary's contract history.
|
Costs |
|
Costs.CostData |
Helper class to store a grouping of cost data for a single concept.
|
CoverageRecord |
A class that manages a history of coverage.
|
CPCDSExporter |
|
CSVEligibility |
|
CSVExporter |
Researchers have requested a simple table-based format that could easily be
imported into any database for analysis.
|
CSVExporter.ClaimTransactionType |
|
CSVExporter.PaymentMethod |
|
CustomFHIRPathResourceGeneratorR4<T extends org.hl7.fhir.r4.model.Resource> |
This class can be used to generate resources using FHIRPath expressions.
|
CustomFHIRPathResourceGeneratorR4.PathType |
A simple enum to diffirentiate between types of FHIRPaths in the special use case of generating
FHIR Resources.
|
DeathModule |
|
DefaultPlanEligibility |
DefaultPlanEligibility can be used for the No Insurance plan.
|
DefaultRandomNumberGenerator |
A default implementation of the RandomNumberGenerator interface.
|
Demographics |
Demographics class holds the information from the towns.json and associated county config files.
|
Distribution |
Representation of different types of distributions that can be used to represent
random variables used in Synthea States.
|
Distribution.Kind |
|
DMEExporter |
Exporter for RIF DME (durable medical equipment) file.
|
Employment |
A model of employment / unemployment that is expected to be run as a part of the LifecycleModule.
|
EncounterModule |
|
Entity |
This class represents a set of desired demographic information about a Person to be simulated.
|
EntityDeserializer |
|
EntityManager |
Singleton class that manages all Entities in a simulation.
|
Exporter |
|
Exporter.ExporterRuntimeOptions |
Runtime configuration of the record exporter.
|
Exporter.SupportedFhirVersion |
Supported FHIR versions.
|
ExportHelper |
Helper class for common logic that is used by more than one otherwise unrelated exporter.
|
ExpressedConditionRecord |
|
ExpressedSymptom |
|
ExpressionProcessor |
|
FactTable |
The FactTable helper class aids in the export of database-style
Fact Tables.
|
FhirDstu2 |
|
FhirGroupExporterR4 |
|
FhirPathUtils |
|
FhirPractitionerExporterDstu2 |
|
FhirPractitionerExporterR4 |
|
FhirPractitionerExporterStu3 |
|
FhirR4 |
|
FhirR4.USCoreVersion |
|
FhirR4PatientHome |
Singleton class to manage the instance of the "Patient's Home" Location resource.
|
FhirStu3 |
|
FieldWrapper |
|
FieldWrapper.DateFieldWrapper |
DateFieldWrapper is used to represent a field on a resource representing a date and/or time.
|
FieldWrapper.ReferenceFieldWrapper |
|
FixedLengthIdentifier |
Base class for fixed length, alphanumeric identifiers.
|
FlexporterJavascriptContext |
|
Framingham |
|
Generator |
Generator creates a population by running the generic modules each timestep
per Person.
|
Generator.GeneratorOptions |
Helper class following the "Parameter Object" pattern.
|
Graphviz |
|
GrowthChart |
Represents a growth chart for a particular measure.
|
GrowthChart.ChartType |
|
GrowthChartEntry |
Represents the LMS parameters on the CDC growth chart for a particular sex and age in months.
|
GrowthDataErrorsEditor |
This editor simulates errors that occur in growth data as it would be collected in a clinical
setting.
|
HealthInsuranceModule |
|
HealthRecord |
HealthRecord contains all the coded entries in a person's health record.
|
HealthRecord.Code |
HealthRecord.Code represents a system, code, and display value.
|
HealthRecord.EncounterType |
|
HealthRecord.ReactionSeverity |
|
HealthRecordEditor |
The HealthRecordEditor offers an interface that can be implemented to modify a Synthea Person's
HealthRecord.
|
HealthRecordEditors |
A singleton class for managing all of the implementations of HealthRecordEditor.
|
HHAExporter |
Exporter for RIF HHA (home health agency) file.
|
HICN |
Utility class for working with CMS HICNs.
|
HospiceExporter |
Exporter for RIF Hospice file.
|
HospitalExporterDstu2 |
|
HospitalExporterR4 |
|
HospitalExporterStu3 |
|
IdentityRecord |
|
Immunizations |
This is a complete, but fairly simplistic approach to synthesizing immunizations.
|
IncomeSpenddownEligibility |
A class that defines the elgibility logic for Income medical cost spenddowns
(MNIL, in the case of Medicaid).
|
InnerClassTypeAdapterFactory<T> |
Adapts values whose runtime type may differ from their declaration type.
|
InpatientExporter |
Exporter for RIF Inpatient File.
|
InsurancePlan |
A class that defines an insurance plan.
|
IoMapper |
Class for handling simulation inputs and outputs.
|
IoMapper.IoType |
|
IPayerAdjustment |
Interface to abstract various claim adjustment strategies.
|
IPlanEligibility |
|
IPlanFinder |
Find a particular provider by service.
|
IProviderFinder |
Find a particular provider by service.
|
JSONExporter |
Class that manages the export of a Synthea Person and their related information into a JSON
format.
|
JSONExporter.LocalDateSerializer |
Custom serialization for LocalDates as Java 17 does not allow Gson to automatically serialize
them.
|
JSONExporter.PersonSerializer |
|
JSONExporter.RandomSerializer |
|
JSONExporter.ShortPayerSerializer |
Trimming down the attributes that are serialized out when exporting the Person record.
|
JSONExporter.StateSerializer |
|
JSONExporter.SyntheaExclusionStrategy |
|
JSONSkip |
This interface is a marker interface indicating that a field should be skipped in the
JSON export.
|
LateAdopterModel |
The COVID-19 Immunization Module uses actual data to predict whether someone will get a vaccine
during the time period for which data is available.
|
LifecycleModule |
|
LocalDateDeserializer |
|
Location |
|
Logic |
Logic represents any portion of a generic module that requires a logical
expression.
|
Logic.ActiveAllergy |
|
Logic.ActiveCarePlan |
The Active CarePlan condition type tests whether a given care plan is currently prescribed and
active for the patient.
|
Logic.ActiveCondition |
The Active Condition condition type tests whether a given condition is currently diagnosed and
active on the patient.
|
Logic.ActiveMedication |
The Active Medication condition type tests whether a given medication is currently prescribed
and active for the patient.
|
Logic.Age |
The Age condition type tests the patient's age, in a given unit.
|
Logic.And |
The And condition type tests that a set of sub-conditions are all true.
|
Logic.AtLeast |
The At Least condition type tests that a minimum number of conditions
from a set of sub-conditions are true.
|
Logic.AtMost |
The At Most condition type tests that a maximum number of conditions
from a set of sub-conditions are true.
|
Logic.Attribute |
The Attribute condition type tests a named attribute on the patient entity.
|
Logic.Date |
The Date condition type tests the current year, month, or date being simulated.
|
Logic.False |
The False condition always returns false.
|
Logic.Gender |
The Gender condition type tests the patient's gender.
|
Logic.Not |
The Not condition type negates its sub-condition.
|
Logic.Observation |
The Observation condition type tests the most recent observation of a given type against a
given value.
|
Logic.Or |
The Or condition type tests that at least one of its sub-conditions is true.
|
Logic.PriorState |
The PriorState condition type tests the progression of the patient through the module, and
checks if a specific state has already been processed (in other words, the state is in the
module's state history).
|
Logic.Race |
The Race condition type tests a patient's race.
|
Logic.SocioeconomicStatus |
The Socioeconomic Status condition type tests the patient's socioeconomic status.
|
Logic.Symptom |
The Symptom condition type tests a patient's current symptoms.
|
Logic.True |
The True condition always returns true.
|
Logic.VitalSign |
The Vital Sign condition type tests a patient's current vital signs.
|
Mapping |
|
MBI |
Utility class for working with CMS MBIs.
|
MetadataExporter |
|
Module |
Module represents the entry point of a generic module.
|
Module.ModuleSupplier |
ModuleSupplier allows for lazy loading of Modules.
|
ModuleOverrides |
Task class to generate a properties list of "overridable" fields within the modules,
which includes the name of the file, the JSONPath to the field, and the original value.
|
Names |
|
NHANESSample |
Representation of a sample of information from NHANES - https://www.cdc.gov/nchs/nhanes/index.htm
Synthea contains a file that is a sample of NHANES information from 1999 - 2015 where heights
and weights were recorded for individuals between 24 and 36 months old.
|
OutpatientExporter |
Exporter for RIF Outpatient File.
|
PartCContractHistory |
Utility class to manage a beneficiary's part C contract history.
|
PartCContractID |
Utility class for working with CMS Part C Contract IDs.
|
PartDContractHistory |
Utility class to manage a beneficiary's part D contract history.
|
PartDContractID |
Utility class for working with CMS Part D Contract IDs.
|
PatientExporter |
This interface defines an exporter that will be run for every patient
in a simulation.
|
Payer |
|
PayerAdjustmentFixed |
Fixed payment adjustment strategy.
|
PayerAdjustmentNone |
Default payer adjustment strategy -- no adjustment.
|
PayerAdjustmentRandom |
Randomized payment adjustment strategy.
|
PayerManager |
A class that maintains and manages Payers.
|
PDEExporter |
Exporter for RIF PDE (prescription) file.
|
PediatricGrowthTrajectory |
This class provides growth trajectories for individuals between 2 and 20.
|
PediatricGrowthTrajectory.YearInformation |
Container for data on changes between years for BMI information.
|
Period |
A simple representation of a time period with a start and end date.
|
Person |
|
PhysiologyGeneratorConfig |
ValueGenerator configuration for a physiology model file.
|
PhysiologySimulator |
Executes simulations of physiology models represented in SBML files.
|
PhysiologySimulator.SimConfig |
POJO configuration for the simulation.
|
PhysiologyValueGenerator |
A ValueGenerator for generation of values from a physiology simulation.
|
Place |
Place represents a named place with a postal code and coordinate.
|
PlainBigDecimal |
Utility class to use in place of BigDecimal to ensure doubles are serialized with five
significant digits, no trailing zeros and without scientific notation.
|
PlanBenefitPackageID |
Utility class for working with CMS Plan Benefit Package IDs.
|
PlanEligibilityFinder |
Returns the requested Payer eligibility algorithm.
|
PlanFinderBestRates |
Find a particular provider by service.
|
PlanFinderPriority |
|
PlanFinderRandom |
Find a particular provider by service.
|
PlanRecord |
A class that manages a person's record of plan uses and expenses for an enrollment period.
|
PostCompletionExporter |
This interface defines an exporter that will be invoked
after the entire population has been generated.
|
PovertyMultiplierFileEligibility |
An eligiblity type based on a file that dictates by-age and by-state poverty multiplier
thresholds.
|
PreGenerator |
Class for handling pre-simulation outputs.
|
PreGenerator.PreGeneratorArg |
|
Provider |
|
Provider.ProviderType |
|
ProviderFinderNearest |
|
ProviderFinderNearestMedicare |
|
ProviderFinderRandom |
|
QuadTree |
Simple QuadTree class that is optimized for query speed.
|
QuadTreeElement |
|
QualifyingAttributesEligibility |
An eligibility criteria based on whether a person has any of the given attributes.
|
QualifyingConditionCodesEligibility |
An algorithm that defines the logic for eligibility based on a set of qualifying condition
codes.
|
QualityOfLifeModule |
|
RaceAndEthnicity |
|
RandomCodeGenerator |
Generates random codes based upon ValueSet URIs, with the help of a FHIR
terminology service API.
|
RandomCollection<E> |
Random collection of objects, with weightings.
|
RandomNumberGenerator |
|
RandomValueGenerator |
Generate random values within a defined range.
|
ReactionProbabilities |
ReactionProbabilities is a structure to capture the kind and severity of reaction for a
given AllergyIntolerance.
|
ReactionProbabilities.SeverityProbability |
|
RIFExporter |
Base class for all of the type-specific exporters.
|
RIFExporter.ClaimType |
|
RunFlexporter |
Entrypoint for the "Flexporter" when run as a standalone gradle task.
|
Seed |
A representation of demographic information for an Entity for a period of time.
|
SerializableTypeAdapter<E extends java.io.Serializable> |
The SerializableTypeAdapter is a GSON TypeAdapter used to allow GSON to handle classes
that are Serializable, but can't be instrumented by GSON for whatever reason.
|
SimpleCSV |
Helper class to translate CSV data back and forth between raw string data and a simple data
structure.
|
SimpleYML |
Helper class to parse a YAML file into a (hopefully) useable map format.
|
SimRunner |
Class for handling execution of a PhysiologySimulator.
|
SNFExporter |
Exporter for RIF SNF File.
|
State |
|
State.AllergyEnd |
The AllergyEnd state type indicates a point in the module where a currently active allergy
should be ended, for example if the patient's allergy subsides with time.
|
State.AllergyOnset |
The AllergyOnset state type indicates a point in the module where the patient acquires an
allergy.
|
State.CallSubmodule |
The CallSubmodule state immediately processes a reusable series of states contained in a
submodule.
|
State.CarePlanEnd |
The CarePlanEnd state type indicates a point in the module where a currently prescribed care
plan should be ended.
|
State.CarePlanStart |
The CarePlanStart state type indicates a point in the module where a care plan should be
prescribed.
|
State.ConditionEnd |
The ConditionEnd state type indicates a point in the module where a currently active condition
should be ended, for example if the patient has been cured of a disease.
|
State.ConditionOnset |
The ConditionOnset state type indicates a point in the module where the patient acquires a
condition.
|
State.Counter |
The Counter state type increments or decrements a specified numeric attribute on the patient
entity.
|
State.Death |
The Death state type indicates a point in the module at which the patient dies or the patient
is given a terminal diagnosis (e.g.
|
State.Delay |
The Delay state type introduces a pre-configured temporal delay in the module's timeline.
|
State.Delayable |
|
State.Device |
The Device state indicates the point that a permanent or semi-permanent device
(for example, a prosthetic, or pacemaker) is associated to a person.
|
State.DeviceEnd |
The DeviceEnd state indicates the point that a permanent or semi-permanent device
(for example, a prosthetic, or pacemaker) is removed from a person.
|
State.DiagnosticReport |
The DiagnosticReport state indicates that some number of Observations should be
grouped together within a single Diagnostic Report.
|
State.Encounter |
The Encounter state type indicates a point in the module where an encounter should take place.
|
State.EncounterEnd |
The EncounterEnd state type indicates the end of the encounter the patient is currently in, for
example when the patient leaves a clinician's office, or is discharged from a hospital.
|
State.Guard |
The Guard state type indicates a point in the module through which a patient can only pass if
they meet certain logical conditions.
|
State.ImagingStudy |
The ImagingStudy state indicates a point in the module when an imaging study was performed.
|
State.Initial |
The Initial state type is the first state that is processed in a generic module.
|
State.LegacyStateWithUnitlessRV |
|
State.MedicationEnd |
The MedicationEnd state type indicates a point in the module where a currently prescribed
medication should be ended.
|
State.MedicationOrder |
The MedicationOrder state type indicates a point in the module where a medication is
prescribed.
|
State.MultiObservation |
The MultiObservation state indicates that some number of Observations should be
grouped together as a single observation.
|
State.Observation |
The Observation state type indicates a point in the module where an observation is recorded.
|
State.Physiology |
The Physiology state executes a physiology simulation according to the provided
configuration options.
|
State.Procedure |
The Procedure state type indicates a point in the module where a procedure should be performed.
|
State.SetAttribute |
The SetAttribute state type sets a specified attribute on the patient entity.
|
State.Simple |
The Simple state type indicates a state that performs no additional actions, adds no additional
information to the patient entity, and just transitions to the next state.
|
State.SupplyList |
The SupplyList state includes a list of supplies that are needed for the current encounter.
|
State.Symptom |
The Symptom state type adds or updates a patient's symptom.
|
State.TelemedicinePossibility |
|
State.Terminal |
The Terminal state type indicates the end of the module progression.
|
State.Vaccine |
The Vaccine state type indicates a point in the module where the patient is vaccinated.
|
State.VitalSign |
The VitalSign state type indicates a point in the module where a patient's vital sign is set.
|
StaticFieldConfig |
Class to manage mapping values in the static BFD TSV writer to the exported writers.
|
SymptomCSVExporter |
Researchers have requested a simple table-based format that could easily be
imported into any database for analysis.
|
SymptomTextExporter |
Exporter for a simple human-readable text format per person.
|
SyncedEnumeratedDistro<T> |
Class that wraps EnumeratedDistribution for thread safe use in Synthea.
|
Telemedicine |
A place for helpers related to telemedicine.
|
TelemedicineConfig |
Configuration that drives TypeOfCare transitions in Synthea.
|
TelemedicineConfig.TelemedicineProbabilities |
A class to hold the transition probabilities of a given scenario.
|
TerminologyClient |
HAPI annotation client for invoking operations on a FHIR terminology service.
|
TextExporter |
Exporter for a simple human-readable text format per person.
|
TimeSeriesData |
|
Transition |
Transition represents all the transition types within the generic module
framework.
|
Transition.ComplexTransition |
Complex transitions are a combination of direct, distributed, and conditional
transitions.
|
Transition.ComplexTransitionOption |
A DistributedTransitionOption represents a transition option with any of: - a
single state to transition to, - a condition that must be true, or - a set of
distributions and transitions.
|
Transition.ConditionalTransition |
Conditional transitions will transition to one of several possible states
based on conditional logic.
|
Transition.ConditionalTransitionOption |
A ConditionalTransitionOption represents a single destination state, with a
given logical condition that must be true in order for the state to be
transitioned to.
|
Transition.DirectTransition |
Direct transitions are the simplest of transitions.
|
Transition.DistributedTransition |
Distributed transitions will transition to one of several possible states
based on the configured distribution.
|
Transition.DistributedTransitionOption |
A DistributedTransitionOption represents a single destination state, with a
given distribution percentage, or a named distribution representing an
attribute containing the distribution percentage.
|
Transition.LookupTableTransition |
LookupTable transitions will transition to one of any number of possible states
based on probabilities for each state extacted from a table.
|
Transition.LookupTableTransitionOption |
A LookupTableTransitionOption represents a destination state which will be
compared with a table lookup to find its probability and attributes.
|
Transition.NamedDistribution |
Helper class for distributions, which may either be a double, or a
NamedDistribution with an attribute to fetch the desired probability from and
a default.
|
Transition.TypeOfCareTransition |
A transition that is based on the type of care that will follow.
|
Transition.TypeOfCareTransitionOptions |
|
TransitionMetrics |
Class to track state and transition metrics from the modules.
|
TransitionMetrics.Metric |
Helper class to track the metrics of a single State.
|
TrendingValueGenerator |
A ValueGenerator for generation of trending values.
|
Utilities |
|
ValueGenerator |
The base for all value generators.
|
ValueSetCodeResolver |
This class knows how to search through all the Code values within a Person object, generating
random codes using the ValueSet URI if one has been supplied.
|
ValueTransforms |
|
Variant |
A representation of demographic information for a person.
|
VitalSign |
|
WeightLossModule |
This module allows patients in Synthea to lose weight.
|