Health Worker Registry APIs

Search Practitioner (GET)

🔗 View Detailed APIs in Interactive Docs
📥 Download Postman Collection

Overview

The Search Practitioner API allows users to find healthcare practitioners using their National ID or passport number. This ensures seamless verification and retrieval of practitioner details within the healthcare registry.

Identifiers

• Practitioner Identification Type: Determines whether the search is conducted using a National ID, passport, or other identification types.
• Practitioner Identification Number: The unique identification number assigned to the practitioner.

Data Elements

• Registration Number: Unique identifier assigned to the practitioner.
• Found: Indicates whether the practitioner exists in the registry.
• Is Active: Specifies if the practitioner is currently active.

Key Capabilities

• Allows searching for practitioners using National ID or passport.
• Retrieves key practitioner details, including registration status.
• Supports quick verification of practitioner credentials.

Management

• The system requires both the identification type and identification number to return results.
• The request must include valid and existing credentials.

Endpoint

Method: GET

URL: {{base_url}}/v1/practitioner-search?identification_type={{identification_type}}&identification_number={{identification_number}}

Request Parameters

Request Headers

Example Request

GET {{base_url}}/v1/practitioner-search?identification_type=ID&identification_number=12345678
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Response

{
  "message": {
    "registration_number": 40675898,
    "found": 1,
    "is_active": "yes"
  }
}

Status Codes

Use Cases

1. Verification: Ensuring that a healthcare practitioner exists in the system before engaging them.
2. Credential Check: Checking if a practitioner is active and registered.
3. Regulatory Compliance: Verifying practitioner details for regulatory and accreditation purposes.

Implementation Example

JavaScript (Fetch API)

fetch("{{base_url}}/v1/practitioner-search?identification_type=ID&identification_number=12345678", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

Best Practices

• Ensure that identification_type and identification_number are correctly formatted.
• Use secure and authorized access tokens when making requests.
• Handle error responses properly to avoid failed queries.