GP Connect - Access Record HTML

This guidance is under active development by NHS England and content may be added or updated on a regular basis.
Version: This is the current 0.x (DSTU2) version of GP Connect API for building the Access Record: HTML capability only. For other capabilities and specifications, please visit the GP Connect Specifications page.

Medications

Information on the 'Medications' HTML view.

Clinical narrative

A drug or other form of medicine that is used to treat or prevent disease.

Purpose

The purpose of this section is to provide a history of medication prescribing as recorded.

Section title

The section title MUST be ‘Medications’.

Date filter

A date filter is applicable to this section. The date filter MUST be applied to the All Medication and All Medication Issues subsections only. All other subsections MUST return all records as defined in the subsection descriptions below, subject to exclusions.

Section content banner

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

Acute medication (Last 12 months)

Clinical narrative

A list of acute medicines that are currently being, or have recently been, used to treat or prevent disease for the patient. The provider MUST include all acute medication whose Start Date (the date the prescription is expected to start) is greater than the current date minus 365 days.

This is aligned to the Acute Medications section in Summary Care Records (SCR).

Purpose

The purpose of this section is to provide a view of acute medications that the patient has recently been taking, which informs the clinical decision-making process.

Subsection title

The subsection title MUST be ‘Acute Medication (Last 12 Months)’.

Date filter

All relevant records MUST be returned.

Subsection content banner

Provider message describing at a summary level how they have populated this subsection.

Providers MUST return the following message, if applicable:

<div>
    <p>Scheduled End Date is not always captured in the source; where it was not recorded, the displayed date is calculated from start date and days duration</p>
</div>

Table columns

Providers MUST return all the columns as described in the table below, sorted by Start Date descending:

Order Name Description Value details
1 Type Type of medication issued (for example, Acute, Acute Post-Dated, Acute - [Prescribing Agency Type]1). free-text
2 Start Date The date of issue of the acute medications, except where:

- the medication is post-dated it MUST be the post date
- the medication is prescribed elsewhere it MUST be the expected start date if known, else the entered date		 dd-Mmm-yyyy
3 Medication Item Descriptive name of medication item (including dosage) (for example, Ibuprofen 400mg tablets). free-text
4 Dosage Instruction Dosage instructions for the medication item. As a minimum, this MUST include:

- Dosage Rate
- Schedule (when / how often)

for example, two to be taken daily		 free-text
5 Quantity Quantity details for the medication item. As a minimum, this MUST include:

- Quantity
- Quantity unit

for example, 14 capsule		 free-text
6 Scheduled End Date The date the prescription is expected to finish. dd-Mmm-yyyy
7 Days Duration Duration of medication issued in days. integer
8 Additional Information If the medication record includes the information, the following details MUST be included (each item MUST be separated with a line break):

- CONTROLLED DRUG label in bold text
- CANCELLED:  label with cancellation date and reason
- Reason for the medication
- Linked problems / diagnoses
- Other supporting information

The provider MAY include labels in addition to the ones specified to support additional text (for example, Linked Problem : Ear Infection).		 free-text

1 Where the medication was Prescribed Elsewhere the prescribing agency (type of organisation responsible for authorising and issuing the medication) MUST be included with the Type, for example, ‘Acute – Dentist’. If the medication item is identifiable as prescribed elsewhere but the type of organisation who prescribed it is not recorded, then the Type MUST be returned as ‘Acute – Unknown Prescriber’.

Current repeat medication

Clinical narrative

A list of repeat drugs or other forms of medicines that are currently being used to treat or prevent disease for the patient. This may also include PRN occasional use medication - for example, EpiPen, antihistamines, monitoring or continence products.

The provider MUST include all repeat and repeat dispensed medications (templates/plans/courses NOT individual issues) which have not been discontinued or otherwise ended. Repeat medications (including repeat dispense) which have not been discontinued are considered current where the Effective End Date (the date the cycle of prescriptions is expected to end) is either greater than the current date or is null. This MUST include those which have been authorised but not yet issued (Last Issued and Number Issued will be null).

Purpose

The purpose of this section is to provide a view of all repeat medications that the patient is currently prescribed, which informs the clinical decision-making process.

This is aligned to the Repeat Medications section in Summary Care Records (SCR).

Subsection title

The subsection title MUST be ‘Current Repeat Medication’.

Date filter

All relevant records MUST be returned (that is, no time limit/filtering is to be applied).

Subsection content banner

Provider message describing at a summary level how they have populated this subsection.

