Create tumor reporting templates as dynamic Web forms on a Web platform.
Novel application of a modern software technology for ordinary Web users
Helpful tips on using the Web Platform
Q. I am not a tech person. Please explain the key jargon.
A. Excellent suggestion. Here are they ... ...
Web platform - The Web page where users can get sample files, built forms and file pathology reports.
Form component files -- The text files (.json, .txt, etc) that contains information of data elements (in the form of json) of a Web dynamic form. These files are the building blocks of the Web dynamic form. Simply upload these files to the Web platform, and you'll see the form right away. You use these files to build Web dynamic form.
Web dynamic form -- A Web form that "responds" to the inputs by Web users. Users can enter information via dropdown lists or typing. Our dynamic form can generate a final report that only exhibits data entered by the user. In contrast, a static form only allows users to view information. You use Web dynamic form to collect data into a final report.
(Final) report -- A report contains all information collated by the user via the Web dynamic form. This is the final product of the entire Web operation. The final report only displays the collected data. The report is static, meaning it cannot be changed. To make any change of its content, you have to go back to the page of the Web dynamic form. You view the collected data in the final report and transfer the content off the Web (e.g. to the laboratory information system).
Reporting templates -- A template contains a set of information specific for a scenario. For example, a template for reporting breast cancer cases, or one for job application. Another implied attribute of the template is re-usability for its specific scenario category. Since we use a Web form instead of a text document to collect user responses, we have to convert the text document file into a Web dynamic form via our Web platform. Thus, the template could mean either a text file ("back-end") and a Web form ("front-end"). They are the same thing.
Template library -- A library is a collection of templates / dynamic forms. Since the templates can be downloaded and stored in a local computer or in Cloud, users can collect templates for different reporting needs, i.e. built their own library. This becomes very handy when needed, i.e. you can re-produce a desired Web dynamic form by finding the template in your library and upload it to the Web platform. You store all of the templates in a library and use the library to quickly re-produce the desired Web dynamic form for tumor reporting.
Q. Is there any quick way to make the form?
A. The quickest (and most efficient) way is via modifying an existing template/form file. You can download from the platform page the "Breast Core Bx" and modify it to make a short template/form for biopsy cases. Similarly, download "Colectomy" and modify it for resection cases. To download, just click on the listed items on the platform page.
The safest way to be sure that your modification of the code file actually works is to save & upload the modified file to the platform FREQUENTLY for testing. It only takes a few seconds.
Q. Why sometimes a downloaded file does not show up in the form?
A. The items (data elements) of template files with the same name do NOT work on the platform. You cannot have two data elements with the exact same name (syntax), e.g. "Tumor size" and "Tumor size". Appending a character (e.g. Tumor size - 2) solves the problem. This is the same as in a computer folder -- no files in the same format (e.g. pdf or doc, jpg, etc) can have the same file name.
Q. How are different form components ordered in the Web form?
A. In general, the file loaded (to the platform) first should show up at the top of the Web form. Give a few tries to confirm/figure it out.
Q. I uploaded a sample file to the "Form JSON" box, but nothing happens?
A. You must have dragged the file from the list on the Web directly to the Form JSON box. The files have to be downloaded first to your local computer! Please try to download it first. Then upload back to the Web platform. If this does not help, the file must be corrupted or incorrectly modified.
Q. What's that .jsn (instead of .doc)? Why?
A. Good question! JSON stands for JavaScript Object Notation, a file format. You can also open and save the json file in a Notepad (as .txt). The file should work just fine. All computers should have the Notepad tool. You can also use WordPad. Just right-click on the downloaded file and select Notepad or WordPad from "Open with ... ". However, if you use a json editor (software tool), it's easier since the editor may show line number, highlight matching brackets (a key feature), etc. This is an example of an on-line editor.
Q. Which file format is recommended, json, txt or else?
A. It's a personal preference. Template files with .json and files with .txt extension can be used together or interchangeably on our Web platform to create the Web dynamic form.
Comments