29
FormularyComplete Admin User Manual May 20180525 v1 1 FormularyComplete - Admin User Guide Contents 1 Main features of FormularyComplete 1.1 User access and system permissions 2 Finding prescribing information 2.1 Home page 2.2 General search 2.2.1 Search results screen 2.3 Browsing a formulary 2.4 Formulary summaries 2.5 Drug monograph layout 2.5.1 Medicinal forms screen 2.6 Manual entry of the dm+d identifier 2.7 Printing records 3 Using the local formulary editing tools 3.1 Access and permissions 3.2 Setting formulary status 3.3 Using the Note Editor 3.4 Creating and editing records 3.4.1 Directory and record types 3.4.2 Using the Local Record Editor 3.5 Review changes 3.5.1 Review submissions for approval 3.6 Local document library

FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

  • Upload
    others

  • View
    2

  • Download
    0

Embed Size (px)

Citation preview

Page 1: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 1

FormularyComplete - Admin User Guide

Contents

1 Main features of FormularyComplete

1.1 User access and system permissions

2 Finding prescribing information

2.1 Home page

2.2 General search

2.2.1 Search results screen

2.3 Browsing a formulary

2.4 Formulary summaries

2.5 Drug monograph layout

2.5.1 Medicinal forms screen

2.6 Manual entry of the dm+d identifier

2.7 Printing records

3 Using the local formulary editing tools

3.1 Access and permissions

3.2 Setting formulary status

3.3 Using the Note Editor

3.4 Creating and editing records

3.4.1 Directory and record types

3.4.2 Using the Local Record Editor

3.5 Review changes

3.5.1 Review submissions for approval

3.6 Local document library

Page 2: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 2

4 Formulary settings, user accounts and reports

4.1 Editing and publishing

4.2 Formulary status types

4.3 Admin user rights, including remote access

4.3.1. Create admin user

4.4 Logo

4.5 Formulary admin contact information

4.6 Public-facing formulary report configuration

4.7 Home-page noticeboard content

4.8 Manage home-page data feeds

4.9 Formulary name

4.10 BNF content updates and formulary notes conflicts

4.11 Audit trail

5 Support

5.1 Account enquiries

5.2 Technical assistance

Page 3: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 3

FormularyComplete - Admin User Manual

1 Main features of FormularyComplete FormularyComplete has been designed to enable healthcare organisations to customise British

National Formulary (BNF) and British National Formulary for Children (BNFC) content so that it

reflects the pharmacy and prescribing practices of their organisation.

The extent to which hospital trusts wish to customise the BNF for their internal use varies

considerably, and FormularyComplete accordingly offers formulary managers a variety of tools for

adding notes, links and local status flags to BNF and BNFC records and for integrating locally-created

documents into the same system.

FormularyComplete does not permit the BNF data to be directly edited or BNF records to be deleted;

so users can be confident that BNF content that appears in FormularyComplete matches BNF

content produced online and in the BNF & BNFC apps and print. The web-based version of

FormularyComplete uses the current BNF content structure, first published in print in 2015.

1.1 User access and system permissions Users can connect to FormularyComplete from their organisation’s internal network and view the

site without having to log in. They can also be registered as ‘remote users’ by the organisation’s

administrator. These customers will be given a user name and password and routed to a web

address where they will be able to access the service over the internet.

To make changes to content, users must be set up with administrator permissions and log in with a

user name and password to access the admin functions. There are three types of admin user:

‘Editor’, ‘Publisher’ and ‘Administrator’. Users with any one of these roles see an ‘Admin’ menu at

the top of the web page. You will also be able to select whether to enable remote access.

The Editor and Publisher roles are designed to facilitate a workflow of checking and approval prior to

the publication of content changes to the site. The approval of draft edits is managed through the

‘Review changes’ function. There is also a ‘Publish now’ option available to users with the ‘Publisher’

and ‘Administrator’ roles that bypasses the draft approval process. Where more than one person is