Providers MUST return the following message, if applicable:

<div>
    <p>The Review Date is that set for each Repeat Course. Reviews may be conducted according to a diary event which differs from the dates shown</p>
</div>

Table columns

Providers MUST return all the columns as described in the table below, sorted by Start Date descending:

Order Name Description Value details
1 Type Type of medication issued (for example, Repeat, Repeat Dispense, Repeat – [Prescribing Agency Type]). free-text
2 Start Date The original date of authorisation of the repeat medication (if a provider system allows re-authorisation of a repeat medication the start date MUST be the first authorisation). If this is not known (for example, for prescribed elsewhere) then date of entry of the repeat medication record MUST be returned. dd-Mmm-yyyy
3 Medication Item Descriptive name of medication item (including dosage) (for example, Ibuprofen 400mg tablets). free-text
4 Dosage Instruction Dosage instructions for the medication item. As a minimum, this MUST include:

- Dosage Rate
- Schedule (when / how often)

for example, two to be taken daily		 free-text
5 Quantity Quantity details for the medication item. As a minimum, this MUST include:

- Quantity
- Quantity unit

for example, 14 capsule		 free-text
6 Last Issued Date The last issue date. If the medication is repeat dispense or prescribed elsewhere this MUST be null. dd-Mmm-yyyy
7 Number of Prescriptions Issued This MUST be the number issued up to the current date inclusive. For a repeat dispense this will be null. This MUST be null where no issues of the repeat have been made at the current date. If the medication is repeat dispensed or prescribed elsewhere this MUST be null. integer
8 Max Issues The maximum number of issues the repeat prescription has authorised. integer
9 Review Date The date the repeat medication is due for review. dd-Mmm-yyyy
10 Additional Information If the medication record includes the information, the following details MUST be included (each item MUST be separated with a line break):

- CONTROLLED DRUG label in bold text
- Reason for the medication
- Linked problems / diagnoses
- For Repeat Dispense, the date of the last authorisation and the number of prescription issues authorised
- Other supporting information

The provider MAY include labels in addition to the ones specified to support additional text (for example, Linked Problem : Heart Failure).		 free-text
Note: If the provider system allows the repeat medication (course/template) details to be amend so it differs from the latest prescription issued, then:
  • the latest details for the medication (course/template) MUST be returned by the provider
  • a subsection banner message MUST be added such as: the medication below is taken from a list of Repeat Medication Templates in the patient record which may have been amended since they were last issued. See the All Medication Issues subsection for all repeat prescriptions issued.

Discontinued Repeat Medication

All Medication

All Medication Issues

Additional Medication Information

HTML view

