API Overview
Learn more about the Referral Exchange APIs and discover APIs easily.
| API Endpoint Name | Category | Short Description | Link |
|---|---|---|---|
| Subsidy and medical eligibility | Pre-Referral - Subsidy Eligibility | Checks patient’s subsidy and medical eligibility to determine which offerings they qualify for before referral creation. | eligibility/get |
| Retrieves a paginated list of referrals | Referral Creation & Modification | Fetches a list of referrals created by the sender, with pagination for large datasets. | referrals/list |
| Create a new referral | Referral Creation & Modification | Creates and submits a new referral with all relevant patient and offering details. | referrals/upsert |
| Full details for a referral | Referral Creation & Modification | Retrieves the complete details and metadata for a specific referral. | referrals/get |
| Delete a draft referral | Referral Creation & Modification | Deletes a referral that is still in draft and not yet submitted. | referrals/delete |
| Cancel a referral | Referral Creation & Modification | Cancels a referral that has already been submitted but not yet confirmed. | referrals/cancel |
| Amend and resubmit a pending referral | Referral Creation & Modification | Allows editing of an existing referral and resubmission for processing. | referrals/amend |
| Accept | Referral Offerings Listing | Accepts a referral offer for a particular service or slot. | referrals/accept |
| Reject | Referral Offerings Listing | Rejects a referral offer with an optional reason. | referrals/reject |
| Convert a referral to draft | Referral Offerings Listing | Converts a submitted referral back into draft status for modification. | referrals/back-to-draft |
| Create a note for a referral | Referral Details Fetching | Adds a new note or annotation to a referral record. | notes/create |
| List all referral destinations | Referral Details Fetching | Returns all available destinations or institutions for referrals. | offerings/list |
| Get the recommended offering for a category based on postal code | Referral Details Fetching | Suggests the most suitable referral offering based on category and patient postal code. | offerings/api-holding-controller-get-recommended-offering |
| List 5 timeslots for a referral destination | Webhooks | Retrieves the next five available appointment timeslots from a referral destination system. | offerings/list-timeslots |
| Create a new referral link | Webhooks | Generates a unique referral link for email or system-based referral submissions. | links/create-upsert-link |
| Fetches one referral | Referral Actions | Retrieves a specific referral by its unique identifier. | public/get-referral |
| For processing encrypted FormSG webhooks - SingHealth FormSG | Referral Actions | Handles incoming encrypted FormSG submissions for SingHealth referrals. | webhooks/submit-sing-health-formsg |
| For processing encrypted FormSG webhooks - All Forms | Referral Actions | Processes encrypted FormSG webhook payloads for all referral form types. | webhooks/submit-formsg |
| Check | Health Checks | Performs a simple health or connectivity check to verify that the API service is operational. | health/check |