involved in editing the formulary, a policy decision will be needed on whether or not to allow the

review to be sidestepped in this way.

Up to three administrators can be given remote user access together with editing rights. It is not

possible to do this within the user admin area and administrators should contact their account

manager at the Royal Pharmaceutical Society if they wish to take advantage of this facility.

Page 4: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 4

2 Finding prescribing information

2.1 Home page FormularyComplete opens at the local formulary home page. Along the top header are links to the

‘Admin Login’ (for access to editing and management functions) and to browse the tables of

contents of the formularies. Lower down the page, the site manager can add a noticeboard, for

internal notices, and external RSS or Atom feeds, and users can check what BNF and BNFC content

has changed in recent updates.

Home page

2.2 General search A search bar is in the header at the top of every page. Entering two or more characters in the bar will produce a dropdown list of possible search terms from the FormularyComplete records. Select one of the dropdown options to trigger the search.

Search bar auto-suggestions

Page 5: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 5

2.2.1 Search results screen Search results are split by formulary; BNF, BNFC and any Locally added records. The default

formulary is the BNF. Selecting a formulary icon at the top of the screen shows results for that

formulary. The number of search results in each formulary displays underneath the formulary icon.

Within each formulary search results screen, search results are arranged by record types:

Drugs/Devices; Preparations; Treatment Summaries; and Other. The search results list contains

clickable links to the corresponding records.

Search results screen

2.3 Browsing a formulary On the right-hand half of the header bar are buttons linking to the tables of contents for the

formularies. The titles of all records in the formulary are listed in an expandable table of contents.

Clicking the arrow icon to the left of a title opens (or, on re-clicking, closes) a list of the categories

and records at the next level below. Record titles in green are links are to BNF or BNFC content

records, titles in blue are links to records that were added by local formulary management.

BNF Table of contents screen

Page 6: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 6

Expanded view of the BNF Table of contents screen

The main clinical content is presented in the form of drug monographs (see below) and treatment

summaries.

Page 7: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 7

2.4 Formulary summaries The ‘Summary formulary reports’ let you search for medicines by formulary status. The link on the

home page takes you to an index that covers the treatment domains (‘Body systems’) in the BNF and

BNFC, along with Borderline substances, Wound care and any medicines/medical device directories

in the Local document library.

Formulary report menu screen

The summary report for each domain shows the medicines and medicinal products that have a

status assigned to them, and any local notes or NICE Technical Assessments. The report can be

filtered on formulary status or searched by medicine name (see the example for paracetamol,

below).

Page 8: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 8

Formulary report screen

You can jump to a record by clicking the name of a medicine or product in the list, click Back to

return to the report index, or return to the FormularyComplete home page by clicking the report

title in the header bar.

Admin users can also see products that don’t have status in the formulary report.

2.5 Drug monograph

Drug monograph screen

Where a record has both local and BNF information, the local information will be displayed first. If a

record has a formulary status assigned to it, a panel will appear at the top of the monograph screen

showing each of the therapeutic uses a status has been assigned to and an icon indicating that

status. Hovering over this icon displays the name of the formulary status. If no formulary status has

been assigned, the panel will not appear.

Any notes added to the drug monograph appear in a collapsible panel underneath the formulary

status panel (where present), or at the top of the monograph screen where no status has been

assigned.

The full BNF or BNFC drug monograph appears underneath the notes panel. You can go directly to

specific monograph sections by clicking the section heading in the navigation panel on the left of the

monograph screen.

Page 9: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 9

Related information

The box at the right-hand side of the content page contains a button to switch between the

equivalent drug monograph in the BNF and BNFC, where a drug appears in both formularies. This

box also contains links to related drug records.

Text hyperlinks

The BNF text includes live cross-references to sections containing prescribing information or

interactions data, and links to external websites.

NICE guidance

Where a NICE Technology Appraisal applies to a drug, the name of the drug in the screen title is

followed by the icon . The BNF summary of the guidance is in the drug monograph screen,

