Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Observations

Observations HTML view
Back to Top

Back to Top

Section Code Section Name TPP EMIS Vision Microtest
OBS Observations Yes Yes Yes Yes

Clinical narrative

A clinical observation is a repeatable data element recorded by health professionals in the course of assessment or care of their patients or clients. Examples include, blood pressure measurement, weight, height or temperature measurement.

Purpose

The purpose of this section is to enable the clinician to view and compare chronological data pertaining to a patient’s physical condition.

Sections and subsections

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

Date filter

A date filter is applicable for the Observations 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 “Observations”
  • 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 the observation dd-Mmm-yyyy
2
Entry A short human readable free-text title for the observation free-text
3
Value Value and range (where available) of the observation free-text
4
Details Longer human readable details for the observation. Number formatting MUST follow the guidelines published on page 5 of the CUI Medication Line document. free-text
Important: GP Principal suppliers have indicated this section will contain all clinical items that represent measurement data (i.e. blood pressure, temperature, heart rate etc.).

HTML view

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

<div>
   <h1>Observations</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>Value</th>
            <th>Details</th>
         </tr>
      </thead>
      <tbody>
         <tr>
            <!-- the <tr>...</tr> element will repeat for each observation-->
            <td>{{observation.date}}</td>
            <td>{{observation.entry}}</td>
            <td>{{observation.value}}</td>
            <td>{{observation.details}}</td>
         </tr>
      </tbody>
   </table>
</div>

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