• API Hub
  • Search loading...

    API Hub

    Explore and Make use of Nationally Defined Messaging APIs

     

    Immunisations

    Immunisations HTML View.

    Immunisations

    Section Code Section Name TPP EMIS INPS Microtest
    IMM Immunisations Yes Yes Yes Yes

    Purpose

    A list of all immunisations related to a patient ordered by date descending (i.e. most recent date/time first).

    Section Banner Content Message

    Providers message describing at a summary level how they have populated this section, to include the following:

    Provider Message
    EMIS Part and Content not supported
    TPP  
    INPS Part = Stage, Contents = Type of Immunisation
    Microtest  

    Date Horizon

    All relevant records SHALL be returned (i.e. no time limit/filtering is to be applied).

    Table Construction

    • Table header SHALL be “Immunisations”.
    • Table columns SHALL be ordered left-to-right (1..N).
    • Table content SHALL NOT be truncated.
    • Table rows SHALL be ordered by date descending (i.e. most recent date/time first).

    Table Columns

    1. Date
      • the date of immunisation.
    2. Vaccination
    3. Part
    4. Contents
    5. Details
      • longer human readable free-text details for the immunisation.

    HTML View

    <div>
    	<h2>Immunisations</h2>
    	<table>
    		<thead>
    			<tr>
    				<th>Date</th>
    				<th>Vaccination</th>
    				<th>Part</th>
    				<th>Contents</th>
    				<th>Details</th>
    			</tr>
    		</thead>
    		<tbody>
    			<tr ng-repeat="item in items">
    				<td>{{item.date}}</td>
    				<td>{{item.vaccination}}</td>
    				<td>{{item.part}}</td>
    				<td>{{item.contents}}</td>
    				<td>{{item.details}}</td>
    			</tr>
    		</tbody>
    	</table>
    </div>
    

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