under ‘National funding/access decisions’. The summary contains a link to the Technology Appraisal

on the NICE website that will open in a separate browser tab.

NOTE If you go directly to a preparation record, you will need to check its parent drug monograph

record to see whether a NICE TA applies to it.

Evidence grading

BNF clinical recommendations may be accompanied by a symbol displaying the grade of

recommendation (see https://www.medicinescomplete.com/mc/BNF/current/PHP98621-how-BNF-

publications-are-constructed.htm for an explanation of the five grades). Evidence grading can be

toggled on and off with the button in the left-hand navigation panel.

2.5.1 Medicinal forms screen The Medicinal forms screen lists the different forms of a medicine that is available.

Page 10: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 10

Medicinal forms screen – list of forms

Clicking on a form opens a list of preparations available under that form – either individual

proprietary preparations or one entry covering available generics. Any formulary statuses assigned

to preparations are visible at this level: they will appear in a coloured panel underneath the title of

the preparation record.

Medicinal forms screen – expanded form view

Clicking on the title of a preparation record on this list opens the detailed preparation record and

any local formulary notes that have been added to it.

Medicinal forms screen – expanded preparation information view

Browser navigation

You can use your browser’s navigation controls to move between records, as on a normal website.

Page 11: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 11

2.6 Manual entry of the dm+d identifier The database includes the substance identifiers (ID) from the NHS Dictionary of Medicines and

Devices (dm+d). Their primary purpose is to facilitate integration with different electronic systems.

To find a medicine or preparation using its dm+d ID, enter the URLfor the record into the address bar

of your browser in the format ‘formularycomplete.com/bnf/dmd/7947003’. The URL consists of four

elements, where:

‘formularycomplete.com’ is the root URL for FC

‘bnf’ is the code for the required result output. This can be either ‘bnf’, ‘bnfc’ or ‘search’ and

will resolve to content pages from the BNF, the BNFC or a search results page, respectively

‘dmd’ is the code that invokes the dm+d reference; and

‘7947003’ is the dm+d code of the required record (in this case, the aspirin monograph).

For example, the URL of the BNF record for aspirin is:

www.formularycomplete.com/bnf/dmd/7947003. The url for the search results page for ‘aspirin’ is:

www.formularycomplete.com/search/dmd/7947003

2.7 Printing records To print out a record you should use the print command in your browser. For the web page to print

correctly you need to ensure first that ‘Print background colours and images’ is ticked under the

browser’s Page setup options. (Page setup is normally found in the File menu or the Print menu,

depending on your browser, and may be located under a Format subdivision of that menu.)

3 Using the local formulary editing tools There are three types of local content that can be added to FormularyComplete: formulary statuses,

notes and records.

Formulary statuses can be added to drug monographs and medicinal preparations using the ‘Use

and local status’ panel in the appropriate record (see 3.2 Setting formulary status).

Notes can be added to drug monographs, medicinal preparations, treatment summaries and

guidance from the Notes panel in the appropriate record, which opens the Note Editor (see 3.3

Using the Note Editor).

Records can be added to the BNF or BNFC content structure, or used to build a separate local

structure, using the Local Record Editor (see 3.4 Creating and editing records).

3.1 Access and permissions To use the editing features of FormularyComplete, you need to log in as an admin user first, using

the Admin Login link in the site header. Editing features are available to users who have been

assigned ‘Editor’, ‘Publisher’ or ‘Administrator’ user rights. See 4.3 Admin user rights for an outline

of admin user rights.

Page 12: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 12

3.2 Setting formulary status Formulary statuses can be applied to drug records, medicinal preparation records, borderline

substance and wound care product records from the record screen. For drug and medicinal

preparation records, statuses can be applied for each therapeutic use associated with it, so one

record can have multiple statuses. When you are logged on to the system as an admin user, a ‘Use

and local status’ box is displayed at the top of each drug monograph screen, and above each

preparation entry on medicinal form screens, to allow you to set their formulary statuses. Clicking on

the pen icon ( ) opens the status editing function.

