HIVMortality¶
The HIV mortality report (HIVMortality.csv) provides information about individuals at the time of their death, including disease status, CD4 count, medical history, and relationship history.
Configuration¶
To generate the report, set the Report_HIV_Mortality parameter to 1 in the config.json file.
Output file data¶
The output report will contain the following information.
Data channel |
Data type |
Description |
|
|---|---|---|---|
Node_ID |
integer |
The identification number of the node. |
|
id |
integer |
The unique identification number of the individual. |
|
Death_time |
float |
Simulation time, in days, when the individual died. |
|
Death_was_HIV_cause |
boolean |
Indicates whether or not the death was due to HIV infection: 0 if death was due to background mortality, and 1 if death was due to HIV. |
|
Gender |
boolean |
Identifies the individual’s gender: 0 is assigned to males, 1 is assigned to females. |
|
Age |
float |
The age of the individual, in years, including fractions of years up to four decimal places. |
|
Num_rels_just_prior_to_death |
integer |
The number of relationships in which the individual was participating just prior to death. |
|
Num_rels_lifetime |
integer |
The total number of lifetime relationships for the individual. |
|
HIV_disease_state_just_prior_to_death |
integer |
Describes the disease state prior to the individual’s death. Possible values are:
|
|
Years_since_infection |
float |
The number of years since the individual was most recently infected. This can be reset if the infection is suppressed by the AntiretroviralTherapy or ARTMortalityTable interventions. |
|
CD4_count_first_recorded |
float |
The first CD4 count ever recorded with CD4 testing (via the HIVDrawBlood intervention). The value will be -1 if the person never received an HIVDrawBlood intervention. |
|
CD4_count_last_recorded |
float |
The most recent CD4 count recorded with CD4 testing (via the HIVDrawBlood intervention). The value will be -1 if the person never received an HIVDrawBlood intervention. |
|
CD4_count_current |
float |
The actual CD4 count at the time of death (regardless of when CD4 testing was performed). |
|
Days_since_CD4_blood_draw |
integer |
The time lag between the last CD4 test (via the HIVBloodDraw intervention) and the time of death. |
|
Total_number_of_times_initiating_ART |
integer |
The number of lifetime ART initiations. ART initiation and adherence are determined by the AntiretroviralTherapy and ARTMortalityTable interventions. |
|
Total_years_on_ART |
float |
The cumulative number of years on ART, including fractions of years. |
|
Years_since_first_ART_initiation |
float |
The number of years since first ART initiation, including fractions of years. |
|
Years_since_most_recent_ART_initiation |
float |
The number of years since the most recent ART initiation, including fractions of years. |
|
ART_status_just_prior_to_death |
enum |
Describes the individual’s ART eligibility status at the time of death. Possible values are:
|
|
Intervention_Status |
string |
The value of the InterventionStatus individual property (IP) for the person that died, at the time of death. If InterventionStatus has not been configured, then the value will be “None.” See Individual and node properties for information on configuring interventions. |
|
Ever_tested |
boolean |
Describes whether or not the individual has ever received a diagnostic via the HIVRapidHIVDiagnostic intervention: 0 if the individual has not, and 1 if they have. Note that other diagnostics (such as SimpleDiagnostic and HIVSimpleDiagnostic) do not count toward Ever_tested. |
|
Ever_tested_positive |
boolean |
Describes whether or not the individual has ever received a positive HIV test via the HIVRapidHIVDiagnostic intervention: 0 if the individual has not, and 1 if they have. Note that other diagnostics (such as SimpleDiagnostic and HIVSimpleDiagnostic) do not count toward Ever_tested_positive. |
|
Ever_received_CD4_result |
boolean |
Describes whether or not individuals have received a CD4 test via the HIVDrawBlood intervention: 0 if the individual has not, and 1 if they have. |
|
Ever_in_ART |
boolean |
Describes whether the individual has ever received ART via the AntiretroviralTherapy or ARTMortalityTable interventions: 0 if the individual has not, and 1 if they have. |
|
Currently_in_ART |
boolean |
Describes whether or not the individual was receiving ART via the AntiretroviralTherapy or ARTMortalityTable interventions at the time of their death: 0 if the individual was not, and 1 if they were. Individual adherence to ART may be modified by the ARTMortalityTable intervention. |
Example¶
The following is an example of a HIVMortality.csv report:
Node_ID |
id |
Death_time |
Death_was_HIV_cause |
Gender |
Age |
Num_rels_just_prior_to_death |
Num_rels_lifetime |
HIV_disease_state_just_prior_to_death |
Years_since_infection |
CD4_count_first_recorded |
CD4_count_last_recorded |
CD4_count_current |
Days_since_CD4_blood_draw |
Total_number_of_times_initiating_ART |
Total_years_on_ART |
Years_since_first_ART_initiation |
Years_since_most_recent_ART_initiation |
ART_status_just_prior_to_death |
Intervention_Status |
Ever_tested |
Ever_tested_positive |
Ever_received_CD4_result |
Ever_in_ART |
Currently_in_ART |
1 |
29 |
7770 |
1 |
0 |
21.3699 |
0 |
0 |
3 |
1.31507 |
0 |
0 |
3.44695 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
38 |
8160 |
1 |
1 |
22.4384 |
0 |
0 |
3 |
2.38356 |
0 |
0 |
4.69059 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
92 |
8670 |
1 |
1 |
23.8356 |
0 |
0 |
3 |
3.78082 |
0 |
0 |
2.68563 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
37 |
8700 |
1 |
1 |
23.9178 |
0 |
0 |
3 |
3.86301 |
0 |
0 |
5.04478 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
98 |
8760 |
1 |
1 |
24.0822 |
0 |
0 |
3 |
4.0274 |
0 |
0 |
1.90831 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
64 |
9180 |
1 |
0 |
25.2329 |
0 |
0 |
3 |
5.17808 |
0 |
0 |
45.8134 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
25 |
9420 |
1 |
0 |
25.8904 |
0 |
0 |
3 |
5.83562 |
0 |
0 |
1.71753 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
11 |
9570 |
1 |
0 |
26.3014 |
0 |
0 |
3 |
6.24658 |
0 |
0 |
2.23987 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
10 |
9660 |
1 |
0 |
26.5479 |
0 |
0 |
3 |
6.49315 |
0 |
0 |
4.29309 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
78 |
9810 |
1 |
1 |
26.9589 |
0 |
0 |
3 |
6.90411 |
0 |
0 |
16.3808 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
41 |
9840 |
1 |
1 |
27.0411 |
0 |
0 |
3 |
6.9863 |
0 |
0 |
2.73176 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
34 |
9930 |
1 |
0 |
27.2877 |
0 |
0 |
3 |
7.23288 |
0 |
0 |
3.91411 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
52 |
9930 |
1 |
0 |
27.2877 |
0 |
0 |
3 |
7.23288 |
0 |
0 |
2.86028 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
71 |
10020 |
1 |
0 |
27.5342 |
0 |
0 |
3 |
7.47945 |
0 |
0 |
4.99421 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
3 |
10200 |
1 |
0 |
28.0274 |
0 |
0 |
3 |
7.9726 |
0 |
0 |
6.46508 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
72 |
10380 |
1 |
1 |
28.5205 |
0 |
0 |
3 |
8.46575 |
0 |
0 |
4.17088 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
42 |
10740 |
1 |
0 |
29.5068 |
0 |
0 |
3 |
9.45205 |
0 |
0 |
2.80336 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
67 |
10860 |
1 |
1 |
29.8356 |
0 |
0 |
3 |
9.78082 |
0 |
0 |
0.911652 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
85 |
11100 |
1 |
0 |
30.4932 |
0 |
0 |
3 |
10.4384 |
0 |
0 |
4.34908 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
76 |
11130 |
1 |
0 |
30.5753 |
0 |
0 |
3 |
10.5205 |
0 |
0 |
2.28753 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
59 |
11160 |
1 |
0 |
30.6575 |
0 |
0 |
3 |
10.6027 |
0 |
0 |
8.82356 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
62 |
11250 |
1 |
1 |
30.9041 |
0 |
0 |
3 |
10.8493 |
0 |
0 |
4.49486 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
23 |
11490 |
1 |
0 |
31.5616 |
0 |
0 |
3 |
11.5068 |
0 |
0 |
1.13325 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
75 |
11490 |
1 |
1 |
31.5616 |
0 |
0 |
3 |
11.5068 |
0 |
0 |
0.715854 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
50 |
11640 |
1 |
0 |
31.9726 |
0 |
0 |
3 |
11.9178 |
0 |
0 |
23.7552 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
2 |
11670 |
1 |
0 |
32.0548 |
0 |
0 |
3 |
2.05479 |
0 |
0 |
2.50851 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
53 |
11670 |
1 |
0 |
32.0548 |
0 |
0 |
3 |
12 |
0 |
0 |
1.06599 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
27 |
11910 |
1 |
0 |
32.7123 |
0 |
0 |
3 |
12.6575 |
0 |
0 |
10.0057 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
12 |
11970 |
1 |
0 |
32.8767 |
0 |
0 |
3 |
12.8219 |
0 |
0 |
6.57342 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
20 |
12000 |
1 |
1 |
32.9589 |
0 |
0 |
3 |
12.9041 |
0 |
0 |
28.8418 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
14 |
12210 |
1 |
0 |
33.5342 |
0 |
0 |
3 |
13.4795 |
0 |
0 |
3.77876 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
57 |
12390 |
1 |
0 |
34.0274 |
0 |
0 |
3 |
13.9726 |
0 |
0 |
18.1332 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
19 |
12510 |
1 |
1 |
34.3562 |
0 |
0 |
3 |
4.35616 |
0 |
0 |
4.2497 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
28 |
12630 |
1 |
0 |
34.6849 |
0 |
1 |
3 |
14.6301 |
0 |
0 |
3.95616 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |
1 |
54 |
12690 |
1 |
0 |
34.8493 |
0 |
0 |
3 |
4.84932 |
0 |
0 |
4.56509 |
0 |
0 |
0 |
0 |
0 |
WITHOUT_ART_UNQUALIFIED |
None |
0 |
0 |
0 |
0 |
0 |