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 other care providers.

Sections and subsections

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

Section title

The section title MUST be “Referrals”.

Date filter

A date filter is applicable for the Referrals section.

Section content banner

Provider message describing at a summary level how they have populated this section.

Table columns

Providers must return all the columns as described in the table below, sorted by Date descending:

Order Name Description Value details    
1
Date The date of the referral dd-Mmm-yyyy
2
From Practitioner or Organization referred from free-text
3
To Practitioner 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

<div>
   <h1>Referrals</h1>
   <div class="gptransfer-banner">
      <p>
         <!-- GP transfer banner -->
      </p>
   </div>
   <div class="content-banner">
      <p>
         <!-- Content banner -->
      </p>
   </div>
   <div class="date-banner">
      <p>
         <!-- Date banner -->
      </p>
   </div>
   <div class="exclusion-banner">
      <p>
         <!-- Exclusion banner -->
      </p>
   </div>
   <table id="ref-tab">
      <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 class="date-column">{{referral.date}}</td>
            <td>{{referral.from}}</td>
            <td>{{referral.to}}</td>
            <td>{{referral.priority}}</td>
            <td>{{referral.details}}</td>
         </tr>
      </tbody>
   </table>
</div>

Example view

See the Pen Referrals by gp_connect (@tford70) on CodePen.


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