Use and local status box (admin view)

Formulary status selection tool [NB callout: Admin users = Administrators]

Page 13: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 13

Clicking ‘Select’ opens a drop-down menu of the formulary statuses that can be applied. The default

statuses are ‘On Formulary’, ‘Restricted’ and ‘Off Formulary’, and admin users can specify other

formulary statuses for use at your site. After selecting a status from the menu you can send the

change for review and confirmation by clicking the ‘Submit for approval’ button. Publishers and

Administrators can use the ‘Publish now’ command to make the change on the website immediately.

3.3 Using the Notes Editor The simplest way to add local information to FormularyComplete is to use the Notes Editor. For this

you need to be logged on to the system as an admin user. You will see a ‘Notes’ panel beneath the

‘Use and local status’ panel at the top of drug monograph screens and at the top of individual

preparations records when a preparations record has been selected. Selecting the ‘+’ button

launches the Notes Editor.

Where a record already has a note attached, a pen icon is displayed in that note. Selecting this icon

opens the Notes Editor to allow you to edit the existing note.

Admin user Notes view on a drug monograph

Page 14: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 14

Notes Editor

A note can be inserted into any record in the therapeutic use hierarchy where notes are permitted

by selecting check boxes in the hierarchy. When a note is first created on a drug or preparation, it

will be associated by default with all its recognised therapeutic uses. The host record list should be

checked, and any use that the note does not apply to deleted, before the note is saved.

Since a single note can be attached to multiple records, it has to be given a title to identify it. By

default notes do not appear in a public summary report of the formulary, but they can be included in

the public report by ticking the ‘Public’ box in the Note Editor.

Buttons at the top of the Note Editor save your work as a draft or send it for approval under the

‘Review changes’ admin screen.

Publishers and Administrators have additional options to ‘Publish now’ or, for draft or pre-existing

notes, ‘Delete directly’ which make the changes to the site immediately.

The Notes Editor provides a range of basic formatting controls and support for the insertion of

external web links. If you wish to add links using the tool, adding the URL in the ‘Add links to other

sites’ section will create a link that will open in a new browser window.

Creating a link in the Notes Editor

Page 15: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 15

NOTE You should use care in pasting content from other applications, such as hyperlinks extracted

from web pages or tables copied from Microsoft Word. The embedded coding associated with the

formatting in other applications could cause corruption and render the record inaccessible.

Save as draft (all admin users)

When you save work in progress, it is added to the ‘Drafts’ section of the Review changes page. To

return to a note to continue editing, go to the Admin menu in the site header and select Review

changes to launch the Review screen.

Select ‘Drafts’ from the left-hand menu to see the current list of draft content. Clicking the

document name will display the draft content and an ‘Edit’ button which will relaunch the Note

Editor, allowing you to continue work where you left off. Clicking the document name again will

close the display of the draft content.

Review changes: Drafts screen

Reopen draft from Review changes table

Draft notes are not locked to a user; Publishers and Administrators can open and amend drafts.

Submit for approval

When you have finished creating or editing content in the Notes Editor, selecting ‘Submit for

approval’ sends the record to the Review changes table for approval.

Page 16: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 16

Publish now (Publishers and Administrators only)

Selecting the ‘Publish now’ button in the Note Editor will implement the update directly, bypassing

the Review changes table.

Recommend deletion

Selecting the ‘Recommend deletion’ button adds the record to the Review changes table with

‘Delete’ as the proposed change. If the Delete action is then confirmed, the note will be removed.

Delete directly (Publishers and Administrators only)

Clicking the ‘Delete directly’ button removes the note immediately.

Where a note has been used in more than one place, it is important to consider the impact of its

alteration or removal on all the records it has been linked to.

Cancel

To abandon all your changes, click the ‘Cancel’ button. (Note that deletion becomes an option only

after a note has been created.)

3.4 Creating and editing records The BNF and BNFC content hierarchies are made up of directories (‘folders’ that can contain content

records) and records. Every content record must sit within a directory.

