Client Registry APIs

🔗 View Detailed APIs in Interactive Docs
📥 Download Postman Collection

Overview

The Client Registry API enables healthcare systems to manage patient identities and facility information efficiently. It serves as the central source for patient identification, ensuring accurate and up-to-date records across the network.

Identifiers

Patients and facilities can be identified using several unique identifiers: - Client Registry (CR) ID: Unique identifier assigned by the system. - National ID: Government-issued identification. - Passport Number: International travel document identifier. - Insurance ID: Identifier linked to healthcare insurance. - Facility Code: Unique code assigned to healthcare facilities.

Data Elements

The Client Registry captures essential details, including: - Demographics (Name, Date of Birth, Gender, Citizenship) - Contact Information (Address, Phone Numbers, Email) - Identifiers (National ID, Passport, Insurance ID) - Medical Information (Chronic Conditions, Allergies, Medications) - Emergency Contacts

Key Capabilities

• Search and Retrieve: Fetch patient or facility details using identifiers.
• Update Client Records: Modify existing patient details.
• Facility Search: Retrieve facility details using facility codes.
• Practitioner Search: Identify healthcare practitioners using national ID or passport number.

Client Management

Authorized users can manage comprehensive patient and facility data, ensuring seamless healthcare coordination across systems.

---

Fetch CR Client GET

Description

Retrieves patient details by providing identification details.

Endpoint

Method: GET
URL: {{base_url}}/v3/client-registry/fetch-client?identification_type={{identification_type}}&identification_number={{identification_number}}&agent={{agent}}

Request Parameters

Parameter	Type	Required	Description
identification_type	string	✅ Yes	Type of identifier (e.g., National ID)
identification_number	string	✅ Yes	The identifier value
agent	string	✅ Yes	Your organization identifier

Response

{
  "message": {
    "total": 1,
    "result": [
      {
        "id": "CR000000000000-2",
        "resourceType": "Patient",
        "meta": {
          "versionId": "1",
          "creationTime": "2024-09-28 14:06:35.296678",
          "lastUpdated": "2024-09-28 14:17:20.919576",
          "source": "http://cr-nrb.tiberbu.health"
        },
        "identification_type": "National ID",
        "identification_number": "xxxxxxxx",
        "county": "Nairobi",
        "sub_county": "Kasarani"
      }
    ]
  }
}

Status Codes

Code	Description
200	Request successful
401	Unauthorized access
404	Client not found

---

Update CR Client PUT

Description

Allows modification of patient details such as demographics, contact information, or emergency contact details.

Endpoint

Method: PUT
URL: {{base_url}}/v1/hie-auth

Request Body

{
  "patient_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "date_of_birth": "1985-06-15",
  "gender": "Male",
  "phone_number": "+254700123456",
  "email": "[email protected]"
}

Response

{
    "message": "CR client is updated successfully"
}

Status Codes

Code	Description
200	Update successful
400	Invalid parameters
401	Unauthorized access

---

Common Use Cases

Patient Search

Use Case: Locate a patient using their National ID to prevent duplicate records.

Facility Management

Use Case: Retrieve and verify facility details before referring a patient.

Practitioner Verification

Use Case: Validate a healthcare practitioner's registration before employment.

---

Best Practices

• Always Search Before Creating: Prevent duplicate records.
• Use Secure Authentication: Ensure all API calls use JWT authentication.
• Validate Data Accuracy: Cross-check identifiers before updating records.
• Keep Information Updated: Regularly update client and facility data to maintain accuracy.

This structured API documentation ensures easy integration and efficient management of patient and facility data.