-
Notifications
You must be signed in to change notification settings - Fork 0
GeneratedSchema3Doc
This page is automatically generated from the following schema file: scenario_3.xsd.
I recommend against editing it because edits will likely be lost later.
Key:
abc required (one)
[ def ] optional (zero or one)
( ghi )* any number (zero or more)
( jkl )+ at least one
( mno ){2,inf} two or more occurrences
→ scenario
<scenario
schemaVersion=int
analysisNo=int
maximumAgeYrs=double
name=string
popSize=int
simulationDuration=int
modelVersion=int
wuID=int
assimMode=("0" or "1")
mode=("1" or "2" or "3" or "4")
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="scenario_3.xsd"
>
IN THIS ORDER:
| <demography ... />
| <monitoring ... />
| <interventions ... />
| [ <caseManagements ... /> ]
| <healthSystem ... />
| <entoData ... />
| <parameters ... />
</scenario>Description of scenario
schemaVersion=intVersion of xml schema. If not equal to the current version an error is thrown. Use SchemaTranslator to update xml files.
analysisNo=intUnits: Number Min: 1 Max: 100000000
Unique identifier of scenario
maximumAgeYrs=doubleUnits: Number Min: 0 Max: 100
Maximum age of simulated humans
name=stringUnits: string
Name of intervention
popSize=intUnits: Count Min: 1 Max: 100000
Population size
simulationDuration=intUnits: Time steps Min: 1 Max: 36500
Duration of main simulation
modelVersion=intUnits: Code Min: 0 Max: 100000000
Model Version
wuID=intUnits: Number Min: 1 Max: 100000000
Work unit ID. Only used to validate checkpointing, to prevent checkpoint cheats.
assimMode=("0" or "1")Units: Code
Assimilator mode. Defines output of simulator as either complete (columns: time,agegroup,measure,value) or minimal (single column: value)
mode=("1" or "2" or "3" or "4")Units: Code
Simulation mode
→ scenario → demography
<demography
name=string
[ growthRate=double ]
>
IN THIS ORDER:
| <ageGroup ... />
</demography>Description of demography
Description of demography
name=stringUnits: string
Name of demography data
growthRate=doubleUnits: Number Min: 0 Max: 0
Growth rate of human population.
→ scenario → demography → ageGroup
<ageGroup
lowerbound=double
>
IN THIS ORDER:
| ( <group ... /> )+
</ageGroup>List of age groups included in demography
List of age groups included in demography or surveys
lowerbound=doubleUnits: Years Min: 0 Max: 100
Lower bound of age group
→ scenario → demography → ageGroup → group
<group
poppercent=double
upperbound=double
/>poppercent=doubleupperbound=double→ scenario → monitoring
<monitoring
name=string
>
IN THIS ORDER:
| <surveys ... />
| <ageGroup ... />
</monitoring>Description of surveys
Description of surveys
name=stringUnits: string
Name of monitoring data
→ scenario → monitoring → surveys
<surveys
detectionLimit=double
summaryOption=int
>
IN THIS ORDER:
| <surveyTime ... />
</surveys>List of survey times
detectionLimit=doubleUnits: parasites/micolitre Min: 0 Max: 1000
Detection limit for parasitemia
summaryOption=intUnits: Code
Requested output variables
→ scenario → monitoring → surveys → surveyTime
<surveyTime>
int
</surveyTime>Survey time
→ scenario → monitoring → ageGroup
<ageGroup
lowerbound=double
>
IN THIS ORDER:
| ( <group ... /> )+
</ageGroup>List of age groups included in demography or surveys
List of age groups included in surveys
lowerbound=doubleUnits: Years Min: 0 Max: 100
Lower bound of age group
→ scenario → monitoring → ageGroup → group
<group
upperbound=double
/>upperbound=double<interventions
name=string
>
IN THIS ORDER:
| ( <vaccineDescription ... /> ){0,3}
| [ <iptiDescription ... /> ]
| [ <continuous ... /> ]
| [ <timed ... /> ]
</interventions>List of interventions
List of interventions
name=stringUnits: string
Name of age specific intervention
→ scenario → interventions → vaccineDescription
<vaccineDescription
vaccineType=int
>
IN THIS ORDER:
| <halfLifeYrs ... />
| <efficacyB ... />
| ( <initialEfficacy ... /> )+
</vaccineDescription>vaccineType=intUnits: Code
Type of vaccine
→ scenario → interventions → vaccineDescription → halfLifeYrs
<halfLifeYrs
value=double
/>Half life of drug effect
value=doubleTODO
→ scenario → interventions → vaccineDescription → efficacyB
<efficacyB
value=double
/>Measure of variation in vaccine efficacy
value=doubleTODO
→ scenario → interventions → vaccineDescription → initialEfficacy
<initialEfficacy
value=double
/>value=doubleTODO
→ scenario → interventions → iptiDescription
<iptiDescription
iptiEffect=int
>
IN THIS ORDER:
| ( <infGenotype ... /> )+
</iptiDescription>iptiEffect=int→ scenario → interventions → iptiDescription → infGenotype
<infGenotype
name=string
freq=double
ACR=double
proph=int
tolPeriod=int
atten=int
/>name=stringUnits: string
Name of age specific intervention
freq=doubleACR=doubleproph=inttolPeriod=intatten=int→ scenario → interventions → continuous
<continuous>
IN THIS ORDER:
| ( <vaccine ... /> )*
| ( <ITN ... /> )*
| ( <ipti ... /> )*
</continuous>→ scenario → interventions → continuous → vaccine
<vaccine
targetAgeYrs=double
coverage=double
/>List of age groups for vaccination
targetAgeYrs=doubleUnits: Years Min: 0 Max: 100
Target age of intervention
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
→ scenario → interventions → continuous → ITN
<ITN
targetAgeYrs=double
coverage=double
/>Description of ITN deployment in the community
targetAgeYrs=doubleUnits: Years Min: 0 Max: 100
Target age of intervention
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
→ scenario → interventions → continuous → ipti
<ipti
targetAgeYrs=double
coverage=double
/>List of age groups for IPTi distribution
targetAgeYrs=doubleUnits: Years Min: 0 Max: 100
Target age of intervention
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
→ scenario → interventions → timed
<timed>
IN THIS ORDER:
| ( <intervention ... /> )+
</timed>List of timed interventions
List of timed interventions
→ scenario → interventions → timed → intervention
<intervention
time=int
>
IN THIS ORDER:
| [ <changeHS ... /> ]
| [ <changeEIR ... /> ]
| [ <MDA ... /> ]
| [ <IRS ... /> ]
| [ <vaccinate ... /> ]
| [ <ITN ... /> ]
| [ <ipti ... /> ]
</intervention>time=intUnits: Number Min: 1 Max: 10000
Time step of intervention
→ scenario → interventions → timed → intervention → changeHS
<changeHS
name=string
healthSystemMemory=int
>
IN THIS ORDER:
| <drugRegimen ... />
| <initialACR ... />
| <compliance ... />
| <nonCompliersEffective ... />
| <pSeekOfficialCareUncomplicated1 ... />
| <pSelfTreatUncomplicated ... />
| <pSeekOfficialCareUncomplicated2 ... />
| <pSeekOfficialCareSevere ... />
| <pSequelaeInpatient ... />
| <CFR ... />
</changeHS>- drugRegimen
- initialACR
- compliance
- nonCompliersEffective
- pSeekOfficialCareUncomplicated1
- pSelfTreatUncomplicated
- pSeekOfficialCareUncomplicated2
- pSeekOfficialCareSevere
- pSequelaeInpatient
- CFR
Description of health system
name=stringUnits: string
Name of health system
healthSystemMemory=intUnits: Time steps Min: 1 Max: 100
Follow-up period during which a recurrence is considered to be a treatment failure
→ scenario → healthSystem → drugRegimen
<drugRegimen
firstLine=string
secondLine=string
inpatient=string
/>Description of drug regimen
firstLine=stringUnits: Drug code
Code for first line drug
secondLine=stringUnits: Drug code
Code for second line drug
inpatient=stringUnits: Drug code
Code for drug used for treating inpatients
→ scenario → healthSystem → initialACR
<initialACR>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</initialACR>Initial cure rate
→ scenario → healthSystem → initialACR → CQ
<CQ
value=double
/>Chloroquine
value=doubleTODO
→ scenario → healthSystem → initialACR → SP
<SP
value=double
/>Sulphadoxine-pyrimethamine
value=doubleTODO
→ scenario → healthSystem → initialACR → AQ
<AQ
value=double
/>Amodiaquine
value=doubleTODO
→ scenario → healthSystem → initialACR → SPAQ
<SPAQ
value=double
/>Sulphadoxine-pyrimethamine/Amodiaquine
value=doubleTODO
→ scenario → healthSystem → initialACR → ACT
<ACT
value=double
/>Artemisinine combination therapy
value=doubleTODO
→ scenario → healthSystem → initialACR → QN
<QN
value=double
/>Quinine
value=doubleTODO
→ scenario → healthSystem → initialACR → selfTreatment
<selfTreatment
value=double
/>Probability of self-treatment
value=doubleTODO
→ scenario → healthSystem → compliance
<compliance>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</compliance>Adherence to treatment
→ scenario → healthSystem → nonCompliersEffective
<nonCompliersEffective>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</nonCompliersEffective>Effectiveness of treatment of non compliers
→ scenario → healthSystem → pSeekOfficialCareUncomplicated1
<pSeekOfficialCareUncomplicated1
value=double
/>Probability that a patient with newly incident uncomplicated disease seeks official care
value=doubleTODO
→ scenario → healthSystem → pSelfTreatUncomplicated
<pSelfTreatUncomplicated
value=double
/>Probability that a patient with uncomplicated disease self-treats
value=doubleTODO
→ scenario → healthSystem → pSeekOfficialCareUncomplicated2
<pSeekOfficialCareUncomplicated2
value=double
/>Probability that a patient with recurrence of uncomplicated disease seeks official care
value=doubleTODO
→ scenario → healthSystem → pSeekOfficialCareSevere
<pSeekOfficialCareSevere
value=double
/>Probability that a patient with severe disease seeks official care
value=doubleTODO
→ scenario → healthSystem → pSequelaeInpatient
<pSequelaeInpatient>
IN THIS ORDER:
| ( <item ... /> )+
</pSequelaeInpatient>List of age specific probabilities of sequelae in inpatients
→ scenario → healthSystem → pSequelaeInpatient → item
<item
maxAgeYrs=double
/>maxAgeYrs=doubleUnits: Years Min: 0 Max: 100
Upper bound of age group
→ scenario → healthSystem → CFR
<CFR>
IN THIS ORDER:
| ( <group ... /> )+
</CFR>→ scenario → healthSystem → CFR → group
<group
cfr=double
lowerbound=double
/>cfr=doubleUnits: Proportion Min: 0 Max: 1
Case fatality rate
lowerbound=doubleUnits: Years Min: 0 Max: 100
Lower bound of age group
→ scenario → interventions → timed → intervention → changeEIR
<changeEIR
name=string
inputType=("EIR" or "Fourier")
>
IN THIS ORDER:
| EXACTLY ONE OF:
| | ( <EIRDaily ... /> )+
| | ( <anopheles ... /> )+
</changeEIR>Data for entomodel: TODO: choice element
name=stringUnits: string
Name of entomology data
inputType=("EIR" or "Fourier")→ scenario → entoData → EIRDaily
<EIRDaily
[ origin=string ]
>
double
</EIRDaily>Value of daily EIR
origin=string→ scenario → entoData → anopheles
<anopheles
mosquito=string
useNv0Guess=boolean
>
IN THIS ORDER:
| <eir ... />
| <mosq ... />
</anopheles>mosquito=stringuseNv0Guess=boolean→ scenario → entoData → anopheles → eir
<eir
a0=double
a1=double
a2=double
b1=double
b2=double
EIRRotateAngle=double
/>Description of entomological inoculation rate
a0=doublea1=doublea2=doubleb1=doubleb2=doubleEIRRotateAngle=double→ scenario → entoData → anopheles → mosq
<mosq
mosqRestDuration=int
mosqSeekingDeathRate=double
mosqSeekingDuration=double
mosqProbBiting=double
mosqProbFindRestSite=double
mosqProbResting=double
mosqProbOvipositing=double
/>Vector species
mosqRestDuration=intmosqSeekingDeathRate=doublemosqSeekingDuration=doublemosqProbBiting=doublemosqProbFindRestSite=doublemosqProbResting=doublemosqProbOvipositing=double→ scenario → interventions → timed → intervention → MDA
<MDA
maxAge=double
minAge=double
coverage=double
/>Description of mass drug deployment in the community
maxAge=doubleUnits: Years Min: 0 Max: 100
Maximum age of eligible individuals
minAge=doubleUnits: Years Min: 0 Max: 100
Minimum age of eligible individuals
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
→ scenario → interventions → timed → intervention → IRS
<IRS/>→ scenario → interventions → timed → intervention → vaccinate
<vaccinate
maxAge=double
minAge=double
coverage=double
/>Description of vaccine deployment in the community
maxAge=doubleUnits: Years Min: 0 Max: 100
Maximum age of eligible individuals
minAge=doubleUnits: Years Min: 0 Max: 100
Minimum age of eligible individuals
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
→ scenario → interventions → timed → intervention → ITN
<ITN
maxAge=double
minAge=double
coverage=double
/>Description of ITN deployment in the community
maxAge=doubleUnits: Years Min: 0 Max: 100
Maximum age of eligible individuals
minAge=doubleUnits: Years Min: 0 Max: 100
Minimum age of eligible individuals
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
→ scenario → interventions → timed → intervention → ipti
<ipti
maxAge=double
minAge=double
coverage=double
/>List of age groups for IPTi distribution
maxAge=doubleUnits: Years Min: 0 Max: 100
Maximum age of eligible individuals
minAge=doubleUnits: Years Min: 0 Max: 100
Minimum age of eligible individuals
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
<caseManagements
name=string
>
IN THIS ORDER:
| ( <caseManagement ... /> )+
</caseManagements>List of case managment interventions
List of age-specific case managment descriptions
name=stringUnits: string
Name of age specific intervention
→ scenario → caseManagements → caseManagement
<caseManagement
[ minAgeYrs=decimal ]
maxAgeYrs=decimal
>
IN THIS ORDER:
| <uc1 ... />
| <uc2 ... />
| <sev ... />
| <nmf ... />
| <decisions ... />
</caseManagement>Age-specific case management description, describes entry-points and decisions, with entry-point-specific decision probabilities
minAgeYrs=decimalmaxAgeYrs=decimalUnits: Years Min: 0 Max: 100
Upper bound of age group
→ scenario → caseManagements → caseManagement → uc1
<uc1>
IN THIS ORDER:
| ( <endPoint ... /> )+
</uc1>→ scenario → caseManagements → caseManagement → uc1 → endPoint
<endPoint
decision=int
p=double
/>decision=intForeign key reference to outcome node
p=doubleUnits: Proportion Min: 0 Max: 1
Probability of outcome
→ scenario → caseManagements → caseManagement → uc2
<uc2>
IN THIS ORDER:
| ( <endPoint ... /> )+
</uc2>→ scenario → caseManagements → caseManagement → sev
<sev>
IN THIS ORDER:
| ( <endPoint ... /> )+
</sev>→ scenario → caseManagements → caseManagement → nmf
<nmf>
IN THIS ORDER:
| ( <endPoint ... /> )+
</nmf>→ scenario → caseManagements → caseManagement → decisions
<decisions>
IN THIS ORDER:
| ( <decision ... /> )+
</decisions>→ scenario → caseManagements → caseManagement → decisions → decision
<decision
id=int
>
IN THIS ORDER:
| ( <medicate ... /> )+
</decision>describes treatment decisions, a list of medicate descisions.
id=intUnits: Number
Key of decision
→ scenario → caseManagements → caseManagement → decisions → decision → medicate
<medicate
name=string
qty=int
time=int
/>name=stringUnits: string
Name of drug compound
qty=intUnits: Number
Quantity of drug compound
time=intUnits: Number Min: 1 Max: 10000
Time step of intervention
→ scenario → healthSystem
<healthSystem
name=string
healthSystemMemory=int
>
IN THIS ORDER:
| <drugRegimen ... />
| <initialACR ... />
| <compliance ... />
| <nonCompliersEffective ... />
| <pSeekOfficialCareUncomplicated1 ... />
| <pSelfTreatUncomplicated ... />
| <pSeekOfficialCareUncomplicated2 ... />
| <pSeekOfficialCareSevere ... />
| <pSequelaeInpatient ... />
| <CFR ... />
</healthSystem>- drugRegimen
- initialACR
- compliance
- nonCompliersEffective
- pSeekOfficialCareUncomplicated1
- pSelfTreatUncomplicated
- pSeekOfficialCareUncomplicated2
- pSeekOfficialCareSevere
- pSequelaeInpatient
- CFR
Description of health system
Description of health system
name=stringUnits: string
Name of health system
healthSystemMemory=intUnits: Time steps Min: 1 Max: 100
Follow-up period during which a recurrence is considered to be a treatment failure
<entoData
name=string
inputType=("EIR" or "Fourier")
>
IN THIS ORDER:
| EXACTLY ONE OF:
| | ( <EIRDaily ... /> )+
| | ( <anopheles ... /> )+
</entoData>Description of entomological data
Data for entomodel: TODO: choice element
name=stringUnits: string
Name of entomology data
inputType=("EIR" or "Fourier")→ scenario → parameters
<parameters
interval=int
iseed=int
delta=double
eipDuration=int
latentp=int
>
IN THIS ORDER:
| ( <parameter ... /> )+
</parameters>Parameters for mathematical model
Parameter vector
interval=intUnits: Days
Simulation step
iseed=intUnits: Number
Seed for RNG
delta=doubleUnits: ? Redundant
this no longer seems to be used
eipDuration=intUnits: Count Min: 0 Max: 50
The duration of sporogony in days
latentp=intUnits: Time steps Min: 0 Max: 20
pre-erythrocytic latent period, in time steps
→ scenario → parameters → parameter
<parameter
name=string
number=int
value=double
include=boolean
/>name=stringUnits: string
Name of parameter
number=intUnits: Number Min: 1 Max: 100
Reference number of input parameter
value=doubleUnits: Number Min: 0
Parameter value
include=booleanUnits: Number Min: 0 Max: 1
True if parameter is to be sampled in optimization runs. Not used in simulator app.