This user guide describes how to translate electronic Product Information (ePI) in Fast Healthcare Interoperability Resources (FHIR) XML format complying with the EU ePI Common Standard.
The guide outlines the parts of ePI that should and should not be translated. Translating only the indicated parts of the ePI will preserve the FHIR XML structure, which ensures that the translated file can subsequently be imported into the PLM portal.
This guide can also be used as a reference to create a custom XML file type in a computer-assisted translation (CAT) tool that extracts only the specified parts for translation.
Every document in the ePI (i.e., every SmPC, Annex II, Labelling, and PL) has a ‘Composition’ that contains the section names, subsection names and text (e.g., paragraphs, bulleted lists, tables).
Everything that the translator needs to work on is within the <Composition></Composition> tags.
The following elements of the Composition should be translated:
Composition language
The language value indicates the language of the document narrative text. It uses the IETF two-letter language tag for human languages.
Replace the language value attribute, for example “en”, with the IETF language tag of the target language of the translation. The required language tags for ePI are shown in Table 1.
Replace the language value in every Composition in the ePI.
Note: It is not mandatory to translate the display values. Confirm with the company requesting the translation whether a translation is desired.
Composition title (optional)
The composition title is the name of the ePI document chosen by the company. It could include proprietary/non-proprietary name(s), dose form, strength or any other details. It is not part of the official product information. It appears in the preview and editor pages of the ePI at the PLM portal.
Note: It is not mandatory to translate the composition title. Confirm with the company requesting the translation whether a translation is desired.
Section title
The title value of a section in the ePI is the same as the section/subsection name of the product information (QRD) template.
The text of a section is found within the <div></div> tags and contains the paragraphs, lists, tables and images of the section.
XTHML element
What to translate
Paragraph
xhtml content between <p></p> tags
List
Unordered list
Ordered list
xhtml content between <ul></ul> and <ol></ol> tags
Table
xhtml content between <table></table> tags
Image
References to images should contain alternative text describing the image.
When present, translate the alt attribute of the <img> element.
Table 2: What to translate in the section text
Do not translate, edit or delete tags (tags are in brackets <>) or attributes (attributes are in the format attributename="value") in the text, with the exception of the alt attribute mentioned above.
Escaped characters
To ensure ePIs are properly interpreted without breaking the XHTML/XML file structure, special symbols must be escaped. The required escape character sequences for the most common types of special symbols are shown in Table 3.
Special symbol
Must be escaped in section title, display value, alt text (attributes)?
Must be escaped in section content (xhtml content)?
Escaped form sequence
&
Yes
Yes
& or &
<
Yes
Yes
< or <
>
Yes
Yes
> or >
"
Yes
Not necessary
" or "
'
Yes
Not necessary
' or '
Table 3: Special symbols and required escape characters
When escaped characters are present in the source language, use the escaped form also in the translation. When working with a CAT tool, you may need to configure it to read entities as characters and write them as entities in the target file.
Example in English:
Example in Greek:
What not to translate
The following should not be translated:
Resources that are not in the Composition, i.e., anything outside the tags <Composition></Composition>
Tags and attributes, with the exception of those mentioned above.