Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Clinical items

Clinical Items HTML view

Back to Top

Section Code Section Name TPP EMIS Vision Microtest
CLI Clinical Items Yes Yes Yes Yes

Clinical narrative

Items of information relating to the care, health or wellbeing of the patient. Examples of this type of information are: childhood and travel vaccinations, screening information and past medical history. It does not include administrative items such as invitations for health-related information.

Purpose

The purpose of supplying clinical items within GP Connect is to allow a clinician to view a history of items relating to the health and wellbeing of a patient.

Sections and subsections

There is a single main section for clinical items with no subsections.

Date filter

A date filter is applicable for the Clinical items 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 “Clinical Items”
  • 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 entry of the clinical item dd-Mmm-yyyy
2
Entry A short human readable title for the clinical item free-text
3
Details Longer human readable details for the clinical item free-text

HTML view

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

<div>
   <h1>Clinical Items</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>Entry</th>
            <th>Details</th>
         </tr>
      </thead>
      <tbody>
         <tr>
            <!-- the <tr>...</tr> element will repeat for each clinical item-->
            <td>{{item.date}}</td>
            <td>{{item.entry}}</td>
            <td>{{item.details}}</td>
         </tr>
      </tbody>
   </table>
</div>

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