Args

Args

We supply a number of instructions to dictate both how we want the synthea java program to run and how we want the python formatting to behave.

Argument Overview

Arg	Choices	Description
-A	Int-Int	Restrict the Age Range of Inspection
-C	"City, State"	Specify the City, State for the synthea location (defaults to Maryland)
-G	[M, F]	Specify the gender of patients
-M	True if Specified	Allows local modules to be used instead of JAR modules
-N	Int	Number of Patients to Simulate
-O	String	Specify the type of output
-Study	String	Use a predefined study. This sets many Args Automatically
-T	See Below	Specify Encounter Type
-V	True if Specified	Include additional fields, not part of official outputs
-Y	True if Specified	Separate the output by year
-R	Int-Int	Restrict output to certain years (Required if using -Y)
-F	True if Specified	Only Run Formatting code
-D	True if Specified	Only Run Synthea Data Generation, not Formatting

Studies

To read more about how to set up and use studies, read here

Detailed Argument Description

Age

• Flag: -A, --Age
• Description: Restrict the Age Range of Inspection
• Default: False
• Usage Example: python script.py --Age 30-40

City

• Flag: -C, --City
• Description: Specify the City, State for the synthea location
• Default: None
• Usage Example: python script.py --City "Boston, MA"

Gender

• Flag: -G, --Gender
• Description: Specify the gender of patients
• Choices: ['M', 'F']
• Default: False
• Usage Example: python script.py --Gender M

ModuleOverrides

• Flag: -M, --ModuleOverrides
• Description: Allows local modules to be used instead of JAR modules
• Default: False
• Usage Example: python script.py --ModuleOverrides

PersonCount

• Flag: -N, --PersonCount
• Description: Number of patients
• Type: int
• Metavar: [1-15000]
• Default: 100
• Usage Example: python script.py --PersonCount 500

FormatType

• Flag: -O, --FormatType
• Description: Specify the type of output
• Choices: ['HCAI_Inpatient_CSV', 'HCAI_Inpatient_FW', 'HCAI_PDD_CSV', 'HCAI_PDD_SAS', "all"]
• Default: "all"
• Usage Example: python script.py --FormatType HCAI_Inpatient_CSV

Study

• Flag: -Study
• Description: Specify a predefined study name
• Choices: predefined_studies dictionary in run_synthea
• Default: None
• Usage Example: python script.py --Study study1

EncounterType

• Flag: -T, --EncounterType
• Description: Specify Encounter Type
• Choices: ['inpatient', 'outpatient', 'ambulatory', 'wellness', 'virtual', 'urgentcare', 'emergency']
• Default: 'inpatient'
• Usage Example: python script.py --EncounterType outpatient

Verbose

• Flag: -V, --Verbose
• Description: Include additional fields, not part of official outputs
• Default: False
• Usage Example: python script.py --Verbose

Yearly

• Flag: -Y, --Yearly
• Description: Separate the output by year
• Default: False
• Usage Example: python script.py --Yearly

YearRange

• Flag: -R, --YearRange
• Description: Restrict output to certain years
• Default: False
• Usage Example: python script.py --YearRange 2010-2020

FormatOnly

• Flag: -F, --FormatOnly
• Description: Only Run Formatting code
• Default: False
• Usage Example: python script.py --FormatOnly

SyntheaGenOnly

• Flag: -D, --SyntheaGenOnly
• Description: Only Run Synthea Data Generation, not Formatting
• Default: False
• Usage Example: python script.py --SyntheaGenOnly