Configure consent PDF

Introduction:

From v7.1, it is possible to configure the consent PDF, which users can download after filling the consent/survey form. Users can set up the headers, footers and also able to add the table, which contains the patient information like name, collection protocol details, etc.

User needs to be well-versed with HTML to configure PDF settings. The HTML files can be created by hand or using online editors like this

Configure Print PDF (Headers/Footer)

OpenSpecimen allows importing the HTML format document to which control the consent printing PDF. Users can configure that in the individual consent form and can configure it in a setting(system level) that is applicable for all the consent forms.

How settings print template vs individual print template works:

  • When the print settings are missing in the consent document then the system-level settings are used.

System-level Print Setting:

Steps:

  1. Go to the 'Home' page.

  2. Click on the ‘Settings’ tab.

  3. Search for 'Consent Document' as below

  4. Upload the HTML file you created to configure the consent PDF.

Below are the details to create the HTML document to set up the printing consent PDF.

The System-level and Consent document level configuration is similar. It just when adding in system setting you need to uplaod the html in setting tab where as at consent document level you need to speified the print setting in consent document it self.

The consent form PDF is designed in HTML since it gives us the flexibility of easy formatting.

We can configure the below things in PDF.

  1. Header

  2. Add a table with the patient and other information.

  3. Footer

Example: Refer to the below HTML document and PDF (System-Level HTML and print example)

Consent document level print document and HTML example:

Configure headers

Below is the code block to set up the header in the consent PDF.

Example1: Configure the university logo on the header

1 2 3 4 5 6 7 <ec-page-header> <div class="clearfix" style="border-bottom: 1px solid #ddd; position:relative;height: 70px; background: "#fff"; display: inline-block; width: 100%; padding: 8px 8px;"> <div style="float: left;"> <img style="position: absolute; z-index: 1000; height: 60px; width: 450px;" src="https://specimen-test.irvinginstitute.columbia.edu/logo/RS2133_RS460_Columbia_CUIMC_H_B_RGB_A.png"> </div> </div> </ec-page-header>

In the above code, the user can add the university logo in the header using the 'src=' tag.

Screenshot:

Example2: Configure the page numbers using the below example

1 2 3 4 5 6 7 <ec-page-header> <div class="clearfix" style="position:relative;height: 70px; background: #205081; display: inline-block; width: 100%; padding: 8px 8px;"> <div style="float: right; color: #fff;"> <span>{{currentPage}} / {{totalPages}} </div> </div> </ec-page-header>

Screenshot:

Configure the patient and other information

Users can add the patient details like name, collection protocol details, PPID and registration date, consent document version, etc. on the print consent document using the below code block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 <ec-doc-preamble> <h3 style="text-align: center;"> {{ectx.docVersion.title}} - v{{ectx.docVersion.version}} </h3> <hr> <table> <tbody> <tr style="width: 50%; padding: 4px 4px;"> <td style="width: 33%; padding: 4px; font-weight: bold">Name</td> <td style="width: 33%; padding: 4px">{{cpr.participant.firstName}} {{cpr.participant.lastName}}</td> </tr> <tr style="width: 50%; padding: 4px 4px;"> <td style="width: 33%; padding: 4px; font-weight: bold">Collection Protocol</td> <td style="width: 33%; padding: 4px">{{cpr.cpShortTitle}}</td> </tr> <tr style="width: 50%; padding: 4px 4px;"> <td style="width: 33%; padding: 4px; font-weight: bold">PPID</td> <td style="width: 33%; padding: 4px">{{cpr.ppid}} </tr> <tr style="width: 50%; padding: 4px 4px;"> <td style="width: 33%; padding: 4px; font-weight: bold">Registration Date</td> <td style="width: 33%; padding: 4px">{{cpr.registrationDate | date: global.dateFmt}} </tr> </tbody> </table> <hr> </ec-doc-preamble>

Screenshot:

Configure the footers

Users can configure the footer similar to heders with the university logo, page number, etc. Refer to the below code block to set the footer.

1 2 3 4 5 6 7 8 9 10 <ec-page-footer> <div class="clearfix" style="border-top: 1px solid #ddd; position:relative;height: 70px; display: inline-block; width: 100%; padding: 8px 8px;"> <div style="float: left;"> <img style="position: absolute; z-index: 1000; height: 60px; width: 300px;" src="https://specimen-test.irvinginstitute.columbia.edu/logo/cumc_stamp.png"> </div> <div style="float: right; color: #666;"> <span>- {{currentPage}} of {{totalPages}} - </span> </div> </div> </ec-page-footer>

In the above example, we configured the image in '<img' tag and page number in '<span tag>{{currentPage}} of {{totalPages}}'

Screenshot:

When the user downloads the consent form after filling it, they might notice that they need some information on a new page in the print document, or perhaps they want to move the content from the second half-page to the next page, etc.

Example: In the below example, the last line of the first page splits between page 1 and page 2. In that case, we need to add the print-page-break so that line should move to the next page.

Steps to add the print-page-break in the consent documents:

  1. Go to the Home -->'Collection Protocol' overview page.

  2. Click on the 'Cosents' tab.

  3. Download the consent document which you want to configure for a print page break.

     

  4. Open the downloaded consent document HTML in the editor.

  5. Search the text where you want to add the page break HTML tag. In the above PDF screenshot, I want to add the page break after '3. We may contact you …..' text, so from that line, all the text will move to the next page.

  6. Once you search the line, add the '<ec-print-page-break></ec-print-page-break>' tag before that line. See the below example.

     

  7. Save the updated HTML document.

  8. Go to the 'Collection Protocol Overview → Consents tab.'

  9. Update the consent document

     

  10. Go to the participant overview page → Consents → (Refresh the browser) → Print the filled consent form. Now you will be able to see the changes in the print PDF file.

     

Screenshot after adding the print-page-break

 

Refer the below example PDF and consent document