HIV Viral Load
HIV Viral Load (VL) testing measures the amount of HIV RNA in a patient's blood, serving as the primary indicator for monitoring antiretroviral therapy (ART) effectiveness. Viral suppression (typically defined as fewer than 1,000 copies/mL) confirms successful treatment, while unsuppressed results signal the need for enhanced adherence counseling or regimen changes.
The OpenLDR Analytics API provides 35 VL endpoints organized across three categories, covering the full spectrum of viral load program monitoring — from national dashboard indicators to laboratory-level sample tracking and health facility analytics.
Overview
The VL module tracks viral suppression outcomes across the entire testing pipeline. All endpoints support filtering by date range, geographic location, and facility attributes.
Key analytics provided include:
- Viral suppression rates: Tracking of suppressed vs. not suppressed results across all dimensions
- Gender stratification: Male and female suppression breakdowns for targeted program analysis
- Age group analysis: Stratification across age bands (0-14, 15-19, 20-24, 25-29, 30-34, 35-39, 40-44, 45-49, 50+) for demographic insights
- Test reason analysis: Breakdown by routine monitoring, treatment failure suspicion, and unspecified reasons
- Pregnant and breastfeeding: Dedicated endpoints for PMTCT (Prevention of Mother-to-Child Transmission) program monitoring
- Turnaround time (TAT): Four-segment measurement covering collection-to-reception, reception-to-registration, registration-to-analysis, and analysis-to-validation
Documentation structure
The VL endpoint documentation is organized into three sections:
Summary
6 endpoints providing system-wide dashboard indicators, suppression trends, TAT averages, and provincial breakdowns.View endpointsLaboratory
15 endpoints with testing data grouped by laboratory, including suppression rates, gender, age groups, TAT, and rejection data.View endpointsHealth Facilities
14 endpoints with data grouped by requesting facility, including suppression, gender, age groups, TAT, and PMTCT indicators.View endpointsCommon parameters
All VL endpoints accept these standard query parameters:
- Name
interval_dates- Type
- JSON array
- Description
Date range filter:
["YYYY-MM-DD","YYYY-MM-DD"]. Defaults to last 12 months.
- Name
province- Type
- string
- Description
Province name filter. Multi-select supported.
- Name
district- Type
- string
- Description
District name filter. Multi-select supported.
- Name
health_facility- Type
- string
- Description
Specific health facility name.
- Name
facility_type- Type
- string
- Description
Grouping level:
"province","district", or"health_facility".
- Name
disaggregation- Type
- string
- Description
Enable data breakdown:
"True"or"False".