Records can be inserted in any directory under Body systems, Borderline substances or Wound

management products in either formulary or in the Local document library, but it is not possible to

add or select directories at the topmost level. If an appropriate subdirectory does not already exist,

you will need to create a local subdirectory before adding the record.

3.4.1 Directory and record types The BNF and BNFC content is structured in the same format as print at the highest level by

therapeutic use (also known as body system such as cardiovascular system). Within each body

system, the content is arranged by the therapeutic use it relates to (e.g. hypertension). Body systems

and therapeutic use directories function as section headings rather than holding content. Records

include drug monographs, treatment summaries, and other clinical or explanatory information

content.

Admin users can add most types of directories and records to the content structure, but there are

certain restrictions on each directory and record type which are explained in detail below.

Body system directory

Content in the BNF structure is arranged by the body system it relates to (e.g. cardiovascular

system). Records can appear under multiple body systems (e.g. the timolol maleate monograph

appears under both the ‘cardiovascular’ and ‘eye’ body systems).

The body system directory is fixed to reflect the BNF/BNFC structure – additional body systems or

changes to existing body systems cannot be made locally. Treatment summary records and

therapeutic use directories can be added under any body system directory.

Therapeutic use directory

Within each body system directory, content is arranged by therapeutic use. Therapeutic uses must

appear under a body system or within another therapeutic use directory (e.g. ‘pulmonary

Page 17: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 17

hypertension’ appears under the therapeutic use ‘hypertension’). Records can appear under

multiple therapeutic uses.

Formulary statuses and notes attached to a record can be applied to each therapeutic use that the

record appears in, to allow for instances where the status or note differs between uses. For example,

Timolol Maleate may be ‘on formulary’ for glaucoma but ‘restricted’ for hypertension.

Admin users can add therapeutic use directories to the BNF content structure. Drug, medical device,

and treatment summary records can be added to any therapeutic use directory.

Treatment summary record

Treatment summaries provide an overview of the management of a particular condition, or discuss a

group of drugs in detail.

Treatment summary records may be added to any body system or therapeutic use directory in the

structure.

Drug monograph record

All information for a drug is contained in a single drug monograph, arranged by therapeutic use.

Admin users can add drug monographs to the BNF content structure.

Medicinal form directory

Under a drug monograph record, preparations are arranged in medicinal form directories (e.g.

tablet). Admin users can add medicinal form directories to the BNF content structure. They can only

be added under a drug monograph record.

Preparation record

A preparation record contains information about an actual medicinal product (e.g. Panadol tablets)

including strength, pack size and price. These records inherit their therapeutic use(s) from their

parent drug monograph record.

Admin users can add preparation records to the BNF content structure. They must be added under

the appropriate medicinal form directory.

Borderline substance directory

This directory is used to describe a form of borderline substances, such as enteral feeds. Borderline

substance directories must appear under the root Borderline substances directory or another

borderline substance directory. Admin users can add Borderline substance directories to the BNF

content structure.

Borderline substances record

This is a record describing a specific borderline substance that may be prescribed. Borderline

substance records must appear under a borderline substance directory and they can have formulary

statuses assigned to them. Borderline substances are not associated with a therapeutic use. Admin

users can add Borderline substance directories to the BNF content structure.

Wound care product directory

This is a directory describing a form of wound care product. Wound care product directories must

appear under the root wound management directory or another wound care product directory.

Admin users can add wound care product directories to the BNF content structure.

Page 18: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 18

Wound care product record

This is a record describing a specific wound care product that may be prescribed. Wound care

product records must appear under a wound care product directory and they can have formulary

statuses assigned to them. Wound care product are not associated with a therapeutic use. Admin

users can add wound care product records to the BNF content structure.

Guidance directory

The guidance directory contains guidance records (e.g. prescribing in children). Guidance directories

cannot be added to the BNF/BNFC structure.

Guidance record

Guidance records have information on specific prescribing areas (e.g. prescribing in children) and

