Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update link to go to OpenMRS Add-ons index instead

Table of Contents

Table of Contents

Overview

Adds ability to design and print identification cards.

Download

Administration

  • Generate id numbers
    • By default, feature is enabled. Hide this feature by toggling the global property setting (formerly  global property from platform 1.8 downwards): idcards.enableIdentifierGeneration = false.
    • Allows an admin to create a list of numbers to be used when printing "empty id cards".
    • Page options:
      • Start value: The first number to start with
      • Size: The number of identifiers to generate
    • Requires privilege "Pre-Generate Random Patient Identifiers"
  • Print Empty Id Cards
    • This page has two sections that can be enabled. The first section is enabled by default, and allows for new cards to be printed from identifiers generated by the module. The next section is not enabled by default, and allows for cards to be printed from identifiers uploaded from file.
    • if idcards.enableIdentifierGeneration = true
      • Allows a user to put generated identifiers onto cards without putting names onto them. This is useful when cards will be distributed to remote locations.
      • Page Options:
        • Number: The total number of cards to print
        • Id numbers
          • None – all identifiers printed will be zeros
          • Pregenerated – numbers will be taken from identifiers that were created with the 'Generate id numbers' page
          • Range – Random identifiers taken from within the range defined in the global properties (see below)
        • The template with which to print the id cards (Only templates with type of "Print New Identifiers" or "Blank" or "" will be listed here)
        • A password that the output pdf will be encrypted with (used to try to prevent duplicate printing of the pdf files)
      • Requires "Print Id Cards" privilege
    • If idcards.enablePrintingUploadedIdentifiers = true;
      • Specify a file of identifiers (one identifier per line).
      • Specify a password as above
  • Reprint Id Cards
    • Allows a user to print cards for patients' current identifier
    • Requires the "Reprint Id Cards" privilege
  • Manage Templates
    • Allows an admin to edit what the cards look like
    • Requires the "Manage Id Card Templates" privilege
  • Global property settings
    • idcards.generateMin
      • The lower bound number used when "Printing Empty Id Cards"
    • idcards.generateMax
      • The upper bound number used when "Printing Empty Id Cards"
    • idcards.enableIdentifierGeneration
      • Hides / displays all UI elements which do identifier generation in the idcards module
    • idcards.enablePrintingUploadedIdentifiers
      • Hides / displays a new form for printing identifiers that are uploaded from a file
    • idcards.fopConfigFilePath ( as of 1.3.2)
      • The absolute file path for the Apache FOP configuration file. 

...

Example:  I create font metrics files following the Apache FOP documentation.  In my fop config file, I add entries for normal and bold Kh Battambang fonts. The font might not be installed on the desktop machine at the registration desk, so I include the embed-url, so the font information is included in the PDF file.

No Format

        <font metrics-file="file:///Library/Fonts/Kh-Battambang-metrics.xml" embed-url="file:///Library/Fonts/Kh-Battambang.ttf" kerning="no" encoding-mode>
           <font-triplet name="Kh Battambang" style="normal" weight="normal"/>
         </font>
         <font metrics-file="file:///Library/Fonts/Kh-Battambangb-metrics.xml" embed-url="file:///Library/Fonts/Kh-Battambangb.ttf" kerning="no">
           <font-triplet name="Kh Battambangb" style="normal" weight="bold"/>
         </font>

...

Example:  I want the patient's name to be printed in Cambodian characters.  In Admin > Id Cards > Manage Templates, I edited the xslt for my card to say

No Format

<fo:block font-family="Kh Battambang" font-weight="normal">
<xsl:value-of select="name"/>
 </fo:block>

...