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
On this page
  • How it works
  • Implementation notes
Getting Started

Print Referrals

Was this page helpful?
Previous

List Referrals

Next
Built with

In cases where referrals need to be printed for filing or passing to the patient, RefX exposes a printable referral view through the same referral details endpoint.

How it works

  1. Request printable link

    Call the “Get referral details” endpoint with the query parameter:

    1{
    2  "additionalField": "url"
    3}

  2. Open or embed the returned URL

    The response includes a url that points to a hosted read-only page optimised for printing.

  3. Print or export as PDF

    Users can print directly via the browser’s print dialog or save the page as a PDF.

Implementation notes

  • Purpose: The print URL is primarily for human-readable versions. For structured data, continue to use the standard referral endpoints.
  • Security and lifecycle: The print link shares the same access controls as the referral record and should only be made accessible to authenticated users within your system.
  • Offline workflow: If your integration needs to support offline printing, cache the rendered PDF instead of the live URL.