Skip to content

ReportHIVInfection

The HIV disease progression report (ReportHIVInfection.csv) provides information on each individual's disease state at each time step, including age, gender, CD4 count, survival prognosis, ART status, and factors impacting transmission and acquisition.

Configuration

To generate the report, the following parameters must be configured in the config.json file:

Parameter Data type Min Max Default Description
Report_HIV_Infection boolean NA NA 0 Set this to 1 to generate the report.
Report_HIV_Infection_Start_Year float 1900 2200 1900 Simulation time in years to start collecting data.
Report_HIV_Infection_Stop_Year float 1900 2200 2200 Simulation time in years to start collecting data.
{
    "Report_HIV_Infection": 1,
    "Report_HIV_Infection_Start_Year": 1940,
    "Report_HIV_Infection_Stop_Year": 2000
}

Output file data

The output report will contain the following information.

Data columns

Data channel Data type Description
Year float Simulation time in years, including fractions of years.
Node_ID integer The identification number of the node.
Id integer The unique identification number of the individual.
MCWeight integer Not currently supported. This column will always show a Monte Carlo weight of 1.
Age float The age of the individual in years, including fractions of years.
Gender boolean Identifies the individual's gender: 0 is assigned to males, 1 is assigned to females.
getProbMaternalTransmission float The hypothetical probability of mother-to-child transmission (MTCT), if the individual were to give birth at the present time and not receive any interventions such as PMTCT or AntiretroviralTherapy. Not applicable for males or for females of non-childbearing age.
TimeSinceHIV float The number of days since the individual became infected. Note: If the individual was infected by an OutbreakIndividual intervention with the Incubation_Period_Override parameter set to 0, the infected date will be randomly set in the past (uniformly selected from the amount of time until death). TimeSinceHIV will count accordingly from the 'historic' infection date.
CD4count float The current CD4 count, regardless of when CD4 testing was performed.
PrognosisCompletedFraction float The proportion of the total untreated HIV survival time that has already been lived; only relevant when the individual is not on ART.
Prognosis float The remaining untreated survival time until AIDS-related death; only relevant when the individual is not on ART.
Stage integer The individual's disease stage. Possible values are:

0 = Uninfected
1 = Untreated acute HIV infection
2 = Untreated latent HIV infection
3 = Untreated late/AIDS stage
* 4 = On ART
ViralLoad float Not currently supported.
WHOStage float The individual's WHO stage, linearly interpolated between integer values. Round down to obtain the integer value for the WHO clinical stage. Uninfected individuals will be assigned a value of -1.
Infectiousness float Describes the individual's infectiousness, which depends on the disease stage and ART status, and includes effects of heterogeneous infectiousness.
ModAcquire float Multiplicative modifier on disease acquisition; will be set to 1 by default for HIV, but can be impacted by the IndividualImmunityChanger intervention or by setting Enable_Maternal_Protection to 1 in the config.json file.
ModTransmit float Multiplicative modifier on disease transmission; will be set to 1 by default for HIV, but can be impacted by the IndividualImmunityChanger intervention.
ModMortality float Multiplicative modifier on disease mortality; will be set to 1 by default for HIV, but can be impacted by the IndividualImmunityChanger intervention.
ArtStatus integer Describes the individual's ART status. Possible values are:

1 = The individual is not currently receiving ART.
5 = The individual is on ART, but their viral load is not yet suppressed.
6 = The individual is on ART, and their viral load is suppressed.
7 = The individual is on ART, but is experiencing virological failure.
8 = The individual has had poor adherence to ART.
9 = The individual has dropped out of ART.
InfectivitySuppression float The multiplier acting on Base_Infectivity to determine the per-act transmission probability of a virally suppressed HIV-positive individual. This can be reduced from ART_Viral_Suppression_Multiplier due to AntiretroviralTherapy's Days_To_Achieve_Viral_Suppression.
DurationOnArt integer The number of days since the individual most recently started ART. Set to -1 if they are not on ART.
ProbMaternalTransmissionModifier float The better maternal transmission multiplier provided by PMTCT, or zero.
OnArtQuery boolean Describes whether the individual is on ART or not: 0 if individual is not on ART, and 1 if they are.
CoInfectiveTransmissionFactor float If the person has an STI co-infection (set by the ModifyStiCoInfectionStatus intervention), then this will be the value from the parameter STI_Coinfection_Transmission_Multiplier. Otherwise, the value will be 1.
CoInfectiveAcquisitionFactor float If the person has an STI co-infection (set by the ModifyStiCoInfectionStatus intervention), then this will be the value from the parameter STI_Coinfection_Acquisition_Multiplier. Otherwise, the value will be 1.
DebutAge float The age of sexual debut in days.
IsCircumcised boolean Indicates whether or not the individual is circumcised (only applicable to males): 0 for not circumcised (and females), 1 for circumcised.
InterventionReducedAcquire float The multiplier, based on interventions like SimpleVaccine, used to reduce the probability that an individual will acquire an infection.
InterventionReducedTransmit float The multiplier, based on interventions like SimpleVaccine, used to reduce the probability that an individual will transmit an infection.
InterventionReducedMortality float The multiplier, based on interventions like SimpleVaccine, used to reduce the probability that an individual will die due to an infection.

Example

The following is an example of a ReportHIVInfection.csv file.

