Dynamic fields in LSM for result/invoice/CoC/batch report templates? - LabCollector

Knowledge Base

Search Knowledge Base by Keyword

Dynamic fields in LSM for result/invoice/CoC/batch report templates?

You are here:
← All Topics
SUMMARY:

Lab Service Manager (LSM) add-on is the perfect application for service core & test labs.

It also helps you to create & customize templates for reports when a job is finished. You can easily export a report in PDF format as soon as you complete a job (test).

Moreover, you can use the “dynamic fields” to enter in your report templates. These dynamic fields will help you insert automatically the values/results/patient/sample, etc information, when a job is complete.

Follow the steps below to create and use dynamic fields in LSM:-

1. LSM report creation

2. Dynamic fields

  • Results template / Processing template
  • Invoice template
  • CoC report template
  • Batch report template
  • Dynamic tags

1. LSM report creation

  • In order to create a report you need to go to LSM -> ADMIN -> PREFERENCES -> REPORTS & INVOICE TEMPLATES.
  • You will see the below page.
    * NOTE:
    Please note that the below page is pre-configured so you can see many templates on the left-hand side. During the first time login, it will be empty on the left-hand side with just one general template.

  • 1. By clicking here you can create a new template.
  • 2. When you create a new template you need to add the name and a short description of the report like in the above image.
  • 3. Here you can edit your content using the rich text editor. *Please read our KB to see how to create a result report and invoice template & view it after a job is finished.
  • 4. As when you finish the report, you can click on pdf which will open in a new tab of your browser and show you the preview of your report.
  • 5. By clicking here, you can choose the template for COC, Batch, and results.
         *Please our KB on how to create a job from LSMremote to create a CoC. section 4
  • 6. when you click on this option you see the dynamic fields, that you can use in your report like in the image content.

2. Dynamic fields

– As mentioned above dynamic fields help you to make your report making the process easier.

– When you click on this option, a popup will open on the left-hand side of the browser page and you will see the list of dynamic fields, like below.
 

 

– Dynamic fields for each purpose are explained below.

  • Results template / Processing template

    • Fields here can be used for a template for result reports like a blood test, COVID test, or a urine test.
    • The processing report is done when you are processing your tests. For example, you are doing an experiment for RTPCR and your processing parameters can be the purity of DNA, the master mix preparation with various enzymes, etc. Some companies with regulatory compliance need to have such processing reports. You can choose the processing template when you create a test. *Please check our KB on how to create a test.

1.

##results##

Will be replaced by results narrow table

 
  • This option will show the result parameters used in the test. It will also show Values, unit, phrase, and range.
  • *NOTE: The parameters will have options that you created while creating the parameters.
    – In the below option we have created 2 parameters for example purpose; with value list (positive & Negative), unit (UI/ml), Phrase (if positive…, if negative…), and range.
    – *To know more please refer to how to create parameters.
    – *Please read our KB to know more about how to create reports.

  • NOTE: All the below dynamic fields are explained in the same manner with the dynamic field in report->followed by completion of job->job-options-report-pdf.

2.1

##results_extended##

Will be replaced by results wide table [This option will show the name of the test, parameter, result values, range (criteria), units, and evaluation (phrase)]

2.2

##results_merged##

 Will be replaced by results wide table, without break by sample (This option will display the test name for each parameter, result values, unit, evaluation (phrase), the date & time on which the job was completed.)

 

3.

##process_extended##

Will be replaced by processing parameters table

  • This dynamic field can be used for the “processing reports”.
  • These reports are made up of pf parameters that are required while performing the experiment. For example, for PCR reaction the processing parameters could be the master mix preparation.
  • You can also create a report dedicated to the processing parameters as these reports can be required by institutes to check if the tests were performed correctly.
    – *Please read our KB to know more about how to create reports.
  • In the below image we created the processing parameters for the Rt-PCR reaction as an example and used the dynamic field to show in the report.

 

4.

##details## 

Will be replaced by results detailed table [This option will display the sample ID, number, type, comment for sample (while creating the job), parameter name, values for results, unit, evaluation (phrase) name of the test, name of the user level who created the job, and the date of report generation]

 

 5.

##matrix##

Will be replaced by results matrix 

  • This option will show you the sample ID, number, test name, input parameter value, and result parameter names and values.
  • The input parameter is added before you start the test. For example, before starting the RT PCR, RNA purity (260/280 ratio) is checked before the CDNA step and then the cDNA purity is checked for the RT PCR procedure, as an impure nucleic acid can affect the PCR results.

 

 6.

##samples##

