Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Immunisations

Immunisations HTML view
Section code Section name TPP EMIS Vision Microtest
IMM Immunisations Yes Yes Yes Yes

Clinical narrative

Immunisation is the process whereby a person is treated to provide immunity or resistance to an infectious disease, typically by the administration of a vaccine.

Purpose

The purpose of this section is to provide the health care professional with information about any immunisations that have been administered to the patient.

Sections and subsections

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

Section title

The section title MUST be ‘Immunisations’.

Date filter

Date filters are not supported for this section all relevant records shall be returned.

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 immunisation dd-Mmm-yyyy
2 Vaccination A short human readable free-text title for the immunisation free-text
3 Part Part number of immunisation integer
4 Contents Contents of the immunisation free-text
5 Details Longer human readable details for the immunisation free-text

HTML view

<div>
   <h1>Immunisations</h1>
   <div class="gptransfer-banner">
      <p>
         <!-- GP transfer banner -->
      </p>
   </div>
   <div class="content-banner">
      <p>
         <!-- Content banner -->
      </p>
   </div>
   <div class="exclusion-banner">
      <p>
         <!-- Exclusion banner -->
      </p>
   </div>
   <table id="imm-tab">
      <thead>
         <tr>
            <th>Date</th>
            <th>Vaccination</th>
            <th>Part</th>
            <th>Contents</th>
            <th>Details</th>
         </tr>
      </thead>
      <tbody>
         <tr>
            <!-- the <tr>...</tr> element will repeat for each immunisation-->
            <td class="date-column">{{immunisation.date}}</td>
            <td>{{immunisation.vaccination}}</td>
            <td>{{immunisation.part}}</td>
            <td>{{immunisation.contents}}</td>
            <td>{{immunisation.details}}</td>
         </tr>
      </tbody>
   </table>
</div>

Example view

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


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