VLSM REST API v1.1
VL API
New VL Test Requests
1min
POST
Request
Header Parameters
Authorization: Bearer {token}
required
String
Bearer Token
Body Parameters
appSampleCode
required
String
This is the external system's Sample Identifier
facilityId
required
Number
Health Facility ID
provinceId
optional
Number
Province ID (comes from the Geographical Divisions dataset)
sampleCollectionDate
required
String
Sample Collection Date
patientFirstName
optional
String
Patient First Name (or full name in places where only one field is there in the form)
patientLastName
optional
String
patientGender
required
String
Patient Gender
healthInsuranceCode
optional
String
patientDob
optional
String
Patient's Date of Birth
ageInYears
optional
String
Patient Age in Years
ageInMonths
optional
String
Patient Age in Months
patientPregnant
optional
String
Is Patient Pregnant?
patientArtNo
required
String
Unique Patient Identifier
dateOfArtInitiation
optional
String
Date of ART Initiation
artRegimen
optional
String
Current ART Regimen
hasChangedRegimen
optional
String
Has ART Regimen changed
reasonForArvRegimenChange
optional
String
Reason for Regimen change
dateOfArvRegimenChange
optional
String
Date of Regimen change
regimenInitiatedOn
optional
String
Current Regimen Initiated On
lastViralLoadResult
optional
String
Last VL Result (copies/mL)
lastViralLoadTestDate
optional
String
Last VL Test Date
conservationTemperature
optional
String
durationOfConservation
optional
String
dateOfCompletionOfViralLoad
optional
String
viralLoadNo
optional
String
Test Number
patientPhoneNumber
optional
String
Patient Phone Number
receiveSms
optional
String
Consent to receive SMS
specimenType
required
Number
Sample/Specimen Type
arvAdherence
optional
String
ARV Adherence %
reasonForVLTesting
required
Integer
rmTestingLastVLDate
optional
String
rmTestingVlValue
optional
String
repeatTestingLastVLDate
optional
String
repeatTestingVlValue
optional
String
lineOfTreatment
optional
String
suspendTreatmentLastVLDate
optional
String
suspendTreatmentVlValue
optional
String
reqClinician
optional
String
reqClinicianPhoneNumber
optional
String
requestDate
optional
String
vlFocalPerson
optional
String
vlFocalPersonPhoneNumber
optional
String
labId
required
Number
Testing Lab ID
testingPlatform
optional
String
sampleTestingDateAtLab
optional
String
isSampleRejected
optional
String
rejectionReason
optional
Number
rejectionDate
optional
String
vlResult
optional
String
vlResultAbsoluteDecimal
optional
String
result
optional
String
revisedBy
optional
String
revisedOn
optional
String
reasonForVlResultChanges
optional
String
testedBy
optional
String
reviewedBy
optional
String
reviewedOn
optional
String
approvedBy
optional
String
approvedOnDateTime
optional
String
labComments
optional
String
resultStatus
optional
String
fundingSource
optional
String
implementingPartner
optional
String
uniqueId
required
String
Universal Unique Identifier for the sample
reasonForResultChanges
optional
Array