e-Peds HIV Dosing Guide Documentation

Welcome to the Paediatrics HIV e-Peds HIV Dosing Guide Developer Documentation where you will learn how to build amazing e-Peds HIV Dosing Guide experiences with the e-Peds HIV Dosing Guide API.

Quickstart

Paediatrics ART
Pediatrics Antiretroviral Therapy (ART) Reference
OI Prophylaxis
Opportunistic Infections (OI) Reference
Postnatal ARV
Prophylaxis
Postnatal Antiretroval (ARV) Reference

Paediatrics ART

Learn how to consume the RESTful API for the Paediatrics ART section of the Application.

Overview

Note

Every API call to the endpoints for the Paediatrics ART section must be authenticated using a JSON Web Token (JWT). To get started, create a developer account here and we will handle the rest.

Parameters

When the Paediatrics ART button is clicked, you will initialize two calls to two endpoints which will be discussed shortly. The first call will be to get the weight bands of the patient while the second call will be to get the age range of the patient. To initialize a call, the required fields to be passed are the current weight, the age, New patient or failing patient, and TB treatment?. Here's a complete list of the required parameters:

Param Required? Type Description
JWT Yes String JSON Web Token for authentication
Weight Yes Integer The current weight of the patient
Age Yes Integer The age of the patient
New Patient or Failing Patient Yes Integer Choose if the patient is new or failing
TB Treatment Yes Integer Choose if the patient is on TB treatment or not

Get Weight Bands of patient

Endpoint:
https://nascp.gov.ng/developer/get_peds_art_weights

Sample Payload to get weights of patients:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Generic sample response for each API call:

{
"status":1,
"data":
[
{"id":"1","weight_band":"less than 3kg"},
{"id":"2","weight_band":"3kg -5.9kg"},
{"id":"3","weight_band":"6kg - 9.9kg"},
{"id":"4","weight_band":"10kg -13.9kg"},
{"id":"5","weight_band":"14kg -19.9kg"},
{"id":"6","weight_band":"20kg - 24.9kg"},
{"id":"7","weight_band":"25kg -29.9kg"},
{"id":"8","weight_band":"Adult (>=30kg)"}
]
}

Get Weight Bands of patient by specific weight reference

Endpoint:
https://nascp.gov.ng/developer/get_peds_art_weight_by_ref

Sample Payload to get weight of patients by reference:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"weight": 2
}

Sample Response

{
"status":1,
"id":"2",
"weight":"3kg - 5.9kg"
}

Get Ages of Patients

Endpoint:
https://nascp.gov.ng/developer/get_peds_art_ages

Sample Payload to get age range of patients:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Response:

{
"status": 1,
"data":
[
{ "id": "1", "title": "< 1 year" },
{ "id": "2", "title": "1 to 6 years" },
{ "id": "3", "title": "6 to 7 years" },
{ "id": "4", "title": "7 to 8 years" },
{ "id": "5", "title": "9 to 10 years" },
{ "id": "6", "title": "Adolescent" }
]
}
Get Recommended ART Regimen

When the Get Recommended ART Regimen button is clicked, the payload is processed and the API responds with an array of regimens. The endpoint to call is discussed as follows:

Endpoint:
https://nascp.gov.ng/developer/get_rec_peds_art_regimen

Sample Payload:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"weight": 1,
"age": 2,
"new_patient_failing_patient": 1,
"on_tb_treatment": 1
}

Handling API Response

Depending on the input values for New Patient or Failing Treatment and On TB Treatment?, the response from the API will include pre-formatted HTML strings. The algorithm is as thus described:

  • If the patient is both a new patient and is on TB treatment, the response data will include pre-formatted HTML strings respectively for Instructions for AHD and Guidance for treatment of Tuberculosis (TB) among clients on antiretroviral therapy.
  • If the patient is a new patient only, the response data will include a pre-formatted HTML string for Instructions for AHD only.
  • If the patient is on TB treatment only, the response data will include a pre-formatted HTML string for Guidance for treatment of Tuberculosis (TB) among clients on antiretroviral therapy only.

Contained in the response also, is the Line Types whose keys are preferred_first_line_regimen, alternative_first_line_regimen, special_circumstances, and second_line. Each key holds an array of regimens.

Below is the list of responses you can receive from the Get Recommended ART Regimen endpoint:

Value Description
Success Request was successful.
Failure Request was not successful
Timeout Request timed out due to reception issues
Invalid JWT Endpoint was unable to validate the JSON Web Token Passed