appear directly under the guidance directory. Guidance records cannot be added to the BNF/BNFC

content structure but admin users can add notes to them.

Plain directory

Plain directories only appear in the Local content structure. They have no restrictions and can be

used to create a bespoke content structure for Trust records.

Plain record

Plain records only appear in the Local content structure. They have no restrictions and can be used

to create a bespoke content structure for Trust records.

3.4.2 Local Record Editor The Local Record Editor is launched from the Admin menu by clicking on ‘Add or edit local record’.

The editor comprises

on the left of the screen, a navigation tool for creating and/or selecting the location in the

content hierarchy for the local record, and for selecting the type of record to be created

on the right of the screen, an editing panel, for creating the record content.

Selecting a record location in the content hierarchy

1. Under ‘Browse’ select the formulary you want to add the record to (BNF, BNFC, or the Local

document library) and then use the content tree to choose a location for the record.

2. Click the cog icon ( ) to add a new directory or record ( ), or to rename ( ) or delete ( )

an existing local directory.

Page 19: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 19

3. Clicking on the ‘Add a new directory or record’ icon ( ) brings up a list of the directory and

record types that can be added to that location in the content hierarchy. Click on the record or

directory type you require or on ‘Cancel’ to choose another location.

Record editor: selecting a record type

If you select a directory type, you must enter a title for the directory in the field that appears in the

content hierarchy and save it by clicking the file icon:

Record editor: entering a directory name

Selecting a record type opens the content editing panel. The type of record selected is shown at the

top right of the editing panel.

Each record must have a title: this is used to identify the record and as the search term that will

identify the record.

Where the chosen record type can have a formulary status applied to it, this can be added by the

formulary status dropdown above the content editing panel.

Page 20: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 20

Local record editor: content editing panel

Editing an existing local record

To edit an existing local record, select it in the Local Record Editor content hierarchy and click the

title to open it in the editing tool. Alternatively, if you forget its exact hierarchy location, search for

the record title in the Audit trail and click the breadcrumb to open the record in the Local Record

Editor.

Saving a draft of a local record

You can save work in progress in the Local Record Editor by selecting the ‘Save as draft’ button at the

top of the screen. This will save it in the Review changes drafts section. To resume editing, select the

document link from the Review changes table.

Publishing a local record

You can submit a record for checking by selecting the ‘Submit for approval’ button, or, if you are a

Publisher or Administrator, you can publish it immediately using the ‘Publish now’ button.

Deleting a local record

When you select the ‘Recommend deletion’ button in the Local Record Editor, the item is not

deleted until the action has been confirmed in Review changes. Publishers and Administrators have

the option to ‘Delete directly’.

NOTE Although the formulary tree view on the left-hand side closely resembles the table of contents, it cannot be used to open BNF or BNFC records.

Page 21: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 21

3.5 Review changes The Review changes page is a workflow control to enable the review of locally-added information

before it is made available to clinical end-users. There is a separate Audit trail function which

provides a chronological view of editing actions as a way to check previous versions of a record.

‘Review changes’ comprises two tables; one shows content that is in draft and the other shows

content that is awaiting approval. For each entry, the list shows:

The name of the source formulary (not displayed for notes applied across formularies)

The item title, with a link to the item itself

The therapeutic use (where a formulary status has been applied)

The content type

The type of action that was taken

The formulary status

The name of the user who made the edit

The date of the edit

The list can be filtered by local content type using the checkboxes at the top of the list or searched

using the search bar at the top right of the list.

Selecting ‘Save draft’ in the Note Editor or Local Record Editor, adds the record to the Review

changes drafts with its status set to ‘Draft’. To resume editing, clicking on the title and then the ‘Edit’

link reopens the editor.

Selecting the ‘Submit for approval’ button in the Note Editor or Local Record Editor adds the record

to the Review changes table with its status set to ‘Submitted’.

3.5.1 Review submissions for approval A Publisher or Administrator can click on the title of an item submitted for approval to display the

