Facility Registry APIs

Search Facility GET

🔗 View Detailed APIs in Interactive Docs
📥 Download Postman Collection

Overview

The Facility Registry API allows users to search for healthcare facilities within the system using facility codes. This API ensures efficient facility lookup and retrieval of essential facility details, supporting healthcare coordination and management.

Facility Identifiers

Facilities can be identified using the following: - Facility Code: A unique code assigned to each healthcare facility.

Facility Data Elements

The Facility resource contains essential facility-related information, including: - Facility Code (Unique identifier) - Approval Status - Facility Level - Operational Status - Current License Expiry Date

Key Capabilities

This API enables: - 🔍 Search and Retrieve: Find and access facility details using a facility code. - 📌 Verify Facility Status: Retrieve licensing and operational status.

Facility Management

Healthcare administrators and system users can leverage this API to: - Search for healthcare facilities based on facility codes. - Retrieve critical facility details such as approval and operational status.

Facility Resource APIs

The following API endpoint is available for interacting with the Facility Registry:

Search Facility API Endpoint

Description

Search for healthcare facilities based on facility codes.

Endpoint

• Method: GET
• URL: {{base_url}}/v1/facility-search?facility_code={{facility_code}}

Request Parameters

Headers

Response

{
  "message": {
    "facility_code": "24749",
    "found": 1,
    "approved": null,
    "facility_level": null,
    "operational_status": null,
    "current_license_expiry_date": ""
  }
}

Status Codes

Common Use Cases

Facility Lookup

Retrieve a facility’s details for reference, status verification, or licensing purposes.

Implementation Example

Before approving a new facility for a healthcare program, use this API to verify the facility’s status and operational details.

Best Practices

✅ Ensure Valid Facility Codes: Always use the correct facility code to retrieve accurate results. ✅ Authenticate Requests: Use a valid JWT token for API access. ✅ Handle Missing Data Gracefully: Not all facilities may have complete metadata (e.g., approval status or license expiry date may be null). ✅ Verify Facility Status Before Transactions: Ensure the facility is operational and licensed before proceeding with medical transactions or referrals.