• API Hub
  • Search loading...

    API Hub

    Explore and Make use of Nationally Defined Messaging APIs

     

    Medications

    Medications HTML View.

    Medications

    Section Code Section Name TPP EMIS INPS Microtest
    MED Medications Yes Yes Yes Yes

    Contains three sections:

    Section Banner Content Message

    Providers message describing at a summary level how they have populated this section, and also the warning message where medications prescribed elsewhere have been excluded: “Medications prescribed elsewhere have been excluded”

    Provider Message
    EMIS  
    TPP  
    INPS  
    Microtest  

    Current Medication Issues

    Purpose

    A list of all current acute and repeat medications issued to a patient ordered by date descending (i.e. most recent date/time first).

    Date Horizon

    All relevant records SHALL be returned.

    Table Construction

    • Table header SHALL be “Current Medication Issues”.
    • 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. Start Date
    2. Medication Item
    3. Type
      • i.e. Repeat or Acute
    4. Scheduled End
    5. Days Duration
    6. Details1
      • longer human readable free-text details for the medication item.

    1Provider systems SHALL include all relevant clinical content in the Details free-text field. As a minimum the free-text narrative SHALL include these items:

    • Medication Material
    • Medication Start and End Time
    • Medication Dosage units
    • Medication Schedule(when/how often)
    • Medication Dosage Rate
    • Max Medication Dosage quantity

    HTML View

    <div>
    	<h2>Current Medication Issues</h2>
    	<table>
    		<thead>
    			<tr>
    				<th>Start Date</th>
    				<th>Medication Item</th>
    				<th>Type</th>
    				<th>Scheduled End</th>
    				<th>Days Duration</th>
    				<th>Details</th>
    			</tr>
    		</thead>
    		<tbody>
    			<tr ng-repeat="item in items">
    				<td>{{item.date}}</td>
    				<td>{{item.drug}}</td>
    				<td>{{item.type}}</td>
    				<td>{{item.scheduledEnd}}</td>
    				<td>{{item.daysDuration}}</td>
    				<td>{{item.details}}</td>
    			</tr>
    		</tbody>
    	</table>
    </div>
    

    Current Repeat Medications

    Purpose

    A list of all current repeat medications issued to a patient ordered by date descending (i.e. most recent Last Issued date/time first).

    Date Horizon

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

    Table Construction

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

    Table Columns

    1. Last Issued
    2. Medication Item
    3. Start Date
    4. Review Date
    5. Number Issued
    6. Max Issues
    7. Details
      • longer human readable free-text details for the medication item.

    HTML View

    <div>
    	<h2>Current Repeat Medications</h2>
    	<table>
    		<thead>
    			<tr>
    				<th>Last Issued</th>
    				<th>Medication Item</th>
    				<th>Start Date</th>
    				<th>Review Date</th>
    				<th>Number Issued</th>
    				<th>Max Issues</th>
    				<th>Details</th>
    			</tr>
    		</thead>
    		<tbody>
    			<tr ng-repeat="item in items">
    				<td>{{item.lastIssued}}</td>
    				<td>{{item.drug}}</td>
    				<td>{{item.start}}</td>
    				<td>{{item.review}}</td>
    				<td>{{item.numberIssued}}</td>
    				<td>{{item.maxIssues}}</td>
    				<td>{{item.details}}</td>
    			</tr>
    		</tbody>
    	</table>
    </div>
    

    Past Medications

    Purpose

    A list of all past medications, issued to a patient ordered by date descending (i.e. most recent date/time first). The type will include Acute, or Repeat.

    Where the medication was cancelled (Acute) or Discontinued (Repeat), this should be included in the Details column as Cancelled followed by Date of Cancellation or Discontinued, followed by Date when discontinued.

    Date Horizon

    All relevant records SHALL be returned according to consumer-supplied date range.

    Section Banner Content Message

    Providers message describing at a summary level how they have populated this section

    Provider Message
    EMIS  
    TPP  
    INPS  
    Microtest  

    Table Construction

    • Table header SHALL be “Past Medications”.
    • 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. Start Date
    2. Medication Item
    3. Type
      • i.e. Repeat, Acute
    4. Last Issued
    5. Review Date
    6. Number Issued
    7. Max Issues
    8. Details

    HTML View

    <div>
    	<h2>Past Medications</h2>
    	<table>
    		<thead>
    			<tr>
    				<th>Start Date</th>
    				<th>Medication Item</th>
    				<th>Type</th>
    				<th>Last Issued</th>
    				<th>Review Date</th>
    				<th>Number Issued</th>
    				<th>Max Issues</th>
    				<th>Details</th>
    			</tr>
    		</thead>
    		<tbody>
    			<tr ng-repeat="item in items">
    				<td>{{item.start}}</td>
    				<td>{{item.drug}}</td>
    				<td>{{item.type}}</td>
    				<td>{{item.lastIssued}}</td>
    				<td>{{item.review}}</td>
    				<td>{{item.numberIssued}}</td>
    				<td>{{item.maxIssues}}</td>
    				<td>{{item.details}}</td>
    			</tr>
    		</tbody>
    	</table>
    </div>
    

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