Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Referrals

Referrals HTML view

Back to Top

Section Code Section Name TPP EMIS Vision Microtest
REF Referrals Yes Yes Yes Yes

Clinical narrative

This is a request for transfer of care or request to provide assessment, treatment or clinical advice on the care a patient.

Purpose

The purpose of this section is to provide details of any referrals to or from other care providers.

Sections and subsections

There is only a single main section for Referrals with no subsections.

Date filter

A date filter is applicable for the Referrals section. Provider messages for a date filter can be found here.

Section content banner

Provider message(s) describing at a summary level how this section has been populated. Provider content messages can be found here.

Table construction requirements

Providers MUST adhere to the table construction requirements listed below:

  • table header MUST be “Referrals”
  • table columns MUST be ordered left-to-right (1..N)
  • table content MUST NOT be truncated

Table columns

Providers MUST return all the columns as described in the table below, ordered by Date descending:

Order Name Description Value Details    
1
Date The date of the referral dd-Mmm-yyyy
2
From Practitioner and/or Organization referred from free-text
3
To Practitioner and/or Organization referred to free-text
4
Priority The priority of the referral free-text
5
Details Longer human readable details for the referral free-text

HTML view

The following content highlights the expected HTML tags and format providers MUST use when generating the HTML content:

<div>
   <h1>Referrals</h1>
   <div>
      <p>
         <!-- GP transfer banner -->
      </p>
   </div>
   <div>
      <p>
         <!-- Content banner -->
      </p>
   </div>
   <div>
      <p>
         <!-- Date banner -->
      </p>
   </div>
   <div>
      <p>
         <!-- Exclusion banner -->
      </p>
   </div>
   <table>
      <thead>
         <tr>
            <th>Date</th>
            <th>From</th>
            <th>To</th>
            <th>Priority</th>
            <th>Details</th>
         </tr>
      </thead>
      <tbody>
         <tr>
            <!-- the <tr>...</tr> element will repeat for each referral-->
            <td>{{referral.date}}</td>
            <td>{{referral.from}}</td>
            <td>{{referral.to}}</td>
            <td>{{referral.priority}}</td>
            <td>{{referral.details}}</td>
         </tr>
      </tbody>
   </table>
</div>

All content is available under the Open Government Licence v3.0, except where otherwise stated