Will be replaced by a samples list (This option will display sample ID, number, name of the test/s, name, and values of the parameters in the results.)

 

7

##requester_name##

Will be replaced by requester name (LSM -> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

8

##requester_address##

Will be replaced by requester address (LSM -> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

9

##requester_email##

Will be replaced by requester email (LSM -> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

10

##requester_company##

Will be replaced by requester company (LSM -> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

11

##job_number##

Will be replaced by job number (While creating the job)

12

##job_date##

Will be replaced by job date (While creating the job)

13

##job_end_date##

Will be replaced by job end date (after the job is in validated and is seen under “Approved” stage)

14

##job_id##

Will be replaced by job identifier (under the job list, each job will have a by default created ID)

15

##job_submitter##

Will be replaced by the job submitter’s name (Person who created the job)

16

##operator_name##

Will be replaced by operator name (Person who performed the tests in the job)

17

##validator_name##

Will be replaced by validator name (Person who validated the job, for example like lab supervisor)

18

##report_number## 

Will be replaced by report unique identifier (After the Job is in “Approved” status, a generated report contains a number along with the barcode specific to the report.)

19

##today_date##

Will be replaced by report generation date (Date when the report was generated.)

20

##labname##

Will be replaced by lab name (You will see the lab name, in the browser URL or your LC server manager)

21

##case_record##

Will be replaced by case record name (It can be, for example, patients name or animal name  or any record name in any custom module)
– *Please read our KB to know more about how to activate case records.

22

##case_gender##

Will be replaced by case record gender (It can be, for example, patients gender or animal gender  or any record gender in any custom module)
– *Please read our KB to know more about how to activate case records.

23

##case_dob##

Will be replaced by case record Date Of Birth (It can be, for example, patients DOB or animal DOB  or any record DOB in any custom module)
– *Please read our KB to know more about how to activate case records.

 

  • In the report that you create you can have various information to add.
  • One of such information is usually about the details for the requester of the test (can be a hospital ora clinic who receives samples), or patient-related information, job date or sample collection date, etc. 
  • All of such options (7-23) are shown below in the report image example.

 24

##sample_number##

Will be replaced by sample number (under the job list -> sample level; each sample will have a by default created ID)

 25

##sample_name##

Will be replaced by sample name (When you create a job and add sample rows, either you can rename the sample or they will have a default created number)

 26

##sample_type##

Will be replaced by sample type (When you create a job and add sample type if it is blood, tissue, swab, etc)

 27

##sample_comment##

Will be replaced by sample comment (When you create a job and add comments for the sample)

 28

##sample_id##

Will be replaced by sample id (under the job list -> sample level; each sample will have a by default created ID)

 29

##samples_line##

Will be replaced by samples list in a line (When you create a job and add sample rows, each sample name will be shown here)

 30

##received_date##

Will be replaced by sample received date (When you create a job and add if you have received the sample and the date and time)

 31

##completed_date##

Will be replaced by the sample completed date (When your job is in “completed status” that date is completed date. You can also choose the option “Save & complete” when you are executing a job. This date will be the “completed date”)

 

  • Options 24-31 will provide you with all the details about the sample.
  • For example like below image.

 32 

##job_param##

Will be replaced by job custom parameters (These are the parameters you create at the “Job level”).
(LSM->ADMIN -> PREFERENCES->PARAMETERS
)
– *Please read our KB to know more about how to create parameters.

 33

##protocols##

Will be replaced by protocols list (This will be the protocol name and its description.)
(LSM->ADMIN -> PREFERENCES->PROTOCOLS)
*Please read our KB to know more abouthow to create protocols.

 34

##protocol_name##

Will be replaced by protocol name (This will be just the protocol name separated by a comma.)

 35

##protocol_description##

Will be replaced by protocol description (This will be just the protocol description separated by a comma.)

 36

##reagents##

Will be replaced by reagents list (This will show a table with the test, reagent list, quantity.)
(LSM->ADMIN -> REAGENTS)
*Please read our KB to know more about how to create reagents and equipment in LSM.

 37

##equipments##

Will be replaced by the equipment list (This will be replaced by the test name, protocol name, equipment category & name, upcoming maintenance of the equipment, and it’s brand and model.)
(LSM->ADMIN -> EQUIPMENT)
*Please read our KB to know more about how to create reagents and equipment in LSM.

 38

##test_name##

Will be replaced by test name name 
(LSM->ADMIN -> PREFERENCES->TESTS)

 39

##tests_line##

Will be replaced by tests list in a line (this is the case when you have many tests for one sample separated by a comma)
(LSM->ADMIN -> PREFERENCES->TESTS)

 

 

  • Invoice template

    • Fields here can be used for a template for creating quotes, invoices, or purchase orders.
      *Please see the KB on how to create invoices.
    • The invoice details can be added by going to LSM->ADMIN -> PREFERENCES ->COSTS.

1.

##details##

Will be replaced by invoice details (It will show details in a table format with test code, name, sample type, amount of samples, fixed price, hours, hourly price, line total showing the calculation based of defined costs in LSM->ADMIN -> PREFERENCES ->COSTS)

2.

##requester_name##

Will be replaced by requester name (Will be replaced by requester name LSM-> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

3.

##requester_address##

Will be replaced by requester address (Will be replaced by requester address LSM-> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

4.

##requester_email##

Will be replaced by requester email (Will be replaced by requester name LSM-> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

5.

##purchase_order##

Will be replaced by job purchase order (Will be replaced by purchase order number)

6.

##tax_number##

Will be replaced by a requester tax number (Will be replaced by the tax number you put in the requesters billing address details)

7.

##job_number##

Will be replaced by job number (While creating the job the number will be assigned to the job)

8.

##job_id##

Will be replaced by job identifier (While creating the job an ID will be assigned to it automatically)

9.

##job_date##

Will be replaced by job date (While creating the job will be considered as job date)

10.

##job_submitter##

Will be replaced by the job submitter’s name (The person who creates or submits the job)

11.

##invoice_date##

Will be replaced by invoice date (You can add the invoice date by going to LSM->ADMIN -> PREFERENCES ->COSTS)
*You cannot add the invoice date when the invoice status is pending.

12.

##invoice_number##

Will be replaced by invoice number (You can add the invoice date by going toLSM->ADMIN -> PREFERENCES ->COSTS)

13.

##case_record##

Will be replaced by case record name (It can be, for example, patients name or animal name  or any record name in any custom module)
– *Please read our KB to know more about how to activate case records.

14.

##case_gender##

Will be replaced by case record gender (It can be, for example, patients gender)

15.

##case_dob##

Will be replaced by case record date of birth (It can be, for example, patients date of birth)

16.

##protocols##

Will be replaced by protocols. (This will be the protocol name and its description.)
(LSM->ADMIN -> PREFERENCES->PROTOCOLS)

17.

##protocol_name##

Will be replaced by protocol name  (This will be just the protocol name separated by a comma.)

18.

##protocol_description##

Will be replaced by protocol description (This will be just the protocol description separated by a comma.)

 

* If its a quote you will see a watermark for the quote and when it is paid the quote will have no watermark.

1

##details##

Will be replaced by Chain of Custody (CoC) list (It will show the sample name, number with the barcode, test name, token number [under type], name of the patient, gender, and Date of birth and when the sample was received including time. It will also include the date and time the CoC will be generated).
*Please see our KB check on how the token number can be used to access the report directly by the patient.

2

##requester_name##

Will be replaced by requester name ( LSM-> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

3

##requester_address##

Will be replaced by requester address ( LSM-> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

4

##requester_email##

Will be replaced by requester email ( LSM-> ADMIN -> PREFERENCES -> CONTACTS -> REQUESTERS)

5

##job_number##

Will be replaced by job number (While creating the job the number will be assigned to the job)

6

##job_date##

Will be replaced by job date (While creating the job will be considered as job date)

7

##job_id##

Will be replaced by job identifier (While creating the job an ID will be assigned to it automatically)

8

##job_submitter##

Will be replaced by the job submitter’s name (The person who creates or submits the job)

 

  • Batch report template

    • Fields here can be used for a template for the batches.
    • This report is important in scenarios where you run 100’s of tests every day in form of batches.
    • A batch report can help you see all the samples in the batch and tests performed.
    • To create a batch report go to  LSM-> JOB LIST -> GROUP BY -> BATCH-TEST-SAMPLE -> OPTIONS -> Report -> PDF

1.

##details##

Will be replaced by batch samples list (This option will show sample ID, test name, equipment used, requester-lab requesting the test, and the date/time the report was generated on.)

2.

##batch##

Will be replaced by a batch (This will show the batch name.)

 

  • Dynamic tags

    • You can use these custom tags in your report.
    • For example, if you made a parameter at a job or sample level and you want that parameter to appear in your report. All you have to do is add ## sign around the parameter name.
      Any parameter can be used as tag adding ## around it. e.g. ##tag_name##
      For case record fields prepend case_. e.g. ##case_field_name##
    • Once you complete the job and create a report for the job, the values you put for parameters will appear in your report.
      * Take care that the tags are case & space sensitive, so write them exactly as you have written them in parameters.

 

Related topics: