Providers
Providers represent healthcare professionals (doctors, nurses, specialists) registered in the MediLoop platform. Providers can be affiliated with multiple facilities and offer various medical services.
Endpoints
/api/v1/providers/register/Register a provider/api/v1/providers/search/Search providers/api/v1/providers/{provider_id}/Get provider details/api/v1/providers/verify-hspa/Verify HSPA registration/api/v1/affiliations/Create facility affiliationThe Provider Object
Attributes
iduuidUnique identifier for the provider.
hspa_numberstringHealth Service Providers Authority registration number.
first_namestringProvider's first name.
last_namestringProvider's last name.
titlestringnullableProfessional title (Dr., Nurse, etc.).
specialtystringMedical specialty.
qualificationstringProfessional qualification.
emailstringEmail address.
phone_numberstringPhone number.
ninstringnullableNational ID number.
verification_statusstringHSPA verification status.
is_activebooleanWhether the provider is active.
facilitiesarrayList of affiliated facilities.
fhir_practitioner_idstringFHIR Practitioner resource ID.
created_atdatetimeWhen the provider was registered.
{
"id": "prov-abc-123-456",
"hspa_number": "HSPA-2024-12345",
"first_name": "Sarah",
"last_name": "Nakamya",
"title": "Dr.",
"specialty": "General Practice",
"qualification": "MBChB, MMed",
"email": "sarah.nakamya@hospital.ug",
"phone_number": "+256700123456",
"nin": "CM12345678ABCDE",
"verification_status": "verified",
"is_active": true,
"facilities": [
{
"id": "fac-xyz-789",
"name": "Mulago Hospital",
"role": "attending"
}
],
"fhir_practitioner_id": "Practitioner/fhir-123",
"created_at": "2024-01-10T08:00:00Z"
}Register a Provider
Registers a new healthcare provider. HSPA verification is required for production use.
/api/v1/providers/register/Request Body
first_namestringrequiredProvider's first name
last_namestringrequiredProvider's last name
emailstringrequiredEmail address
phone_numberstringrequiredPhone number
hspa_numberstringrequiredHSPA registration number
specialtystringrequiredMedical specialty
qualificationstringrequiredProfessional qualification
titlestringoptionalProfessional title
ninstringoptionalNational ID number
curl -X POST https://api.mediloop.co/api/v1/providers/register/ \
-H "Authorization: Bearer sk_test_..." \
-H "Content-Type: application/json" \
-d '{
"first_name": "Sarah",
"last_name": "Nakamya",
"email": "sarah.nakamya@hospital.ug",
"phone_number": "+256700123456",
"hspa_number": "HSPA-2024-12345",
"specialty": "General Practice",
"qualification": "MBChB, MMed",
"title": "Dr."
}'{
"id": "prov-abc-123-456",
"hspa_number": "HSPA-2024-12345",
"first_name": "Sarah",
"last_name": "Nakamya",
"specialty": "General Practice",
"verification_status": "pending",
"is_active": true,
"created_at": "2024-01-10T08:00:00Z"
}Search Providers
Search for healthcare providers by various criteria.
/api/v1/providers/search/Query Parameters
specialtystringoptionalFilter by specialty
namestringoptionalSearch by name
facility_iduuidoptionalFilter by facility
hspa_numberstringoptionalSearch by HSPA number
is_activebooleanoptionalFilter by active status
curl "https://api.mediloop.co/api/v1/providers/search/?specialty=General%20Practice&is_active=true" \
-H "Authorization: Bearer sk_test_..."{
"count": 2,
"results": [
{
"id": "prov-abc-123",
"first_name": "Sarah",
"last_name": "Nakamya",
"title": "Dr.",
"specialty": "General Practice",
"verification_status": "verified"
},
{
"id": "prov-def-456",
"first_name": "James",
"last_name": "Okello",
"title": "Dr.",
"specialty": "General Practice",
"verification_status": "verified"
}
]
}Get Provider Details
Retrieves detailed information about a specific provider.
/api/v1/providers/{provider_id}/curl https://api.mediloop.co/api/v1/providers/prov-abc-123-456/ \
-H "Authorization: Bearer sk_test_..."{
"id": "prov-abc-123-456",
"hspa_number": "HSPA-2024-12345",
"first_name": "Sarah",
"last_name": "Nakamya",
"title": "Dr.",
"specialty": "General Practice",
"qualification": "MBChB, MMed",
"email": "sarah.nakamya@hospital.ug",
"phone_number": "+256700123456",
"verification_status": "verified",
"is_active": true,
"facilities": [
{
"id": "fac-xyz-789",
"name": "Mulago Hospital",
"role": "attending"
}
]
}Verification Status
Provider verification status values:
| Status | Description |
|---|---|
pending | Awaiting HSPA verification |
verified | HSPA credentials verified |
rejected | Verification failed |
expired | HSPA registration expired |