Sample Response:

{
"status":1,
"0":
[
{
"regimen_id":"1",
"0":"1",
"regimen":"AZT + 3TC + DTG",
"1":"AZT + 3TC + DTG",
"weight":"1",
"2":"1",
"regimen_weight_group":"1",
"3":"1"
},
{
"regimen_id":"16",
"0":"16",
"regimen":"AZT + 3TC + RAL",
"1":"AZT + 3TC + RAL",
"weight":"1",
"2":"1",
"regimen_weight_group":"1",
"3":"1"
}
],
"1":
[
{
"regimen_id":"2",
"0":"2",
"regimen":"AZT + 3TC + LPV/r",
"1":"AZT + 3TC + LPV/r",
"weight":"1",
"2":"1",
"regimen_weight_group":"1",
"3":"1"
}
],
"2":
[
{
"regimen_id":"3",
"0":"3",
"regimen":"AZT + 3TC + NVP",
"1":"AZT + 3TC + NVP",
"weight":"1",
"2":"1",
"regimen_weight_group":"1",
"3":"1"
}
],
"3":
[
{
"regimen_id":"4",
"0":"4",
"regimen":"AZT + 3TC + LPV/r",
"1":"AZT + 3TC + LPV/r",
"weight":"1",
"2":"1",
"regimen_weight_group":"1",
"3":"1"
}
]
}

Get Dosage

When any of the buttons for the Line Types is clicked, you should initialize the call to the endpoint below to get the dosage.

Endpoint:
https://nascp.gov.ng/developer/get_peds_art_dosage

Sample Payload to get Paediatrics ART Dosage:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"weight": 2,
"regimen": 1
}

Sample response:

{ 
"status":1,
"data":
[
{
"drug":"DTG",
"dose":"0.5 OD",
"weight_band":"3kg - 5.9kg",
"drug_instruction":"Dolutegravir (DTG) 10mg is a dispersible, scored tablet (a tablet to dissolve in liquid and can be split into two halves each of 5mg pDTG) to take by mouth in combination with other ARVs. It can be used in children who are >1 month of age and weigh \u22653kg. Pediatric DTG 10mg dispersible, scored tablets (pDTG) can be used until 20kg, when children can switch to DTG 50mg film-coated tablets if they can swallow tablets whole. If they are unable to swallow the adult 50mg film-coated tablet whole, 3 (30mg) of the pDTG 10mg DT may be used instead. It is usually taken once a day with or without food. Take dolutegravir at around the same time(s) every day. Do not take more or less than prescribed by your doctor.\r\nAdd the appropriate dose for weight of pDTG to clean water, stir until the tablet(s) dissolves, and administer to the child. The child should drink all the water immediately or within a maximum of 30 minutes.\r\nIf dispersing between 0.5 or 1.5 DTG 10 mg tablets, 5 mL (1 teaspoon) of clean water should be used. When dispersing 2 or more tablets, 10 mL (2 teaspoons) of water should be used. If any medicine remains in the glass, add a little more water to the glass and give to your child. Repeat this step until no medicine remains in the cup.\r\npDTG can be dispersed and administered in the same solution of clean water as ABC/3TC 120/60 mg dispersible tablets. When dispersing both products together, use 10-20 mL (2-4 teaspoons) of clean water and ensure both medicines are properly dissolved before administering. If the tablets do not dissolve completely (i.e., they lump together), stir and slowly add a small amount of extra water until the tablets fully dissolve. \r\npDTG is recommended to be mixed with clean water. However, if a child is unable to take pDTG with water, it is reasonable to mix pDTG with other liquids or foods such as milk, juice, yoghurt, or porridge. Follow the same small volume recommendations, if other liquids are used, to ensure the child takes the full dose of medicine.\r\n",
"strength":"10mg",
"has_image":"1"
}
]
}

OI Prophylaxis

Learn how to get the dosage for OI Prophylaxis.

Overview

Note

All API calls to the endpoints in this section include a JSON Web Token (JWT). If you do not have a JWT yet, create a developer account here and we will generate one for you.

Parameters

When the OI Prophylaxis button is clicked, you should initialize a payloads to two endpoints to get the regimens and weight bands for OI Prophylaxis. The required fields are as listed:

Param Required? Type Description
JWT Yes String JSON Web Token for authentication
Weight Yes Integer The current weight of the patient
Regimen Yes Integer The regimen for OI Prophylaxis