1960.502686 1 2 1.1 0.307482409 1.2 0.300000012 0 538.1308594 0.002955006 338.4078064 1.3 10000 1.012042642 0.026000001 1.4 1.5 1.6 1.7 1.8 -1 0.1 0.2 1.9 1.10 5090.935059 0.3 1.11 1.12 1.13
1960.5 1 3 1 21.5734 1 0.3 0 540.415 0.000165243 6050.58 1 10000 1.00041 0.026 1 1 1 1 1 -1 0 0 10 10 5013.49 0 1 1 1
1960.5 1 4 1 1.31608 0 0.3 0 540.4 0.00018299 5463.52 1 10000 1.00096 0.026 1 1 1 1 1 -1 0 0 1 1 5758.32 0 1 1 1
1960.5 1 5 1 4.21428 1 0.3 0 540.474 9.23e-05 10828.3 1 10000 1.00011 0.026 1 1 1 1 1 -1 0 0 1 1 5784.28 0 1 1 1
1960.5 1 6 1 35.3594 1 0.3 0 540.276 0.000334598 2988.66 1 10000 1.00407 0.026 1 1 1 1 1 -1 0 0 1 1 5227.5 0 1 1 1
1960.5 1 7 1 64.5912 0 0.3 0 539.511 0.0012687 788.182 1 10000 1.00353 0.026 1 1 1 1 1 -1 0 0 1 1 5978.61 0 1 1 1
1960.5 1 8 1 44.9768 0 0.3 0 540.063 0.000594637 1681.64 1 10000 1.00245 0.026 1 1 1 1 1 -1 0 0 1 1 6403.73 0 1 1 1
1960.5 1 9 1 8.95473 1 0.3 0 538.089 0.00300554 332.713 1 10000 1.00345 0.026 1 1 1 1 1 -1 0 0 1 1 5457.21 0 1 1 1
1960.5 1 10 1 61.5506 1 0.3 0 540.262 0.000351696 2843.23 1 10000 1.00338 0.026 1 1 1 1 1 -1 0 0 1 1 5853.44 0 1 1 1
1960.51 1 2 1 0.310222 1 0.3 1 535.717 0.00591001 338.408 1 10000 1.02409 0.026 1 1 1 1 1 -1 0 0 1 1 5090.94 0 1 1 1
1960.51 1 3 1 21.5761 1 0.3 1 540.279 0.000330486 6050.58 1 10000 1.00083 0.026 1 1 1 1 1 -1 0 0 10 10 5013.49 0 1 1 1
1960.51 1 4 1 1.31882 0 0.3 1 540.25 0.00036598 5463.52 1 10000 1.00192 0.026 1 1 1 1 1 -1 0 0 1 1 5758.32 0 1 1 1
1960.51 1 5 1 4.21702 1 0.3 1 540.399 0.000184613 10828.3 1 10000 1.00021 0.026 1 1 1 1 1 -1 0 0 1 1 5784.28 0 1 1 1
1960.51 1 6 1 35.3621 1 0.3 1 540.002 0.000669197 2988.66 1 10000 1.00815 0.026 1 1 1 1 1 -1 0 0 1 1 5227.5 0 1 1 1
1960.51 1 7 1 64.5939 0 0.3 1 538.472 0.00253741 788.182 1 10000 1.00706 0.026 1 1 1 1 1 -1 0 0 1 1 5978.61 0 1 1 1
1960.51 1 8 1 44.9795 0 0.3 1 539.576 0.00118927 1681.64 1 10000 1.0049 0.026 1 1 1 1 1 -1 0 0 1 1 6403.73 0 1 1 1
1960.51 1 9 1 8.95747 1 0.3 1 535.635 0.00601108 332.713 1 10000 1.0069 0.026 1 1 1 1 1 -1 0 0 1 1 5457.21 0 1 1 1
1960.51 1 10 1 61.5533 1 0.3 1 539.974 0.000703392 2843.23 1 10000 1.00676 0.026 1 1 1 1 1 -1 0 0 1 1 5853.44 0 1 1 1
1960.51 1 2 1 0.312962 1 0.3 2 533.309 0.00886502 338.408 1 10000 1.03613 0.026 1 1 1 1 1 -1 0 0 1 1 5090.94 0 1 1 1
1960.51 1 3 1 21.5789 1 0.3 2 540.144 0.000495729 6050.58 1 10000 1.00124 0.026 1 1 1 1 1 -1 0 0 10 10 5013.49 0 1 1 1
1960.51 1 4 1 1.32156 0 0.3 2 540.1 0.000548971 5463.52 1 10000 1.00288 0.026 1 1 1 1 1 -1 0 0 1 1 5758.32 0 1 1 1
1960.51 1 5 1 4.21976 1 0.3 2 540.323 0.00027692 10828.3 1 10000 1.00032 0.026 1 1 1 1 1 -1 0 0 1 1 5784.28 0 1 1 1
1960.51 1 6 1 35.3649 1 0.3 2 539.728 0.0010038 2988.66 1 10000 1.01222 0.026 1 1 1 1 1 -1 0 0 1 1 5227.5 0 1 1 1
1960.51 1 7 1 64.5966 0 0.3 2 537.435 0.00380611 788.182 1 10000 1.01059 0.026 1 1 1 1 1 -1 0 0 1 1 5978.61 0 1 1 1
1960.51 1 8 1 44.9823 0 0.3 2 539.089 0.00178391 1681.64 1 10000 1.00734 0.026 1 1 1 1 1 -1 0 0 1 1 6403.73 0 1 1 1
1960.51 1 9 1 8.96021 1 0.3 2 533.185 0.00901663 332.713 1 10000 1.01034 0.026 1 1 1 1 1 -1 0 0 1 1 5457.21 0 1 1 1
1960.51 1 10 1 61.5561 1 0.3 2 539.686 0.00105509 2843.23 1 10000 1.01013 0.026 1 1 1 1 1 -1 0 0 1 1 5853.44 0 1 1 1