Schema 7 documentation
Generated from: scenario_7.xsd.
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
<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_7.xsd"
>
IN THIS ORDER:
| <demography ... />
| <monitoring ... />
| <interventions ... />
| [ <caseManagements ... /> ]
| [ <healthSystem ... /> ]
| <entoData ... />
| <parameters ... />
</scenario>
Documentation (element)
Units: List of elements
Description of scenario
Attributes
schemaVersion
schemaVersion=int
Version of xml schema. If not equal to the current version an error is thrown. Use SchemaTranslator to update xml files.
analysisNo
analysisNo=int
Units: Number Min: 1 Max: 100000000
Unique identifier of scenario
maximumAgeYrs
maximumAgeYrs=double
Units: Number Min: 0 Max: 100
Maximum age of simulated humans
name
name=string
Units: string
Name of intervention
popSize
popSize=int
Units: Count Min: 1 Max: 100000
Population size
simulationDuration
simulationDuration=int
Units: Time steps Min: 1 Max: 36500
Duration of main simulation
modelVersion
modelVersion=int
Units: Code Min: 0 Max: 100000000
Model Version
wuID
wuID=int
Units: Number Min: 1 Max: 100000000
Work unit ID. Only used to validate checkpointing, to prevent checkpoint cheats.
assimMode
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
mode=("1" or "2" or "3" or "4")
Units: Code
Simulation mode
demography
→ scenario → demography
<demography
name=string
[ growthRate=double ]
>
IN THIS ORDER:
| <ageGroup ... />
</demography>
Documentation (element)
Units: List of elements
Description of demography
Documentation (type)
Units: List of elements
Description of demography
Attributes
name
name=string
Units: string
Name of demography data
growthRate
growthRate=double
Units: Number Min: 0 Max: 0
Growth rate of human population.
ageGroup
→ scenario → demography → ageGroup
<ageGroup
lowerbound=double
>
IN THIS ORDER:
| ( <group ... /> )+
</ageGroup>
Documentation (element)
Units: List of elements
List of age groups included in demography
Documentation (type)
Units: List of elements
List of age groups included in demography or surveys
Attributes
lowerbound
lowerbound=double
Units: Years Min: 0 Max: 100
Lower bound of age group
group
→ scenario → demography → ageGroup → group
<group
poppercent=double
upperbound=double
/>
Attributes
poppercent
poppercent=double
upperbound
upperbound=double
monitoring
→ scenario → monitoring
<monitoring
name=string
>
IN THIS ORDER:
| <surveys ... />
| <ageGroup ... />
</monitoring>
Documentation (element)
Units: List of elements
Description of surveys
Documentation (type)
Units: List of elements
Description of surveys
Attributes
name
name=string
Units: string
Name of monitoring data
surveys
→ scenario → monitoring → surveys
<surveys
detectionLimit=double
summaryOption=int
>
IN THIS ORDER:
| <surveyTime ... />
</surveys>
Documentation (element)
Units: List of elements
List of survey times
Attributes
detectionLimit
detectionLimit=double
Units: parasites/micolitre Min: 0 Max: 1000
Detection limit for parasitemia
summaryOption
summaryOption=int
Units: Code
Requested output variables
surveyTime
→ scenario → monitoring → surveys → surveyTime
<surveyTime>
int
</surveyTime>
Documentation (element)
Units: Number Min: 0
Survey time
ageGroup
→ scenario → monitoring → ageGroup
<ageGroup
lowerbound=double
>
IN THIS ORDER:
| ( <group ... /> )+
</ageGroup>
Documentation (element)
Units: List of elements
List of age groups included in demography or surveys
Documentation (type)
Units: List of elements
List of age groups included in surveys
Attributes
lowerbound
lowerbound=double
Units: Years Min: 0 Max: 100
Lower bound of age group
group
→ scenario → monitoring → ageGroup → group
<group
upperbound=double
/>
Attributes
upperbound
upperbound=double
interventions
<interventions
name=string
>
IN THIS ORDER:
| ( <vaccineDescription ... /> ){0,3}
| [ <iptiDescription ... /> ]
| [ <ITNDescription ... /> ]
| [ <IRSDescription ... /> ]
| [ <continuous ... /> ]
| [ <timed ... /> ]
</interventions>
Documentation (element)
Units: List of elements
List of interventions
Documentation (type)
Units: List of elements
List of interventions
Attributes
name
name=string
Units: string
Name of age specific intervention
vaccineDescription
→ scenario → interventions → vaccineDescription
<vaccineDescription
vaccineType=int
>
IN THIS ORDER:
| <halfLifeYrs ... />
| <efficacyB ... />
| ( <initialEfficacy ... /> )+
</vaccineDescription>
Attributes
vaccineType
vaccineType=int
Units: Code
Type of vaccine
halfLifeYrs
→ scenario → interventions → vaccineDescription → halfLifeYrs
<halfLifeYrs
value=double
/>
Documentation (element)
Units: Years Min: 0 Max: 100
Half life of drug effect
Attributes
value
value=double
TODO
efficacyB
→ scenario → interventions → vaccineDescription → efficacyB
<efficacyB
value=double
/>
Documentation (element)
Units: Positive real Min: 0.001 Max: 1.00E+06
Measure of variation in vaccine efficacy
Attributes
value
value=double
TODO
initialEfficacy
→ scenario → interventions → vaccineDescription → initialEfficacy
<initialEfficacy
value=double
/>
Attributes
value
value=double
TODO
iptiDescription
→ scenario → interventions → iptiDescription
<iptiDescription
iptiEffect=int
>
IN THIS ORDER:
| ( <infGenotype ... /> )+
</iptiDescription>
Attributes
iptiEffect
iptiEffect=int
infGenotype
→ scenario → interventions → iptiDescription → infGenotype
<infGenotype
name=string
freq=double
ACR=double
proph=int
tolPeriod=int
atten=int
/>
Attributes
name
name=string
Units: string
Name of age specific intervention
freq
freq=double
ACR
ACR=double
proph
proph=int
tolPeriod
tolPeriod=int
atten
atten=int
ITNDescription
→ scenario → interventions → ITNDescription
<ITNDescription
name=string
>
IN THIS ORDER:
| ( <anopheles ... /> )+
</ITNDescription>
Attributes
name
name=string
Units: string
Name of Insecticide Treated Net intervention
anopheles
→ scenario → interventions → ITNDescription → anopheles
<anopheles
mosquito=string
>
IN THIS ORDER:
| <deterrency ... />
| <preprandialKillingEffect ... />
| <postprandialKillingEffect ... />
</anopheles>
Attributes
mosquito
mosquito=string
deterrency
→ scenario → interventions → ITNDescription → anopheles → deterrency
<deterrency
initial=double
halflife=double
[ Weibullk=double ]
/>
Documentation (element)
Units: None Min: 0 Max: 1
One minus this multiplies the host's availability (before decay).
Documentation (type)
Specification of a proportion with Weibull or exponential decay.
Attributes
initial
initial=double
Units: None Min: 0 Max: 1
The value before any decay.
halflife
halflife=double
Units: Years Min: 0
Half-life in years (more generally, halflife/ln(2) is lambda from the Weibull distribution).
Weibullk
Weibullk=double
Min: 0
The parameter k of the Weibull distribution. If missing, 1.0 is used (equivalent to exponential decay).
preprandialKillingEffect
→ scenario → interventions → ITNDescription → anopheles → preprandialKillingEffect
<preprandialKillingEffect
initial=double
halflife=double
[ Weibullk=double ]
/>
Documentation (element)
Units: None Min: 0 Max: 1
One minus this multiplies the survival rate of mosquitoes attempting to bite a host.
Documentation (type)
Specification of a proportion with Weibull or exponential decay.
Attributes
initial
initial=double
Units: None Min: 0 Max: 1
The value before any decay.
halflife
halflife=double
Units: Years Min: 0
Half-life in years (more generally, halflife/ln(2) is lambda from the Weibull distribution).
Weibullk
Weibullk=double
Min: 0
The parameter k of the Weibull distribution. If missing, 1.0 is used (equivalent to exponential decay).
postprandialKillingEffect
→ scenario → interventions → ITNDescription → anopheles → postprandialKillingEffect
<postprandialKillingEffect
initial=double
halflife=double
[ Weibullk=double ]
/>
Documentation (element)
Units: None Min: 0 Max: 1
One minus this multiplies the survival rate of mosquitoes attempting to escape after biting a host.
Documentation (type)
Specification of a proportion with Weibull or exponential decay.
Attributes
initial
initial=double
Units: None Min: 0 Max: 1
The value before any decay.
halflife
halflife=double
Units: Years Min: 0
Half-life in years (more generally, halflife/ln(2) is lambda from the Weibull distribution).
Weibullk
Weibullk=double
Min: 0
The parameter k of the Weibull distribution. If missing, 1.0 is used (equivalent to exponential decay).
IRSDescription
→ scenario → interventions → IRSDescription
<IRSDescription
name=string
>
IN THIS ORDER:
| ( <anopheles ... /> )+
</IRSDescription>
Attributes
name
name=string
Units: string
Name of Indoor Residual Spraying intervention
anopheles
→ scenario → interventions → IRSDescription → anopheles
<anopheles
mosquito=string
>
IN THIS ORDER:
| <deterrency ... />
| <killingEffect ... />
</anopheles>
Attributes
mosquito
mosquito=string
deterrency
→ scenario → interventions → IRSDescription → anopheles → deterrency
<deterrency
initial=double
halflife=double
[ Weibullk=double ]
/>
Documentation (element)
Units: None Min: 0 Max: 1
One minus this multiplies the host's availability.
Documentation (type)
Specification of a proportion with Weibull or exponential decay.
Attributes
initial
initial=double
Units: None Min: 0 Max: 1
The value before any decay.
halflife
halflife=double
Units: Years Min: 0
Half-life in years (more generally, halflife/ln(2) is lambda from the Weibull distribution).
Weibullk
Weibullk=double
Min: 0
The parameter k of the Weibull distribution. If missing, 1.0 is used (equivalent to exponential decay).
killingEffect
→ scenario → interventions → IRSDescription → anopheles → killingEffect
<killingEffect
initial=double
halflife=double
[ Weibullk=double ]
/>
Documentation (element)
Units: None Min: 0 Max: 1
One minus this multiplies the survival rate of resting mosquitoes.
Documentation (type)
Specification of a proportion with Weibull or exponential decay.
Attributes
initial
initial=double
Units: None Min: 0 Max: 1
The value before any decay.
halflife
halflife=double
Units: Years Min: 0
Half-life in years (more generally, halflife/ln(2) is lambda from the Weibull distribution).
Weibullk
Weibullk=double
Min: 0
The parameter k of the Weibull distribution. If missing, 1.0 is used (equivalent to exponential decay).
continuous
→ scenario → interventions → continuous
<continuous>
IN THIS ORDER:
| ( <vaccine ... /> )*
| ( <ITN ... /> )*
| ( <ipti ... /> )*
</continuous>
vaccine
→ scenario → interventions → continuous → vaccine
<vaccine
targetAgeYrs=double
coverage=double
/>
Documentation (element)
Units: List of elements
List of age groups for vaccination
Attributes
targetAgeYrs
targetAgeYrs=double
Units: Years Min: 0 Max: 100
Target age of intervention
coverage
coverage=double
Units: Proportion Min: 0 Max: 1
Coverage of intervention
ITN
→ scenario → interventions → continuous → ITN
<ITN
targetAgeYrs=double
coverage=double
/>
Documentation (element)
Units: List of elements
Description of ITN deployment in the community
Attributes
targetAgeYrs
targetAgeYrs=double
Units: Years Min: 0 Max: 100
Target age of intervention
coverage
coverage=double
Units: Proportion Min: 0 Max: 1
Coverage of intervention
ipti
→ scenario → interventions → continuous → ipti
<ipti
targetAgeYrs=double
coverage=double
/>
Documentation (element)
Units: List of elements
List of age groups for IPTi distribution
Attributes
targetAgeYrs
targetAgeYrs=double
Units: Years Min: 0 Max: 100
Target age of intervention
coverage
coverage=double
Units: Proportion Min: 0 Max: 1
Coverage of intervention
timed
→ scenario → interventions → timed
<timed>
IN THIS ORDER:
| ( <intervention ... /> )+
</timed>
Documentation (element)
Units: List of elements
List of timed interventions
Documentation (type)
Units: List of elements
List of timed interventions
intervention
→ scenario → interventions → timed → intervention
<intervention
time=int
>
IN THIS ORDER:
| [ <changeHS ... /> ]
| [ <changeEIR ... /> ]
| [ <MDA ... /> ]
| [ <vaccinate ... /> ]
| [ <ITN ... /> ]
| [ <IRS ... /> ]
| [ <ipti ... /> ]
</intervention>
Attributes
time
time=int
Units: Number Min: 1 Max: 10000
Time step of intervention
changeHS
→ 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
Documentation (type)
Units: List of elements
Description of health system
Attributes
name
name=string
Units: string
Name of health system
healthSystemMemory
healthSystemMemory=int
Units: Time steps Min: 1 Max: 100
Follow-up period during which a recurrence is considered to be a treatment failure
drugRegimen
→ scenario → healthSystem → drugRegimen
<drugRegimen
firstLine=string
secondLine=string
inpatient=string
/>
Documentation (element)
Units: List of elements
Description of drug regimen
Attributes
firstLine
firstLine=string
Units: Drug code
Code for first line drug
secondLine
secondLine=string
Units: Drug code
Code for second line drug
inpatient
inpatient=string
Units: Drug code
Code for drug used for treating inpatients
initialACR
→ scenario → healthSystem → initialACR
<initialACR>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</initialACR>
Documentation (element)
Units: Proportion Min: 0 Max: 1
Initial cure rate
CQ
→ scenario → healthSystem → initialACR → CQ
<CQ
value=double
/>
Documentation (element)
Units: List of elements
Chloroquine
Attributes
value
value=double
TODO
SP
→ scenario → healthSystem → initialACR → SP
<SP
value=double
/>
Documentation (element)
Units: List of elements
Sulphadoxine-pyrimethamine
Attributes
value
value=double
TODO
AQ
→ scenario → healthSystem → initialACR → AQ
<AQ
value=double
/>
Documentation (element)
Units: List of elements
Amodiaquine
Attributes
value
value=double
TODO
SPAQ
→ scenario → healthSystem → initialACR → SPAQ
<SPAQ
value=double
/>
Documentation (element)
Units: List of elements
Sulphadoxine-pyrimethamine/Amodiaquine
Attributes
value
value=double
TODO
ACT
→ scenario → healthSystem → initialACR → ACT
<ACT
value=double
/>
Documentation (element)
Units: List of elements
Artemisinine combination therapy
Attributes
value
value=double
TODO
QN
→ scenario → healthSystem → initialACR → QN
<QN
value=double
/>
Documentation (element)
Units: List of elements
Quinine
Attributes
value
value=double
TODO
selfTreatment
→ scenario → healthSystem → initialACR → selfTreatment
<selfTreatment
value=double
/>
Documentation (element)
Units: Proportion Min: 0 Max: 1
Probability of self-treatment
Attributes
value
value=double
TODO
compliance
→ scenario → healthSystem → compliance
<compliance>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</compliance>
Documentation (element)
Units: Proportion Min: 0 Max: 1
Adherence to treatment
nonCompliersEffective
→ scenario → healthSystem → nonCompliersEffective
<nonCompliersEffective>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</nonCompliersEffective>
Documentation (element)
Units: Proportion Min: 0 Max: 1
Effectiveness of treatment of non compliers
pSeekOfficialCareUncomplicated1
→ scenario → healthSystem → pSeekOfficialCareUncomplicated1
<pSeekOfficialCareUncomplicated1
value=double
/>
Documentation (element)
Units: Proportion Min: 0 Max: 1
Probability that a patient with newly incident uncomplicated disease seeks official care
Attributes
value
value=double
TODO
pSelfTreatUncomplicated
→ scenario → healthSystem → pSelfTreatUncomplicated
<pSelfTreatUncomplicated
value=double
/>
Documentation (element)
Units: Proportion Min: 0 Max: 1
Probability that a patient with uncomplicated disease self-treats
Attributes
value
value=double
TODO
pSeekOfficialCareUncomplicated2
→ scenario → healthSystem → pSeekOfficialCareUncomplicated2
<pSeekOfficialCareUncomplicated2
value=double
/>
Documentation (element)
Units: Proportion Min: 0 Max: 1
Probability that a patient with recurrence of uncomplicated disease seeks official care
Attributes
value
value=double
TODO
pSeekOfficialCareSevere
→ scenario → healthSystem → pSeekOfficialCareSevere
<pSeekOfficialCareSevere
value=double
/>
Documentation (element)
Units: Proportion Min: 0 Max: 1
Probability that a patient with severe disease seeks official care
Attributes
value
value=double
TODO
pSequelaeInpatient
→ scenario → healthSystem → pSequelaeInpatient
<pSequelaeInpatient>
IN THIS ORDER:
| ( <item ... /> )+
</pSequelaeInpatient>
Documentation (element)
Units: List of elements
List of age specific probabilities of sequelae in inpatients
item
→ scenario → healthSystem → pSequelaeInpatient → item
<item
value=double
maxAgeYrs=double
/>
Attributes
value
value=double
TODO
maxAgeYrs
maxAgeYrs=double
Units: Years Min: 0 Max: 100
Upper bound of age group
CFR
→ scenario → healthSystem → CFR
<CFR>
IN THIS ORDER:
| ( <group ... /> )+
</CFR>
group
→ scenario → healthSystem → CFR → group
<group
cfr=double
lowerbound=double
/>
Attributes
cfr
cfr=double
Units: Proportion Min: 0 Max: 1
Case fatality rate
lowerbound
lowerbound=double
Units: Years Min: 0 Max: 100
Lower bound of age group
changeEIR
→ scenario → interventions → timed → intervention → changeEIR
<changeEIR
eipDuration=int
>
IN THIS ORDER:
| ( <EIRDaily ... /> )+
</changeEIR>
Documentation (type)
Parameters for the non-vector transmission model.
Attributes
eipDuration
eipDuration=int
The duration of sporogony in days
EIRDaily
→ scenario → entoData → nonVector → EIRDaily
<EIRDaily
[ origin=string ]
>
double
</EIRDaily>
Documentation (type)
Units: Number Min: 1
Value of daily EIR
Attributes
origin
origin=string
MDA
→ scenario → interventions → timed → intervention → MDA
<MDA
[ maxAge=double ]
[ minAge=double ]
coverage=double
/>
Documentation (element)
Units: List of elements
Description of mass drug deployment in the community
Attributes
maxAge
maxAge=double
Units: Years Min: 0 Max: 100
Maximum age of eligible individuals (defaults to 100)
minAge
minAge=double
Units: Years Min: 0 Max: 100
Minimum age of eligible individuals (defaults to 0)
coverage
coverage=double
Units: Proportion Min: 0 Max: 1
Coverage of intervention
vaccinate
→ scenario → interventions → timed → intervention → vaccinate
<vaccinate
[ maxAge=double ]
[ minAge=double ]
coverage=double
/>
Documentation (element)
Units: List of elements
Description of vaccine deployment in the community
Attributes
maxAge
maxAge=double
Units: Years Min: 0 Max: 100
Maximum age of eligible individuals (defaults to 100)
minAge
minAge=double
Units: Years Min: 0 Max: 100
Minimum age of eligible individuals (defaults to 0)
coverage
coverage=double
Units: Proportion Min: 0 Max: 1
Coverage of intervention
ITN
→ scenario → interventions → timed → intervention → ITN
<ITN
[ maxAge=double ]
[ minAge=double ]
coverage=double
/>
Documentation (element)
Units: List of elements
Description of ITN deployment in the community
Attributes
maxAge
maxAge=double
Units: Years Min: 0 Max: 100
Maximum age of eligible individuals (defaults to 100)
minAge
minAge=double
Units: Years Min: 0 Max: 100
Minimum age of eligible individuals (defaults to 0)
coverage
coverage=double
Units: Proportion Min: 0 Max: 1
Coverage of intervention
IRS
→ scenario → interventions → timed → intervention → IRS
<IRS
[ maxAge=double ]
[ minAge=double ]
coverage=double
/>
Documentation (element)
Units: List of elements
Description of IRS deployment in the community
Attributes
maxAge
maxAge=double
Units: Years Min: 0 Max: 100
Maximum age of eligible individuals (defaults to 100)
minAge
minAge=double
Units: Years Min: 0 Max: 100
Minimum age of eligible individuals (defaults to 0)
coverage
coverage=double
Units: Proportion Min: 0 Max: 1
Coverage of intervention
ipti
→ scenario → interventions → timed → intervention → ipti
<ipti
[ maxAge=double ]
[ minAge=double ]
coverage=double
/>
Documentation (element)
Units: List of elements
List of age groups for IPTi distribution
Attributes
maxAge
maxAge=double
Units: Years Min: 0 Max: 100
Maximum age of eligible individuals (defaults to 100)
minAge
minAge=double
Units: Years Min: 0 Max: 100
Minimum age of eligible individuals (defaults to 0)
coverage
coverage=double
Units: Proportion Min: 0 Max: 1
Coverage of intervention
caseManagements
<caseManagements
name=string
reportingPeriodMemory=int
>
IN THIS ORDER:
| ( <caseManagement ... /> )+
</caseManagements>
Documentation (element)
Units: List of elements
List of case managment interventions
Documentation (type)
Units: List of elements
List of age-specific case managment descriptions
Attributes
name
name=string
Units: string
Name of age specific intervention
reportingPeriodMemory
reportingPeriodMemory=int
Units: Time steps Min: 1 Max: 100
Follow-up period during which a recurrence is considered to be a treatment failure
caseManagement
→ scenario → caseManagements → caseManagement
<caseManagement
maxAgeYrs=decimal
>
IN THIS ORDER:
| <uc1 ... />
| <uc2 ... />
| <sev ... />
| <nmfP ... />
| <nmfNP ... />
| <decisions ... />
</caseManagement>
Documentation (element)
Units: List of elements
Age-specific case management description, describes entry-points and decisions, with entry-point-specific decision probabilities
Attributes
maxAgeYrs
maxAgeYrs=decimal
Units: Years Min: 0 Max: 100
Upper bound of age group
uc1
→ scenario → caseManagements → caseManagement → uc1
<uc1>
IN THIS ORDER:
| ( <endPoint ... /> )+
</uc1>
endPoint
→ scenario → caseManagements → caseManagement → uc1 → endPoint
<endPoint
decision=int
p=double
/>
Attributes
decision
decision=int
Foreign key reference to outcome node
p
p=double
Units: Proportion Min: 0 Max: 1
Probability of outcome
uc2
→ scenario → caseManagements → caseManagement → uc2
<uc2>
IN THIS ORDER:
| ( <endPoint ... /> )+
</uc2>
sev
→ scenario → caseManagements → caseManagement → sev
<sev>
IN THIS ORDER:
| ( <endPoint ... /> )+
</sev>
nmfP
→ scenario → caseManagements → caseManagement → nmfP
<nmfP>
IN THIS ORDER:
| ( <endPoint ... /> )+
</nmfP>
nmfNP
→ scenario → caseManagements → caseManagement → nmfNP
<nmfNP>
IN THIS ORDER:
| ( <endPoint ... /> )+
</nmfNP>
decisions
→ scenario → caseManagements → caseManagement → decisions
<decisions>
IN THIS ORDER:
| ( <decision ... /> )+
</decisions>
decision
→ scenario → caseManagements → caseManagement → decisions → decision
<decision
id=int
>
IN THIS ORDER:
| ( <medicate ... /> )+
</decision>
Documentation (element)
Units: List of elements
describes treatment decisions, a list of medicate descisions.
Attributes
id
id=int
Units: Number
Key of decision
medicate
→ scenario → caseManagements → caseManagement → decisions → decision → medicate
<medicate
name=string
qty=int
time=int
/>
Attributes
name
name=string
Units: string
Name of drug compound
qty
qty=int
Units: Number
Quantity of drug compound
time
time=int
Units: Number Min: 1 Max: 10000
Time step of intervention
healthSystem
→ 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
Documentation (element)
Units: List of elements
Description of health system
Documentation (type)
Units: List of elements
Description of health system
Attributes
name
name=string
Units: string
Name of health system
healthSystemMemory
healthSystemMemory=int
Units: Time steps Min: 1 Max: 100
Follow-up period during which a recurrence is considered to be a treatment failure
entoData
<entoData
name=string
>
IN THIS ORDER:
| EXACTLY ONE OF:
| | <nonVector ... />
| | <vector ... />
</entoData>
Documentation (element)
Units: List of elements
Description of entomological data
Documentation (type)
Units: List of elements
Data for entomodel
Attributes
name
name=string
Units: string
Name of entomology data
nonVector
→ scenario → entoData → nonVector
<nonVector
eipDuration=int
>
IN THIS ORDER:
| ( <EIRDaily ... /> )+
</nonVector>
Documentation (type)
Parameters for the non-vector transmission model.
Attributes
eipDuration
eipDuration=int
The duration of sporogony in days
vector
→ scenario → entoData → vector
<vector>
IN THIS ORDER:
| ( <anopheles ... /> )+
| ( <nonHumanHosts ... /> )*
</vector>
Documentation (element)
Parameters for the vector transmission model.
anopheles
→ scenario → entoData → vector → anopheles
<anopheles
mosquito=string
>
IN THIS ORDER:
| <eir ... />
| <mosq ... />
| ( <nonHumanHosts ... /> )*
</anopheles>
Attributes
mosquito
mosquito=string
eir
→ scenario → entoData → vector → anopheles → eir
<eir
a0=double
a1=double
a2=double
b1=double
b2=double
EIRRotateAngle=double
/>
Documentation (element)
Units: Element
Description of entomological inoculation rate
Attributes
a0
a0=double
a1
a1=double
a2
a2=double
b1
b1=double
b2
b2=double
EIRRotateAngle
EIRRotateAngle=double
mosq
→ scenario → entoData → vector → anopheles → mosq
<mosq
mosqRestDuration=int
extrinsicIncubationPeriod=int
mosqSeekingDeathRate=double
mosqSeekingDuration=double
mosqEntoAvailability=double
mosqProbBiting=double
mosqProbFindRestSite=double
mosqProbResting=double
mosqProbOvipositing=double
emergenceRateFilename=string
/>
Documentation (element)
Units: List of elements
Vector species
Attributes
mosqRestDuration
mosqRestDuration=int
extrinsicIncubationPeriod
extrinsicIncubationPeriod=int
mosqSeekingDeathRate
mosqSeekingDeathRate=double
mosqSeekingDuration
mosqSeekingDuration=double
mosqEntoAvailability
mosqEntoAvailability=double
mosqProbBiting
mosqProbBiting=double
mosqProbFindRestSite
mosqProbFindRestSite=double
mosqProbResting
mosqProbResting=double
mosqProbOvipositing
mosqProbOvipositing=double
emergenceRateFilename
emergenceRateFilename=string
nonHumanHosts
→ scenario → entoData → vector → anopheles → nonHumanHosts
<nonHumanHosts
mosqEntoAvailability=double
mosqProbBiting=double
mosqProbFindRestSite=double
mosqProbResting=double
/>
Documentation (element)
Units: List of elements
Non human host parameters, per type of host (must match up with non-species-specific parameters).
Attributes
mosqEntoAvailability
mosqEntoAvailability=double
mosqProbBiting
mosqProbBiting=double
mosqProbFindRestSite
mosqProbFindRestSite=double
mosqProbResting
mosqProbResting=double
nonHumanHosts
→ scenario → entoData → vector → nonHumanHosts
<nonHumanHosts
[ name=string ]
populationSize=int
/>
Documentation (element)
Populations of non-human hosts (must also have species-specific parameters).
Attributes
name
name=string
populationSize
populationSize=int
parameters
→ scenario → parameters
<parameters
interval=int
iseed=int
delta=double
latentp=int
>
IN THIS ORDER:
| ( <parameter ... /> )+
</parameters>
Documentation (element)
Parameters for mathematical model
Documentation (type)
Units: List of elements
Parameter vector
Attributes
interval
interval=int
Units: Days
Simulation step
iseed
iseed=int
Units: Number
Seed for RNG
delta
delta=double
Units: ? Redundant
this no longer seems to be used
latentp
latentp=int
Units: Time steps Min: 0 Max: 20
pre-erythrocytic latent period, in time steps
parameter
→ scenario → parameters → parameter
<parameter
name=string
number=int
value=double
[ include=boolean ]
/>
Attributes
name
name=string
Units: string
Name of parameter
number
number=int
Units: Number Min: 1 Max: 100
Reference number of input parameter
value
value=double
Units: Number Min: 0
Parameter value
include
include=boolean
Units: Number Min: 0 Max: 1
True if parameter is to be sampled in optimization runs. Not used in simulator app.