Get Regimen

Endpoint:
https://nascp.gov.ng/developer/get_oi_prophy_regimen

Sample Payload:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Payload to get the list of regimens:

{ 
"status":1,
"data":
[
{
"id":"1",
"regimen":"Cotrimoxazole (CTX) Preventive Therapy"
},
{
"id":"2",
"regimen":"Isoniazid (INH) TB Preventive Therapy"
},
{
"id":"3",
"regimen":"3HP TB Preventive Therapy"
}
]
}

Get Weights by OI Prophylaxis Regimen

Endpoint:
https://nascp.gov.ng/developer/get_weight_by_oi_prophy

Sample Payload to get the weight bands of patient:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"regimen": 2
}

Sample Response:

{ 
"status":1,
"data":
[
{
"id":"1",
"oi_weight":"Below 6 months or < 5 kg "
},
{
"id":"2",
"oi_weight":"6 months-5 years or 5-15 kg "
},
{
"id":"3",
"oi_weight":" 6-14 years or 15-30 kg"
},
{
"id":"4",
"oi_weight":">= 14 years or >30 kg"
}
]
}

Get Dosage

Endpoint:
https://nascp.gov.ng/developer/get_oi_prophy_dosage

Sample Payload to get the dosage:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"weight": 1
}

Sample Response:

{ 
"status":1,
"regimen":"Cotrimoxazole (CTX) Preventive Therapy",
"oi_weight":"6 months-5 years or 5-15 kg ",
"no_of_tablets":"2",
"dosage":"240mg",
"frequency":"daily",
"drug_instruction":"Cotrimoxazole should be administered to HIV exposed infants from 6 weeks of age and continue until infection is excluded by an age-appropriate HIV test 6 weeks after complete cessation of breast feeding. The appropriate dose should be given orally to the child based on the age or bodyweight with plenty of water. HIV positive infants, children and adolescents should also have cotrimoxazole preventive therapy initiated irrespective of clinical or immune conditions. Priority should be given to all children younger than 5 years old regardless of CD4+ cell count or clinical stage, and children with severe or advanced HIV clinical disease (WHO clinical stage 3 or 4) and/or CD4+ cell count \u2264500 cells/mm3"
}

Post-natal ARV Prophylaxis

Learn how to get the dosage for Post-natal ARV Prophylaxis.

Overview

Note

A JSON Web Token (JWT) is a prerequisite for all API calls to the endpoints in this section. Create a developer account here and we will generate one for you.

Parameters

When you click the Postnatal ARV Prophylaxis button, you must initialize payloads to obtain the weight bands and age ranges for Postnatal ARV Prophylaxis patients. The following are the mandatory fields:

Param Required? Type Description
JWT Yes String JSON Web Token for authentication
Weight Yes Integer The current weight of the patient
Age Yes Integer The age range of the patient

Get Weight Band of patients

Endpoint:
https://nascp.gov.ng/developer/get_arv_prophy_weights

Sample Payload to get weight bands:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample response:

{ 
"status":1,
"data":
[
{
"id":"1",
"arv_weight":"< 2.5kg"
},
{
"id":"2",
"arv_weight":">= 2.5kg"
}
]
}

Get Weight Band of patient by weight reference

Endpoint:
https://nascp.gov.ng/developer/get_arv_prophy_weight_by_ref

Sample Payload:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"id": 1
}

Sample Response:

{ 
"status":1,
"id":"1",
"arv_weight":"< 2.5kg"
}

Get Age

Endpoint:
https://nascp.gov.ng/developer/get_arv_prophy_ages

Sample Payload to get the age range of patients:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Sample Response:

{ 
"status":1,
"data":
[
{
"id":"1",
"arv_age":"0 - 6 Weeks"
},
{
"id":"2",
"arv_age":"6-12 weeks** only for High risk"
}
]
}

Get age range by age reference

Endpoint:
https://nascp.gov.ng/developer/get_arv_prophy_age_by_ref

Sample Payload to get the age range of patients:

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"id": 1
}

Sample Response:

{ 
"status":1,
"id":"1",
"arv_age":"0 - 6 Weeks"
}

Get Risk Type

To get the Risk Type of the infant, four options are presented from which, the risk type will be programmatically determined by the endpoint. The value for every option provided is of type Integer where a YES is the equivalent of 1 while a NO is the equivalent of 0.

Click the image below to view the range of required options:

The algorithm for determining the risk type on the server is descriobed as follows:

  • If the values for all the select options is YES, then the result is a High Risk Infant.
  • If the values for all the select options is NO, then the result is a Low Risk Infant.
  • If the values for any of the select options is YES, then the result is a High Risk Infant.

Get Regimen

When the Get Recommended ARV Prophylaxis button is clicked, the API responds with an array of Postnatal regimens. The endpoint to call is discussed as follows:

Endpoint:
https://nascp.gov.ng/developer/get_rec_arv_prophy_regimen

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"weight": 1,
"age": 2,
"option_a": 1,
"option_b": 2,
"option_c": 1,
"option_d": 1
}

Sample Response:

{ 
"status":1,
"risk_type":"1",
"data":
[
{
"id":"1",
"regimen":"Nevirapine (NVP) 50mg/5ml"
}
]
}

Get Dosage

Endpoint:
https://nascp.gov.ng/developer/get_arv_prophy_dosage

{ 
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"weight": 2,
"age": 1,
"risk_type": 1,
"regimen": 1
}

Sample Response:

{ 
"status":1,
"data":
[
{
"drug":"NVP",
"dose":"10mg(1ml) once daily",
"route":"Oral",
"duration":"12 Weeks",
"drug_instruction":"Nevirapine 50mg/5ml comes as a suspension and should commence as a monotherapy within 72hours of birth for HIV exposed infants at low risk. Infants at low risk of acquiring HIV infection from their mothers should receive 6 weeks of daily NVP prophylaxis. Nevirapine suspension should be shaken gently prior to administration. The bottle cap should be removed and safely kept. Use the oral dosing syringe supplied with the pack to measure the dose accurately. It is important to administer the entire measured dose of suspension as prescribed. The syringe should be put into the child's mouth, placing the tip of the syringe against the inside of the child's cheek. The plunger should be pushed in slowly, allowing time to swallow. It should not be pushed too hard, and the liquid not squirted into the back of the child's throat to avoid choking. \r\nThe syringe should be washed thoroughly in clean water and let dried completely before using it again, and the bottle tightly closed with the cap.\r\n"},{"drug":"AZT","dose":"10mg (1ml) two times (12hourly) daily","route":"Oral","duration":"12 Weeks","drug_instruction":"Zidovudine oral solution is a colorless to pale yellow strawberry flavored suspension to be administered to high-risk infants in combination with Nevirapine suspension as a dual prophylaxis. All infants born to mothers with HIV who are at high risk of acquiring HIV should receive dual prophylaxis with daily AZT and NVP for the first 12 weeks of life. High-risk infants are defined as those born to women with established HIV infection who have at least one of the following: \r\n\u2022\tHave received < four weeks of ART at the time of delivery \r\n\u2022\tHave VL >1000 copies/ml during the four weeks before delivery, if VL available \r\n\u2022\tHave incident HIV infection during pregnancy or breastfeeding\r\n\u2022\tAre identified for the first time during the postpartum period, with or without a negative HIV test prenatally\r\nZidovudine suspension should be shaken gently prior to administration. The bottle cap should be removed and safely kept. Use the oral dosing syringe supplied with the pack to measure the dose accurately. It is important to administer the entire measured dose of suspension as prescribed. The syringe should be put into the child's mouth, placing the tip of the syringe against the inside of the child's cheek. The plunger should be pushed in slowly, allowing time to swallow. It should not be pushed too hard, and the liquid not squirted into the back of the child's throat to avoid choking. \r\nThe syringe should be washed thoroughly in clean water and let dried completely before using it again, and the bottle tightly closed with the cap. Zidovudine oral solution is associated with hematologic toxicity including neutropenia and severe anemia.\r\n"
}
]
}

World Health Organization Guidelines

Learn how to view the World Health Organizations HIV Management Guidelines

Endpoint:
https://nascp.gov.ng/developer/view_who_hiv_guideline

This endpoint launches a browser tab that links to the World Health Organization's portal for HIV management guidelines.

Sample Response:

{ 
"status":1,
"url":"https://www.who.int/publications/i/item/9789240031593"
}

National HIV Treatment Guidelines

Learn how to view the National HIV Treatment Guidelines

Endpoint:
https://nascp.gov.ng/developer/view_national_hiv_guideline

This endpoint renders an in-App PDF document.

Sample Response:

{ 
"status":1,
"url":"https://nascp.gov.ng/resources/get_resource_doc/31"
}