content of the item and three reviewer action buttons: ‘Reject’, ‘Approve’ and ‘Edit’.

The Edit button opens the item in the editing tool. For a status change this tool will be the status

selector on the record page itself, where ‘Show pending’ will be visible in the Use and local status

box.

Page 22: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 22

3.6 Local document library The Local document library can be accessed from the button in the header bar and the link on the

home page of FormularyComplete. It provides:

A place to store documents that don’t have a place in the BNF content hierarchy

The ability to create your own hierarchical local formulary structure—for example, where

your local formulary is not organised around the BNF classification scheme

4 System manager guide: formulary settings, user accounts and

reports The Admin menu displayed to a user who has

been assigned the ‘Administrator’ role in the

system presents all the administration options

as live links:

Administrator functions list

4.1 Editing and publishing An Administrator has the same full editing and

publishing permissions as a ‘Publisher’ (see

above).

4.2 Manage formulary status

types FormularyComplete has three default

formulary statuses: On Formulary, Off

Formulary and Restricted. The name assigned

to a status is made visible to users on the drug

monograph and preparations screens by

hovering over the formulary status symbol.

The Manage Formulary Status admin screen

allows further formulary statuses to be determined locally and to be assigned symbols. Existing

formulary statuses can be deleted or made inactive. Clicking ‘Publish now’ applies the changes made

to the statuses.

Page 23: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 23

Formulary status types manager

4.2.1 Active/Deactivated formulary statuses Setting an active formulary status to ‘Deactivated’ removes it from the selectable status options.

Records that have already been assigned that status will retain it, although the status can no longer

be assigned to other records.

NOTE If you amend a status definition, your changes will be applied to all records the status has

been assigned to.

4.2.2 Deleting formulary statuses Clicking ‘Select for deletion’ opens checkboxes to select the formulary statuses chosen for deletion.

Clicking on ‘Delete selected’ will delete the selected statuses. Where a formulary status that has

been applied to formulary content is selected for deletion, FormularyComplete warns the user and

asks for confirmation of the delete command.

4.3 Admin user rights The Admin user rights screen displays a list of users who have admin rights assigned to them, the

level of rights they have been assigned, and whether their rights are active or inactive (controlled by

the account’s Administrator).

The admin user roles are:

Editor

A user with permission to create and edit local content and set formulary statuses. Changes made by

an Editor need to be approved by a Publisher or Administrator in order to appear on the site.

Publisher

A user with permission to publish local content for display to the other users of the system.

Publishers can create directories; make editorial changes without submitting them for approval;

approve/edit/reject changes submitted by an Editor; define formulary statuses; and access the Audit

trail report.

Administrator

Administrators can set and change system settings—for example, the selection of home page display

options and the assignment of other users’ roles. Administrators can also create and publish local

content on FC and approve changes made by Editors.

Page 24: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 24

4.3.1. Create admin user New admin users are added via a button in the top right-hand corner of the Manage users screen

and existing users’ details can be amended by clicking on the user’s name. Required fields are

marked by a red asterisk. New admin users will receive an email with a link, valid for 24 hours, asking

them to create a password for their account.

To remove a user’s admin rights, set their Status to ‘Inactive’ using the drop-down on the Edit user

screen. As an Administrator, do not attempt to downgrade your own admin permissions. Create

your replacement and then get him/her to downgrade your permissions once you’ve logged off.

4.4 Logo ‘Manage logo’ imports your organisation’s logo for display in the top right-hand corner of the site

header. It will appear with the same height as the FC logo on the left. For best results, the JPEG

image dimensions should be 265 x 43 pixels.

The logo area is principally intended for an emblem; please bear in mind that web graphics file

formats do not present lettering as sharply on the page as the font rendering engine that displays

HTML text. Note that if you replace a logo, you may need to refresh your home page to force your

browser to use the substitute.

Page 25: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 25

4.5 Formulary admin contact information Overwrite or add to any standing text showing on the ‘Manage contact information’ admin page to

