For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Home
    • About the Referral Exchange (RefX)
  • Getting Started
    • API Overview
    • Accessing our APIs
    • Authentication
    • Content Types
    • Request and Response Limits
    • Create and Edit Referrals
    • Print Referrals
    • List Referrals
    • Cancel & Withdraw Referrals
    • Timeline Events
    • Implementation Reference
  • Concepts
    • Referral Lifecycle & Statuses
    • Referral Notes
    • Browser Tab Handling
    • Referral Link
    • NEHR Integration
  • API Reference
    • Changelog
LogoLogo
Getting Started

Accessing our APIs

This section will guide developers from GP Clinic CMSes or other sender systems through the end-to-end integration steps with RefX.

After reading this section, you should be able to:

  • Authenticate against RefX
  • Create a referral
  • Generate and use a Referral Link
  • Track referral statuses
  • Handle common errors and edge cases

You can use the APIs Overview section to explore available endpoints, view each and test requests in your browser, and review example payloads and responses.

API keys are issued to approved partners through the HealthTech GovTech developer onboarding process. Each key is linked to a specific environment (e.g. Sandbox or Production).

Was this page helpful?
Previous

Authentication

Next
Built with