Writing a TB lab user manual for LIS data entry shortcuts
Writing a TB lab user manual for laboratory information system data entry shortcuts turns routine keyboard actions into a controlled part of specimen registration, result capture and reporting. In Australian tuberculosis (TB) laboratories, the manual should explain how staff use the LIS, sometimes called a laboratory information management system (LIMS), without creating hidden workflows or faster routes to incorrect results. Describe the authorised action, the screen where it works, its effect on data and how to recover from mistakes.
The manual belongs within the GLI Quality Tool’s four-phase roadmap for building a laboratory quality management system and its twelve Quality Systems Essentials. Documentation, personnel competency, equipment and continual improvement all affect shortcut instructions: a polished document is of little value if staff cannot apply it or the shortcuts are not reassessed after a software change. Phase-specific checklists, user instructions and downloadable materials provide a sound structure for drafting, reviewing and maintaining the guide.
Australian workflows add practical context. TB services in Sydney, Melbourne, Brisbane and Perth may receive specimens from several interstate laboratories, while state and territory teams operate under different notification and reporting arrangements. International clinical specimens and reference isolates entering through Australian airports may involve Australian Border Force customs and biosecurity processes, permits and approved transport packaging. The manual should show how an electronic laboratory record stays traceable when a specimen crosses a border, a laboratory network or a public and private laboratory interface.
Set the purpose and boundaries
Begin by identifying the LIS product, version and workstation setup, then define the roles covered: data entry officers, supervisors, result validators and LIS administrators. State whether the document covers one laboratory, a network or several sites. Use screenshots only where they clarify a step, and remove real patient identifiers from every example.
If paper TB records are becoming electronic, use the GLI Quality Tool’s manual-to-digital transition guide to map processes before describing new keystrokes. Cover specimen receipt, accessioning, test ordering, result authorisation, amendments and reporting, with responsibility for each handover. This prevents the guide describing the destination while omitting controls needed to reach it.
Separate standard LIS functions from locally created macros and personal text-expansion tools. Such tools can behave differently on another workstation and sit outside the validated laboratory information system. Mark them unapproved for clinical data entry unless the laboratory has assessed, documented and authorised them.
Map shortcuts to the specimen pathway
Organise the manual around the TB specimen pathway, not the keyboard. Follow accessioning and patient identification through smear, culture, nucleic acid amplification testing (NAAT) and drug susceptibility testing to report authorisation. At each step, identify the screen, required fields, common errors and permitted shortcuts.
For every shortcut, record the key combination, purpose, applicable screen, permission level, expected outcome and recovery method. Explain what happens after the keys are pressed, whether the record is saved and whether confirmation is required. This detail supports training, competency assessment and later audits of the electronic laboratory record.
Give examples only after confirming them in the deployed system. A workstation-specific F3 shortcut might open the test-request search, Alt+Down might open a validated result list, Ctrl+S might save, and Ctrl+Enter might advance to the next required field. Tie these examples to named screens and verify them rather than presenting them as universal commands.
Write safe and unambiguous instructions
Use short, action-led paragraphs followed by verification. “Press Ctrl+S to save the active record, then check that the status changes to Saved” tells the user what to do and how to confirm success. Distinguish editing from submitting a result, because the same keystroke may have different effects on different screens.
Explain navigation consistently. Tab and Shift+Tab move through fields; Alt+Down opens a selection list only when that list is active. Warn against using Ctrl+A instead of checking the selected record, because it can select beyond the intended field. Never redefine operating-system commands such as Alt+F4, and document laptop Fn-key behaviour where relevant.
State which shortcuts work in the LIS, which work only in a report viewer and which are disabled during result authorisation. Note remote-access, Citrix or virtual desktop settings that change key handling. Staff must not use shortcuts with contaminated gloves or bypass positive patient identification, specimen-label checks and other laboratory safety controls.
Protect data integrity and patient identity
Treat identifiers and results as separate protected data. A shortcut may retrieve a specimen accession format, but it must not copy a previous patient’s name, collection date or result into a new record. Prohibit copy-forward shortcuts for results unless the LIS enforces review rules and retains an audit trail of copied fields.
Describe access controls beside the keystrokes: individual logins, role-based permissions, password rules, session timeouts and multi-factor authentication where supported. Explain that the Privacy Act 1988 and applicable state or territory health records legislation apply, while TB notification duties must be checked against the relevant program. Never include passwords or real patient records in the manual.
Set rules for ambiguous dates, free text and corrections. Use an unambiguous example such as 14 Mar 2025 and identify the LIS display and export formats. Turn off spellcheck for result fields where it could alter clinical terms. Corrections to authorised results must preserve the original entry and record the reason, authoriser and timestamp.
Test, pilot and support the workflow
Pilot shortcuts with synthetic records in a test environment before clinical use. Include long names, similar identifiers, multiple orders, missing optional fields, rejected values and different result states. Test with experienced users and new employees, because a shortcut that appears obvious to one person can be ambiguous to another.
Record the software vendor, application version, build, local configuration and device settings. In the Australian market, a public health laboratory may operate a locally supported LIS while a private pathology provider uses a commercial platform, making universal assumptions about function keys unsafe. Give staff a clear contact route for application problems and identify which key combinations are authorised.
Plan for downtime and interface failures. A controlled paper summary can support continuity, but it must not become an untracked parallel register. Define how staff identify downtime records, re-enter them after recovery and reconcile them against laboratory information system reports and interface queues. Protect any local cache containing TB data and document secure deletion.
Train staff and control document versions
Build shortcut guidance into induction, role changes and competency assessment. Ask trainees to perform a task, verify the saved record and explain the consequence of an incorrect keystroke. Observers can assess speed alongside compliance with specimen identification, result authorisation and amendment procedures. Retain training materials, assessed competency records and coaching notes.
Give the manual a named owner, such as the LIS super-user with the TB quality manager, and an approval route through quality and information governance. Each release needs a version number, effective date, review date and change log. Store the master in an access-controlled location, distribute it through the laboratory intranet and control printed copies so superseded pages cannot circulate.
Review the manual after upgrades, workstation replacements, new tests, new sites and data-entry incidents. Ask whether shortcuts match actual practice, then remove undocumented workarounds or promote validated ones through change control. Audit logs, rejected values and staff feedback can reveal shortcuts that save time while increasing downstream work.
Link the manual to quality improvement
Use the manual as evidence within the GLI Quality Tool roadmap, not as an isolated reference. Cross-reference relevant phase-specific checklists for documentation, personnel, equipment and assessment, and include its identifier in training and competency files. During internal audits, sample records to confirm that staff applied current instructions and that electronic entries match authorised results.
Track repeated corrections in required fields, rejected values, time spent resolving key conflicts and shortcuts that staff bypass. Discuss these at the quality meeting and assign actions through the laboratory’s corrective and preventive action process. Focus on causes and system changes, because retraining alone will not fix an inconvenient or unsafe key assignment.
Start with one high-volume, low-risk task, such as opening an existing test request, and test it with experienced and new staff before expanding. Document the approved keys, train users, publish the controlled version and schedule a review after software changes. Share tested comments through the feedback page, then use them to refine future editions.