Getting Started

Print Referrals

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.