set the local contact details displayed in the site page footer.

4.6 Public-facing formulary report configuration Please refer to section 2.4 above for a description of the summary reports.

The public-facing version differs from the internal version in that (a) the drug and product names in

the list do not link to records in the database; and (b) notes are not displayed unless they have been

ticked as ‘Public’ in the Note Editor. The ‘Manage public formulary report’ admin page lets you

choose which formularies the public may see and to limit the published lists to specific statuses.

To make these summary reports public, copy the public formulary report link from the bottom left of

the screen and post it on a publicly-viewable page on your own organisation’s website.

Page 26: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 26

4.7 Home-page noticeboard content The ‘Manage noticeboard’ admin page lets you place a panel on the home page for local

announcements. Give your noticeboard a title and then populate it using the editing tool. You can

then toggle its display on the home page using the checkbox in the bottom left-hand corner. Click

‘Save’ to commit changes to the site.

Page 27: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 27

4.8 Manage home page data feeds Content for the Alert feeds panel on the home page can be configured on the Manage feeds page; it

is not possible to remove the panel entirely.

Click ‘Add new’ and enter a reference name for the feed (NB your reference name will be

substituted on the home page by whatever the feed issues as its title), then enter the URL of a RSS or

Atom feed and the maximum number of records to show (the default is five), and click ‘Save’.

To remove a feed that has been added, select it in the checkbox in the first column, then click

‘Remove’ and ‘Save’.

4.9 Formulary name The ‘Manage formulary name’ admin screen allows the Local formulary to be renamed. If you want

to ‘hide’ the local content there is a tick box on this page.

4.10 BNF content updates and formulary notes conflicts Local content can lose its place in the BNF or BNFC content structure during a regular content

update as the result of changes made by the BNF editors, as well as at any time when a formulary

author or Publisher removes a directory that has been added locally.

The BNF content updates and formulary notes conflicts report shows all locally-added content

(formulary statuses, notes and records) that was assigned to BNF or BNFC records that were

removed by a monthly content update. This report should be inspected after each update.

By default, the report shows all records that have been removed from FormularyComplete. Clicking

the ‘Having local content’ checkbox displays only the records that had local content assigned to

them.

Page 28: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 28

Clicking on the ‘ ’ symbol in the User-defined content column displays the content for that entry.

Once the entry is displayed, clicking on the pen icon opens the Note Editor so that the removed

content can be reassigned elsewhere in the BNF or BNFC content hierarchy.

4.11 Audit trail All editorial activity is logged in the ‘Audit trail’, which provides a variety of filters to allow a

Publisher or Administrator to investigate aspects of past editing work and a search field to call up the

history of specific records.

All status change actions are classed as ‘Amend’. There is no audit trail for the review of content that

was submitted for admin approval. It is possible to infer the result of a review by checking what

action took place after the content was ‘submitted’.

Page 29: FormularyComplete - Admin User Guide › wp-content › uploads › 2018 › 06 › FormularyCo… · FormularyComplete Admin User Manual May 20180525 v1 5 2.2.1 Search results screen

FormularyComplete Admin User Manual May 20180525 v1 29

5 Support

5.1 Account enquiries For account or subscription queries, please contact your account manager at Pharmaceutical Press.

Royal Pharmaceutical Society

66–68 East Smithfield

London

E1W 1AW

Tel +44 (0) 20 7572 2266.

5.2 Technical assistance Additional information on using the product is available at our support site

https://pharmpress.zendesk.com, where you can search for articles on software issues or report a

problem. You’ll need to register with the site with your email and a password in order to use it – this

helps protect it from spam. Any user of FormularyComplete can use the support service, but it is

normal for support requests to be submitted to us through a local system Administrator.

In terms of issue reporting please include as much information as you can when you report it.

Screenshots are invaluable in terms of being able to understand issues reported and it is always

worth noting the details of any browser in use if the query relates to a digital service

If you can’t use the web form to log a request, you can email [email protected]

instead.