<div>
   <h1>Medications</h1>
   <div class="gptransfer-banner">
      <p>
         <!-- GP transfer banner -->
      </p>
   </div>
   <div class="content-banner">
      <p>
         <!-- Content banner -->
      </p>
   </div>
   <div>
      <h2>Acute Medication (Last 12 Months)</h2>
      <div class="content-banner">
         <p>
            <!-- Content banner -->
         </p>
      </div>
      <div class="exclusion-banner">
         <p>
            <!-- Exclusion banner -->
         </p>
      </div>
      <table id="med-tab-acu-med">
         <thead>
            <tr>
               <th>Type</th>
               <th>Start Date</th>
               <th>Medication Item</th>
               <th>Dosage Instruction</th>
               <th>Quantity</th>
               <th>Scheduled End Date</th>
               <th>Days Duration</th>
               <th>Additional Information</th>
            </tr>
         </thead>
         <tbody>
            <tr>
               <!-- the <tr>...</tr> element will repeat for each current medication issue-->
               <td>${medication.type}</td>
               <td class="date-column">${medication.startDate}</td>
               <td>${medication.drug}</td>
               <td>${medication.dosageInstruction}</td>
               <td>${medication.quantity}</td>
               <td class="date-column">${medication.scheduledEndDate}</td>
               <td>${medication.daysDuration}</td>
               <td>${medication.additionalInformation}</td>
            </tr>
         </tbody>
      </table>
   </div>
   <div>
      <h2>Current Repeat Medication</h2>
      <div class="content-banner">
         <p>
            <!-- Content banner -->
         </p>
      </div>
      <div class="exclusion-banner">
         <p>
            <!-- Exclusion banner -->
         </p>
      </div>
      <table id="med-tab-curr-rep">
         <thead>
            <tr>
               <th>Type</th>
               <th>Start Date</th>
               <th>Medication Item</th>
               <th>Dosage Instruction</th>
               <th>Quantity</th>
               <th>Last Issued Date</th>
               <th>Number of Prescriptions Issued</th>
               <th>Max Issues</th>
               <th>Review Date</th>
               <th>Additional Information</th>
            </tr>
         </thead>
         <tbody>
            <tr>
               <!-- the <tr>...</tr> element will repeat for each current repeat medication-->
               <td>${medication.type}</td>
               <td class="date-column">${medication.startDate}</td>
               <td>${medication.drug}</td>
               <td>${medication.dosageInstruction}</td>
               <td>${medication.quantity}</td>
               <td class="date-column">${medication.lastIssuedDate}</td>
               <td>${medication.numberIssued}</td>
               <td>${medication.maxIssues}</td>
               <td class="date-column">${medication.reviewDate}</td>
               <td>${medication.additionalInformation}</td>
            </tr>
         </tbody>
      </table>
   </div>
   <div>
      <h2>Discontinued Repeat Medication</h2>
      <div class="content-banner">
         <p>
            <!-- Content banner -->
         </p>
      </div>
      <div class="exclusion-banner">
         <p>
            <!-- Exclusion banner -->
         </p>
      </div>
      <table id="med-tab-dis-rep">
         <thead>
            <tr>
               <th>Type</th>
               <th>Last Issued Date</th>
               <th>Medication Item</th>
               <th>Dosage Instruction</th>
               <th>Quantity</th>
               <th>Discontinued Date</th>
               <th>Discontinuation Reason</th>
               <th>Additional Information</th>
            </tr>
         </thead>
         <tbody>
            <tr>
               <!-- the <tr>...</tr> element will repeat for each discontinued repeat medication-->
               <td>${medication.type}</td>
               <td class="date-column">${medication.lastIssuedDate}</td>
               <td>${medication.drug}</td>
               <td>${medication.dosageInformation}</td>
               <td>${medication.quantity}</td>
               <td class="date-column">${medication.discontinuedDate}</td>
               <td>${medication.discontinuedReason}</td>
               <td>${medication.additionalInformation}</td>
            </tr>
         </tbody>
      </table>
   </div>
   <div>
      <h2>All Medication</h2>
      <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="med-tab-all-sum">
         <thead>
            <tr>
               <th>Type</th>
               <th>Start Date</th>
               <th>Medication Item</th>
               <th>Dosage Instruction</th>
               <th>Quantity</th>
               <th>Last Issued Date</th>
               <th>Number of Prescriptions Issued</th>
               <th>Discontinuation Details</th>
               <th>Additional Information</th>
            </tr>
         </thead>
         <tbody>
            <tr>
               <!-- the <tr>...</tr> element will group and display each distinct medication item-->
               <td colspan="9" class="med-item-column"> <strong>${medication.drug}</strong></td>
            </tr>
            <tr>
               <!-- the <tr>...</tr> element will repeat for each medication in the group-->
               <td>${medication.type}</td>
               <td class="date-column">${medication.startDate}</td>
               <td>${medication.drug}</td>
               <td>${medication.dosageInstruction}</td>
               <td>${medication.quantity}</td>
               <td class="date-column">${medication.lastIssuedDate}</td>
               <td>${medication.numberIssued}</td>
               <td>${medication.discontinuedDetails}</td>
               <td>${medication.additionalInformation}</td>
            </tr>
         </tbody>
      </table>
   </div>
   <div>
      <h2>All Medication Issues</h2>
      <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="med-tab-all-iss">
         <thead>
            <tr>
               <th>Type</th>
               <th>Issue Date</th>
               <th>Medication Item</th>
               <th>Dosage Instruction</th>
               <th>Quantity</th>
               <th>Days Duration</th>
               <th>Additional Information</th>
            </tr>
         </thead>
         <tbody>
            <tr>
               <!-- the <tr>...</tr> element will group and display each distinct medication item-->
               <td colspan="7" class="med-item-column"> <strong>${medication.drug}</strong></td>
            </tr>
            <tr>
               <!-- the <tr>...</tr> element will repeat for each medication in the group-->
               <td>${medication.type}</td>
               <td class="date-column">${medication.issueDate}</td>
               <td>${medication.drug}</td>
               <td>${medication.dosageInstruction}</td>
               <td>${medication.quantity}</td>
               <td>${medication.daysDuration}</td>
               <td>${medication.additionalInformation}</td>
            </tr>
         </tbody>
      </table>
   </div>
</div>

Example view

back to top