Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Encounters

Encounters HTML view
Section code Section name TPP EMIS Vision Microtest
ENC Encounters Yes Yes Yes Yes

Clinical narrative

An encounter is an interaction between a patient and a health care professional (HCP) that is recorded on the patient record. This can include:

  • planned encounters - such as pre-arranged appointments with a GP
  • unplanned encounters - such as at an out of hours clinic and those unrecorded through appointment module(s)
  • direct encounters - such as a face-to-face session with a GP
  • indirect encounters - such as a GP reviewing and updating a patient record on receipt of some test results

Purpose

The purpose of supplying encounters within GP Connect is to allow a clinician to view a history of a patient’s interactions with a clinician or an HCP.

Sections and subsections

There is a single main section for encounters with no subsections.

Section title

The section title MUST be ‘Encounters’.

Date filter

A date filter is applicable for the encounters 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 encounter dd-Mmm-yyyy
2 Title A short human-readable title for the encounter, to be composed of a subset of the Practitioner and Organization details linked to the encounter free-text
3 Details Longer human readable details for the encounter free-text

HTML view

<div>
   <h1>Encounters</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="enc-tab">
      <thead>
         <tr>
            <th>Date</th>
            <th>Title</th>
            <th>Details</th>
         </tr>
      </thead>
      <tbody>
         <tr>
            <!-- the <tr>...</tr> element will repeat for each encounter-->
            <td class="date-column">{{encounter.date}}</td>
            <td>{{encounter.entry}}</td>
            <td>{{encounter.details}}</td>
         </tr>
      </tbody>
   </table>
</div>
</div>

Example view

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


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