Top Banner
Draft Guidance Document Validation Rules for Product Monographs in the Extensible Markup Language Format This guidance document is being distributed for comment purposes only. Draft date: 2019/05/15
43

Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

Jun 30, 2020

Download

Documents

dariahiddleston
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

Draft Guidance Document

Validation Rules for Product Monographs in the Extensible Markup Language Format

This guidance document is being distributed for comment purposes only. 

Draft date: 2019/05/15 

Page 2: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 2 

Health Canada is responsible for helping Canadians maintain and improve their health. It ensures that high‐quality health services are accessible, and works to reduce health risks. 

 

Également disponible en français sous le titre : Ébauche de la ligne directrice : Règles de validation des monographies de produit dans le format Extensible Markup Language  

 

© Her Majesty the Queen in Right of Canada, as represented by the Minister of Health, 2019 

Publication date: May 2019 

 

This publication may be reproduced for personal or internal use only without permission provided the source is fully acknowledged.    

Page 3: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 3 

Foreword 

Guidance documents are meant to provide assistance to industry and health care professionals on how to comply with governing statutes and regulations. Guidance documents also provide assistance to staff on how Health Canada mandates and objectives should be implemented in a manner that is fair, consistent, and effective. 

Guidance documents are administrative instruments not having force of law and, as such, allow for flexibility in approach. Alternate approaches to the principles and practices described in this document may be acceptable provided they are supported by adequate justification. Alternate approaches should be discussed in advance with the relevant programme area to avoid the possible finding that applicable statutory or regulatory requirements have not been met. 

As a corollary to the above, it is equally important to note that Health Canada reserves the right to request information or material, or define conditions not specifically described in this document, in order to allow the Department to adequately assess the safety, efficacy, or quality of a therapeutic product. Health Canada is committed to ensuring that such requests are justifiable and that decisions are clearly documented. 

This document should be read in conjunction with the accompanying notice and the relevant sections of other applicable Guidance documents. 

   

Page 4: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 4 

Table of contents 1 

1. Introduction ................................................................................................................................ 7 2 

1.1 Purpose/overview ................................................................................................................. 7 3 1.2 Scope and application ........................................................................................................... 7 4 

1.2.1 In‐scope .................................................................................................................................... 7 5 1.2.2 Out of scope ............................................................................................................................ 7 6 

1.3 Policy objectives .................................................................................................................... 7 7 1.4 Policy statements .................................................................................................................. 7 8 1.5 Background ............................................................................................................................ 8 9 

1.5.1 Extensible Markup Language (XML) ..................................................................................... 8 10 1.52 Health Level 7 (HL7) international ......................................................................................... 8 11 1.5.3 Structured Product Label (SPL) standard ............................................................................ 8 12 1.5.4 Structured document ............................................................................................................. 8 13 

2. Guidance for implementation ..................................................................................................... 8 14 

2.1 General technical conformance requirements ..................................................................... 8 15 2.1.1 Identifiers ................................................................................................................................. 8 16 2.1.2 Content changes ..................................................................................................................... 9 17 2.1.3 File type .................................................................................................................................... 9 18 2.1.4 SPL file name ........................................................................................................................... 9 19 2.1.5 External file references .......................................................................................................... 9 20 2.1.6 Codes ........................................................................................................................................ 9 21 2.1 7 Case sensitivity ........................................................................................................................ 9 22 2.1.8 Display name ........................................................................................................................... 9 23 2.1.9 Image quality ........................................................................................................................... 9 24 2.1.10 Date and time ...................................................................................................................... 10 25 2.1.11 Narrative text ...................................................................................................................... 10 26 2.1.12 General validation rules ..................................................................................................... 10 27 

2.2 XML prolog .......................................................................................................................... 11 28 2.2.1 Description ............................................................................................................................. 11 29 2.2.2 XML sample ........................................................................................................................... 11 30 2.2.3 Validation rules ..................................................................................................................... 11 31 

2.3 Document ............................................................................................................................ 11 32 2.3.1 Description ............................................................................................................................. 11 33 2.3.2 XML sample ........................................................................................................................... 12 34 2.3.3 Validation rules ..................................................................................................................... 12 35 

2.4 Market authorization holder and importer or distributor .................................................. 13 36 2.4.1 Description ............................................................................................................................. 13 37 2.4.2 XML sample ........................................................................................................................... 13 38 2.4.3 Validation rules ..................................................................................................................... 14 39 

2.5 SPL body .............................................................................................................................. 15 40 2.5.1 Description ............................................................................................................................. 15 41 2.5.2 XML sample – manufactured product section.................................................................. 16 42 2.5.3 XML sample – narrative text section.................................................................................. 16 43 2.5.4 Validation rules ..................................................................................................................... 16 44 

Page 5: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 5 

2.6 Manufactured product ........................................................................................................ 17 45 2.6.1 Description – manufactured product code and name .................................................... 17 46 

2.6.1.1 XML sample – manufactured product ............................................................... 17 47 

2.6.1.2 Validation rules .................................................................................................. 22 48 

2.6.2 Description – manufactured product ingredients ............................................................ 22 49 2.6.2.1 XML sample – Active Ingredient Base (ACTIB) ................................................... 22 50 

2.6.2.2 XML sample – Active Ingredient Moiety (ACTIM) ............................................. 23 51 

2.6.2.3 XML sample – Active Ingredient Reference (ACTIR) .......................................... 23 52 

2.6.2.4 XML sample – Inactive Ingredient (IACT) ........................................................... 24 53 

2.6.2.5 XML sample – Adjuvant (ADJV) .......................................................................... 24 54 

2.6.2.6 Validation rules .................................................................................................. 24 55 

2.6.3 Packaging ............................................................................................................................... 24 56 2.6.3.1 Description – general packaging ........................................................................ 24 57 

2.6.3.2 XML sample – general packaging ....................................................................... 25 58 

2.6.3.3 Validation rules – general packaging ................................................................. 25 59 

2.6.3.4 Description ‐ kit .................................................................................................. 26 60 

2.6.3.5 XML sample – kit ................................................................................................ 26 61 

2.6.3.6 Validation rules – kit .......................................................................................... 27 62 

2.6.4 Regulatory status of packaging ........................................................................................... 27 63 2.6.4.1 Description ......................................................................................................... 27 64 

2.6.4.2 XML sample ........................................................................................................ 28 65 

2.6.4.3 Validation rules .................................................................................................. 28 66 

2.6.5 Regulatory activity and control number ............................................................................ 28 67 2.6.5.1 Description ......................................................................................................... 28 68 

2.6.5.2 XML sample ........................................................................................................ 28 69 

2.6.5.3 Validation rules .................................................................................................. 29 70 

2.6.6 Regulatory status of the manufactured product .............................................................. 29 71 2.6.6.1 Description ......................................................................................................... 29 72 

2.6.6.2 XML sample ........................................................................................................ 29 73 

2.6.6.3 Validation ........................................................................................................... 30 74 

2.6.7 Product characteristics ........................................................................................................ 30 75 2.6.7.1 XML sample – characteristics ............................................................................ 31 76 

2.6.7.2 Validation ........................................................................................................... 33 77 

2.6.8 Route of administration ....................................................................................................... 33 78 2.6.8.1 Description ......................................................................................................... 33 79 

2.6.8.2 XML sample ........................................................................................................ 33 80 

2.6.8.3 Validation ........................................................................................................... 33 81 

2.7 Narrative text sections ........................................................................................................ 33 82 2.7.1 General ................................................................................................................................... 33 83 

2.7.1.1 Formatting ......................................................................................................... 34 84 

2.7.1.2 Symbols and special characters ......................................................................... 34 85 

Page 6: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 6 

2.7.1.3 Footnotes ........................................................................................................... 35 86 

2.7.1.4 Lists .................................................................................................................... 35 87 

2.7.1.5 Tables ................................................................................................................. 36 88 

2.7.1.6 Hypertext links ................................................................................................... 37 89 

2.7.1.7 Recent major label changes ............................................................................... 37 90 

2.7.1.8 XML sample ........................................................................................................ 38 91 

2.7.1.9 Validation rules – narrative text ........................................................................ 38 92 

2.7.2 Images .................................................................................................................................... 39 93 2.7.2.1 Description ......................................................................................................... 39 94 

2.7.2.2 Validation rules .................................................................................................. 40 95 

2.7.3 Title page ................................................................................................................................ 40 96 2.7.3.1 Description ......................................................................................................... 40 97 

2.7.3.2 XML sample ........................................................................................................ 40 98 

2.7.3.3 Validation rules .................................................................................................. 42 99 

2.7.4 Recent major changes .......................................................................................................... 42 100 2.7.4.1 Description ......................................................................................................... 42 101 

2.7.4.2 XML sample ........................................................................................................ 42 102 

2.7.4.3 Validation rules .................................................................................................. 42 103 

3. Appendices ................................................................................................................................ 43 104 

3.1 Appendix A – glossary ......................................................................................................... 43 105 3.2 Appendix B – references ..................................................................................................... 43 106 

   107 

Page 7: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 7 

1. Introduction 108 

1.1 Purpose/overview 109 

To provide sponsors with detailed technical guidance on the XML hierarchy, technical 110 conformance rules and technical validation rules needed to prepare a valid XML product 111 monograph in compliance with the HL7 SPL standard. 112 

1.2 Scope and application 113 

1.2.1 In‐scope 114 

Human pharmaceutical drugs, biologic drugs and radiopharmaceuticals, regulatory activities 115 submitted in electronic format: Electronic Common Technical Document (eCTD) or non‐eCTD 116 format. 117 

1.2.2 Out of scope 118 

Over the counter (non‐prescription) drugs, self‐care products, natural health products, medical 119 devices, food and veterinary drugs. 120 

1.3 Policy objectives 121 

In recent years Health Canada announced a number of measures that will be taken to support 122 the health and safety of Canadian families, one of which is improving drug product labels. As 123 part of the HPFB’s strategic plan, the goal is to: 124 

Provide more relevant and easier to understand drug information on labels, in order to 125 help Canadians make better informed decisions about their medications; and 126 

Encourage the adoption of digital health technology to improve access, increase 127 efficiency, and improve outcomes for patients. 128 

As part of this initiative, the HPFB recognized that unstructured formats, like Portable 129 Document Format (PDF), are not adequately positioned to support the objectives mentioned 130 above. We will therefore need to transition to more advanced technology formats. Particular 131 attention will be focused on formats that are open source and supported by international 132 standards. 133 

One such format is XML; a markup language used to encode documents in a structured format 134 that is both human‐readable and machine‐readable. Since it is an open standard, XML is a 135 widely used format for exchanging electronic documents and data. 136 

With respect to international standards, the HPFB aims to align its use of XML with other 137 international regulators, HL7 standards and the International Organization for Standardization 138 (ISO) standard for the Identification of Medicinal Product (IDMP). 139 

1.4 Policy statements 140 

This guidance document defines the validation rules for the Health Product and Food Branch’s 141 (HPFB) structured product monograph; which is based on XML, HL7’s SPL standard and 142 controlled vocabularies. 143 

Page 8: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 8 

This guidance document is to be used in the preparation and filing of product monographs in 144 the XML format and is to be read in conjunction with the Guidance Document Preparation of 145 Product Monographs in the Extensible Markup Language Format. 146 

1.5 Background 147 

1.5.1 Extensible Markup Language (XML) 148 

XML is a text‐based markup language used to encode electronic documents in a structured 149 format that is both human and machine‐readable. XML is used as a common format to facilitate 150 the interchange of data over the Internet. 151 

XML is a free open standard maintained by the World Wide Web Consortium (W3C). 152 

1.52 Health Level 7 (HL7) international 153 

Founded in 1987, HL7 is a not‐for‐profit standards development organization dedicated to 154 providing standards for the exchange of electronic health information that supports clinical 155 practice and the management of health services.  156 

Healthcare providers, government stakeholders, payers, pharmaceutical companies, 157 vendors/suppliers, and consulting firms support HL7.  158 

Health Canada is contributing member of HL7. 159 

1.5.3 Structured Product Label (SPL) standard 160 

Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 161 defines the content of human prescription drug labeling in an XML format. In the Canadian 162 context, the product monograph is the ‘label’ or ‘the document’ that is being structured. 163 

1.5.4 Structured document 164 

In this context, structure refers to the fact that the product monographs content has been 165 encoded with XML; i.e., the content has been ‘marked up’ with XML to make it machine‐166 readable. As a result, the narrative text (e.g., section headings, all text and tables) and product 167 information (e.g., manufacturer, ingredients, dosage forms and packaging) are encoded and can 168 be found easily through search. 169 

2. Guidance for implementation 170 

2.1 General technical conformance requirements 171 

2.1.1 Identifiers 172 

Unless stated otherwise (e.g., Hyperlink Identifier (ID) or Observation Media ID), identifiers shall 173 be Globally Unique Identifiers (GUID). This includes but is not limited to the following:  174 

• Document Root ID 175 • ID 176 • SetId 177 • Section ID 178 

Page 9: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 9 

GUID’s should follow the canonical structure, content and formatting rules; e.g., displayed in 179 five groups separated by hyphens, in the form 8‐4‐4‐4‐12 for a total of 36 characters (32 180 alphanumeric characters and four hyphens). 181 

It is the sponsor’s responsibility to ensure that there are no collisions between identifiers.  182 

2.1.2 Content changes 183 

Changing the content of a subsection requires both the section@ID and the 184 effectiveTime@value of the subsection to be updated. The effectiveTime and the section@ID of 185 any ancestor sections must also be updated. 186 

2.1.3 File type 187 

Only file formats detailed in the table below are permitted in the SPL output: 188 

Table 1: List of acceptable file types 189 

File Format  Description  Specifications  Extension 

JPEG/JFIF  Joint Photographic Experts Group (JPEG) / JPEG File Interchange Format (JFIF) is a compression standard for encoding and exchanging still digital raster files. 

ISO 10918‐1  jpg 

XML  Extensible Markup Language (XML) is a markup language that defines document encoding rules. 

W3C XML 1.0  xml 

2.1.4 SPL file name 190 

The SPL content (e.g., xml and images) must always be placed in a single SPL folder. 191 

The .xml file must be named with GUID from the documentID. 192 

It is the sponsor’s responsibility to ensure there are no content naming collisions between any 193 of the files in the SPL folder. 194 

2.1.5 External file references 195 

All files associated with the SPL document are referenced in the .xml. 196 

2.1.6 Codes 197 

There are no spaces in codes. 198 

2.1 7 Case sensitivity 199 

There is no general case sensitivity rule. 200 

2.1.8 Display name 201 

All display names are language specific. When derived from a controlled vocabulary the display 202 name shall match the language of the document; e.g., French display name for a French 203 document and English display names for English documents. 204 

2.1.9 Image quality 205 

All images will be displayed as is without transformation or modification. Therefore, images 206 shall be of sufficient quality and size to be legible by end users. 207 

Page 10: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 10 

2.1.10 Date and time 208 

Time values (such as effectiveTime@value, effectiveTime.low@value and 209 effectiveTime.high@value) are based on ISO‐8601. They use the following format 210 YYYYMMDDHHMMSS+”GMT offset”. 211 

All values other than the + symbol are integers; the time aspect is based on a 24hr notation; 212 and, unless specified otherwise, use the Time Zone offset assumed to be GMT time.  213 

YYYY represents the year and is 4 digits; MM represents the month and is 2 digits; DD 214 represents the day and is 2 digits; HH represents the hour and is 2 digits; MM represents the 215 minutes and is 2 digits; SS represents the seconds and is 2 digits.  216 

The time may be followed by a + (plus) or a ‐ (minus) symbol and a Time Zone offset from GMT 217 expressed as 4 digits. While the ISO standard provides many options the HPFB only allows for 218 the following three permutations on time values: 219 

1. Date Only: in this model the string is limited to YYYYMMDD. 220 2. Date and GMT Time: in this model the string is limited to YYYYMMDDHHMMSS. 221 3. Date and Local Time: in this model the GMT offset is added as an example 222 

YYYYMMDDHHMMSS‐0500 represents EST. The offset is static and therefore must be 223 manually adjusted for Daylight Saving Time as appropriate. 224 

2.1.11 Narrative text 225 

No text (i.e., <text><paragraph></paragraph></text>) is to appear immediately under the 226 following major section headings.  227 

• Title Page 228 • Part I: Health Professional Information 229 • Part II: Scientific Information 230 • Part III: Patient Medication Information 231 

With respect to the above mentioned section headings, text can only appear under the sub‐232 headings; e.g., text cannot appear immediately under Part I but text is meant to appear under 233 section 1 Indications. 234 

Text is meant to appear directly under the Recent Major Changes section heading. 235 

2.1.12 General validation rules 236 

1. XML is well formed and valid against the schema 237 2. There are no data elements and attributes in addition to those described in this 238 

document 239 3. There are no spaces in codes 240 4. Codes must have a codeSystem name attribute 241 5. Display names are case insensitive 242 6. There are no spaces in id extensions 243 7. Letters in Globally Unique Identifiers (GUID) are lower case 244 8. There are no empty or incomplete elements 245 9. Characteristics have no class code at all 246 10. There are no confidentiality codes 247 

Page 11: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 11 

2.2 XML prolog 248 

2.2.1 Description 249 

The XML version, character encoding, the schema and the location of the schema. 250 

2.2.2 XML sample 251 

<?xml version="1.0" encoding="UTF‐8"?> 252 <?xml‐stylesheet 253 href="https://raw.githubusercontent.com/HealthCanada/HPFB/master/Structured‐Product‐254 Labeling‐(SPL)/Style‐Sheets/current/hpfb‐spm‐core.xsl"?> 255 <?xml‐stylesheet 256 href="https://raw.githubusercontent.com/HealthCanada/HPFB/master/Structured‐Product‐257 Labeling‐(SPL)/Style‐Sheets/current/hpfb‐spm.css"?> 258 <document xmlns="urn:hl7‐org:v3" 259   xmlns:xsi="http://www.w3.org/2001/XMLSchema‐instance" 260 xsi:schemaLocation="https://raw.githubusercontent.com/HealthCanada/HPFB/master/Structur261 ed‐Product‐Labeling‐(SPL)/Schema/current/SPL.xsd"> 262 

2.2.3 Validation rules 263 

1. XML reference is for version 1.0 and encoding “UTF‐8”. 264 

2. There is an xml‐stylesheet reference to 265 

https://github.com/HealthCanada/HPFB/blob/master/Structured‐Product‐Labeling‐266 

(SPL)/Style‐Sheets/current/hpfb‐spm.xsl  267 

3. The schemaLocation of the urn:hl7‐org:v3 namespace is provided as 268 

“https://github.com/HealthCanada/HPFB/blob/master/Structured‐Product‐Labeling‐269 

(SPL)/Schema/current/SPL.xsd” 270 

4. There are no processing instructions other than the xml and xml‐stylesheet declarations. 271 

5. There are no comments. 272 

6. SPL file name is the document id GUID followed by “.xml”. 273 

7. A submission contains only the SPL file whose name ends in ‘.xml’ and, if appropriate, 274 

associated image files whose names end in '.jpg'. 275 

8. All image files associated with the SPL document are referenced in the .xml. 276 

2.3 Document 277 

2.3.1 Description 278 

Provides general information about the overall document: 279 

• The templateId extension specifies the regulatory activity associated with this version of 280 the product monograph. 281 

• The <id root> is a GUID and is unique for each version of the document. Letters used in a 282 GUID are lower case. 283 

• The <code> is the HPFB code that specifies the document type. 284 • The <title> data element is used for the title for the product monograph.  285 

Page 12: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 12 

• Images are not included in the title.  286 o Multiple lines may be used in the title with each line separated by a line break 287 

<br/> tag. 288 • The <effectiveTime> specifies the Date of Last Revision for this version.  289 • The <originalText description> specifies the Date of Initial Approval. 290 • The <languageCode> is the HPFB code that specifies the language of the document. 291 • The <setId> is a GUID and is a unique identifier for the document that remains constant 292 

through all versions/revisions of the document. 293 • The <versionNumber> is an integer greater than zero that specifies the version of the 294 

document. 295 

2.3.2 XML sample 296 

<document> 297   <templateId extension="regulatory activity code" root="2.16.840.1.113883.2.20.6.11"/> 298   <id root="7f363dae‐0612‐4be7‐bb92‐a8381fa1da35"/> 299   <code code="1"  300 

codeSystem="2.16.840.1.113883.2.20.6.10"  301 displayName="product monograph type"/> 302 

  <title>"Scheduling <sub>Symbol</sub>" "Brand Name" "Proper name" "Dosage Form(s), 303 Strength(s) and Route(s) of Administration" "Pharmaceutical Standard, "Pharmaceutical 304 Standard, "Pharmaceutical Standard" "Therapeutic Classification" 305 

</title> 306   <effectiveTime value="20180101"><!‐‐ Date of Last Revision ‐‐> 307     <originalText description="Date of Initial Approval">20170101</originalText> 308   </effectiveTime> 309   <languageCode code="1" codeSystem="2.16.840.1.113883.2.20.6.29" 310 

displayName="english"/> 311   <setId root="4eb4ec67‐8764‐4b72‐b7a5‐0bae88db11a3"/> 312   <versionNumber value="2"/> 313 

2.3.3 Validation rules 314 

1. There is a document id. 315 

2. id root is a Globally Unique Identifier (GUID). 316 

3. id does not have an extension. 317 

4. id does not match any other id in the document. 318 

5. There is a code for document type from the code system is 2.16.840.1.113883.2.20.6.10 and 319 

the display name matches the code. 320 

6. There are no images in the title. 321 

7. There is an effective time with at least the precision of day in the format YYYYMMDD.  322 

8. There is an original text description with at least the precision of day in the format 323 

YYYYMMDD. 324 

9. There is a code for language from the code system 2.16.840.1.113883.2.20.6.29 and the 325 

display name matches the code. 326 

10. There is a set id. 327 

Page 13: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 13 

11. The set id is a GUID. 328 

12. There is a version number. 329 

13. Value of version number is a whole number > 0. 330 

2.4 Market authorization holder and importer or distributor 331 

2.4.1 Description 332 

Provides the company name, address and contact information for the market authorization 333 holder associated with this document. If applicable, the company name, address and contact 334 information for the Canadian importer or distributor will be specified as well. 335 

• The <representedOrganization> is the HPFB code that specifies the company ID for the 336 market authorization holder. 337 

• <assignedOrganization> is the HPFB code that specifies the company ID for the Canadian 338 importer or distributor. 339 

2.4.2 XML sample 340 

<document> 341 … 342   <author><!‐‐Organization Information‐‐>     343     <time/> 344     <assignedEntity> 345       <representedOrganization><!‐‐Market Authorization Holder‐‐>       346         <id extension="1111" root="2.16.840.1.113883.2.20.6.31"/> 347         <name>Market Authorization Holder Inc</name> 348         <contactParty> 349           <addr> 350             <streetAddressLine>256 Lanark Drive</streetAddressLine> 351             <city>Ottawa</city> 352             <state>Ontario</state> 353             <postalCode>a1a 2a2</postalCode> 354             <country code="1" codeSystem="2.16.840.1.113883.2.20.6.17" 355 displayName="CANADA"/> 356           </addr> 357           <telecom value="tel:+1‐613‐123‐4567"/> 358           <telecom value="mailto:[email protected]"/> 359           <contactPerson> 360             <name>Market Authorization Holder Inc</name> 361           </contactPerson> 362         </contactParty> 363         <assignedEntity> 364           <assignedOrganization><!‐‐ Importer/Distributor ‐‐> 365             <id extension="0000" root="2.16.840.1.113883.2.20.6.31"/> 366             <name>Importer Inc</name> 367             <contactParty> 368               <addr> 369 

Page 14: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 14 

                <streetAddressLine>257 Lanark Ave</streetAddressLine> 370                 <city>Ottawa</city> 371                 <state>Ontario</state> 372                 <postalCode>a2a 1a1</postalCode> 373                 <country code="1" codeSystem="2.16.840.1.113883.2.20.6.17"/> 374               </addr> 375               <telecom value="tel:+1‐613‐123‐4598"/> 376               <telecom value="mailto:[email protected]"/> 377               <contactPerson> 378                 <name>Importer Inc</name> 379               </contactPerson> 380             </contactParty> 381           </assignedOrganization> 382         </assignedEntity> 383       </representedOrganization> 384     </assignedEntity> 385   </author> 386 

2.4.3 Validation rules 387 

1. One id is a company code from the code system 2.16.840.1.113883.2.20.6.31 and the 388 

display name matches the code. 389 

2. There is a name. 390 

3. There is an address with street address line, city, province and country. 391 

4. The country code is from the code system 2.16.840.1.113883.2.20.6.17 and the display 392 

name matches the code. Country is a full country name. 393 

5. If the country is “Canada”, then the contact party’s address has a province (2‐letter 394 

abbreviation) and has a postal code. 395 

6. If the country is “Canada”, then there is a postal code as a 6 digit alpha numeric number in 396 

the format “A1A 1A1” with a space separating the third and fourth characters. There is no 397 

hyphen.  398 

7. There is a postal code. 399 

8. There are two <telecom> elements. 400 

9. One telecom value begins with “tel:” and is a telephone number based on the following 401 

rules: 402 

a. telephone numbers are global telephone numbers; 403 

b. telephone numbers contain no letters or spaces; 404 

c. telephone numbers begin with “+”; 405 

d. include hyphens to separate the country code, area codes and subscriber number; 406 

e. have any telephone number extensions separated by “;ext=”; 407 

f. If there is a semicolon in the telephone number, then it is followed by ext. 408 

10. One telecom value begins with “mailto:” and encodes an email address in the format 409 

<username>@<dns‐name>. 410 

Page 15: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 15 

11. The <contactperson> value matches the <name> value; i.e., the contact person value and 411 

the company name value are the same. 412 

2.5 SPL body 413 

2.5.1 Description 414 

The body of the SPL document includes structured components for the manufactured 415 product(s) and the narrative text sections of the product monograph (e.g., Title Page, Part I: 416 Health Professional Information, Part II: Scientific Information and Part III: Patient Medication 417 Information). 418 

Sections and subsections have id, title, and code. HPFB codes are used for sections and 419 subsections codes. 420 

The <title> of the sections and subsections and order of the sections and subsections in the SPL 421 are used to render the product monograph contents. The numbering for the sections and 422 subsections are included in the display name of each section or subsection. 423 

In the SPL schema, the <structuredBody> element contains multiple <component>s, and each 424 <component> contains a <section>. 425 

Sections are used to aggregate paragraphs into logical groupings. The order in which sections 426 appear in an SPL document is the order the sections will appear when displayed (rendered) 427 using the standard HPFB stylesheet. Major sections are defined by the Guidance Document 428 Product Monograph and the product monograph templates associated with the relevant 429 product type; e.g., the 2016 Product Monograph Template – Schedule D defines the major 430 product monograph section headings for a biologic.  431 

Sections that have not been assigned a specific HPFB code are assigned the HPFB code for “SPL 432 Unclassified Section”. 433 

Each section has a unique identifier (<id>), an <effectiveTime>, and a HPFB code (i.e., the 434 <code> element). A section may or may not contain a <title>. 435 

The human readable content of the product monograph is contained within the <text> element 436 in the <section>. The <section> can be nested to form sub‐sections. The schema for subsections 437 in SPL requires that the nested <section> tag first be nested inside a <component> tag. Use 438 nested sections to relate paragraphs. The section tag applies to all of the nested sections. By 439 nesting sections, computer systems can use the section tags in SPL to display information useful 440 for the care of patients. If information is not associated with the tag, it will not be displayed. 441 

Using the following principles for markup of text information improves access to information in 442 the product monograph: 443 

• Capture the section heading using the <title> element rather than placing the text of the 444 title within the <text> element. This allows computer systems to use and display this 445 information properly. 446 

• Link different parts of the product monograph using the ID attribute to the <section> 447 element. For example, <section ID=" 4.1 Dosing Considerations”> serves as the target of 448 a <linkHtml> element. Linking to the ID attribute of a section allows the link to 449 

Page 16: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 16 

'reference' the section entirely, e.g., for retrieval of a whole section in a non‐browser 450 interface. 451 

• Separate the text and images for each concept using <paragraph> tags. 452 

2.5.2 XML sample – manufactured product section 453 

<document> 454 … 455   <component> 456     <structuredBody> 457       <component><!—SPL Body ‐‐>        458         <section ID="f6ac9de5‐be91‐442c‐9579‐5bc9ebd36902"> 459           <id root="bdeefc11‐4315‐41e3‐8c56‐83e8bf4f770b"/> 460           <code code="MP"  461 

codeSystem="2.16.840.1.113883.2.20.6.8"  462 displayName="Manufactured Product"/> 463 

          <effectiveTime value="20170101"/> 464 <subject> 465 

2.5.3 XML sample – narrative text section 466 

<document> 467 … 468       <component><!‐‐Title Page section‐‐>        469         <section ID="Ld8d30d86‐e343‐48f4‐9cec‐524834b3803b"> 470           <id root="eed00b53‐cdb2‐4aa6‐9e82‐88b7d793b208"/> 471           <code code="TP" codeSystem="2.16.840.1.113883.2.20.6.8" displayName="title page"/> 472           <title>Title Page</title> 473           <text> 474             <paragraph>"Scheduling <sub>Symbol</sub>" "Brand Name" "Proper name" "Dosage 475 Form(s), 476               Strength(s) and Route(s) of Administration" "Pharmaceutical Standard, "Pharmaceutical 477               Standard, "Pharmaceutical Standard" "Therapeutic Classification" 478             </paragraph> 479           </text> 480           <effectiveTime value="20180101"/>           481         </section> 482       </component> 483 

2.5.4 Validation rules 484 

1. Each section has zero to many subsections. 485 

2. Each section and subsection has an id root and no extension. 486 

3. id root (section id) is a GUID. 487 

4. id does not match any other id in the document. 488 

5. id (section id) does not match any other id across all sections. 489 

Page 17: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 17 

6. Each section and subsection has a code from the code system 2.16.840.1.113883.2.20.6.8 490 

and the display name matches the code. 491 

7. Each section has an effective time with at least the precision of day in the format 492 

YYYYMMDD. 493 

8. There are no figures in the title for a section or subsection. 494 

2.6 Manufactured product 495 

2.6.1 Description – manufactured product code and name 496 

Provides information about the manufactured product(s) associated with this product 497 monograph. This includes: 498 

• The <code> is the Drug Identification Number (DIN) for this manufactured product. 499 • The <name> is the proprietary name or brand name for this manufactured product. 500 • The <formCode> is the manufactured dosage form of the manufactured product. 501 • The <asEntityWithGeneric><genericmedicine><name> is the non‐proprietary name for 502 

this manufactured product. 503 

2.6.1.1 XML sample – manufactured product 504 

<document> 505   <component> 506     <structuredBody> 507       <component><!‐‐ Manufactured Product Information ‐‐>        508         <section ID="f6ac9de5‐be91‐442c‐9579‐5bc9ebd36902"> 509           <id root="bdeefc11‐4315‐41e3‐8c56‐83e8bf4f770b"/> 510           <code code="MP" codeSystem="2.16.840.1.113883.2.20.6.8" 511 displayName="Manufactured Product"/> 512           <effectiveTime value="20170101"/> 513           <subject> 514             <manufacturedProduct> 515               <manufacturedProduct> 516                 <code code="123456" codeSystem="2.16.840.1.113883.2.20.6.42" 517 displayName="display name"/><!‐‐ DIN Number ‐‐> 518                 <name>Product#1</name> 519                 <formCode code="85"  520 

codeSystem="2.16.840.1.113883.2.20.6.3"  521 displayName="Tablet"/> 522 

                <asEntityWithGeneric> 523                   <genericMedicine> 524                     <name>International Nonproprietary Name</name> 525                   </genericMedicine> 526                 </asEntityWithGeneric> 527                 <ingredient classCode="ACTIR"> 528                   <quantity> 529                     <numerator value="5" unit="mg"/> 530 

Page 18: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 18 

                    <denominator value="1" unit="1"/> 531                   </quantity> 532                   <ingredientSubstance> 533                     <code code="1" codeSystem="2.16.840.1.113883.2.20.6.14" 534 displayName="ingredient#1"/> 535                     <name>ingredient#1 ‐ base</name> 536                     <activeMoiety> 537                       <activeMoiety> 538                         <code code="2" codeSystem="2.16.840.1.113883.2.20.6.14" 539 displayName="ingredient#2"/> 540                         <name>ingredient#2 ‐ moiety</name> 541                       </activeMoiety> 542                     </activeMoiety> 543                     <asEquivalentSubstance> 544                       <definingSubstance> 545                         <code code="3" codeSystem="2.16.840.1.113883.4.9" 546 displayName="ingredient#3"/> 547                         <name>ingredient#3 ‐ referenced as basis of strength</name> 548                       </definingSubstance> 549                     </asEquivalentSubstance> 550                   </ingredientSubstance> 551                 </ingredient> 552                 <ingredient classCode="IACT"> 553                   <ingredientSubstance> 554                     <code code="4" 555 codeSystem="2.16.840.1.113883.2.20.6.14"displayName="ingredient#4"/> 556                     <name>ingredient#4</name> 557                   </ingredientSubstance> 558                 </ingredient> 559                 <asContent><!‐‐ Packaging ‐‐>                 560                   <quantity> 561                     <numerator value="1" unit="1"/> 562                     <denominator value="1"/> 563                   </quantity> 564                   <containerPackagedProduct> 565                     <code code="123‐456" codeSystem="2.16.840.1.113883.2.20.6.56"/><!‐‐company 566 defined pack code‐‐>                    567                     <formCode code="5" codeSystem="2.16.840.1.113883.2.20.6.32" 568 displayName="bottle"/> 569                   </containerPackagedProduct> 570                   <subjectOf> 571                     <marketingAct> 572                       <code code="1" codeSystem="2.16.840.1.113883.2.20.6.37" 573 displayName="approved"/> 574                       <statusCode code="active"/> 575 

Page 19: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 19 

                      <effectiveTime><!‐‐ regulatory status of this package ‐‐>                        576                         <low value="20170101"/><!‐‐ Date of Initial Approval ‐‐>                         577                         <high value="20180101"/><!‐‐ Date of DIN cancellation ‐‐>                         578                       </effectiveTime> 579                     </marketingAct> 580                   </subjectOf> 581                 </asContent> 582               </manufacturedProduct> 583               <subjectOf><!‐‐Regulatory Activity associated with this products status‐‐>                 584                 <approval> 585                   <id extension="123456" root="2.16.840.1.113883.2.20.6.49"/><!‐‐ Control Number ‐‐586 >                   587                   <code code="2" codeSystem="2.16.840.1.113883.2.20.6.11" displayName="SNDS"/> 588                   <author> 589                     <territorialAuthority>P 590                       <territory> 591                         <code code="1" codeSystem="2.16.840.1.113883.2.20.6.17" 592 displayName="canada"/> 593                       </territory> 594                     </territorialAuthority> 595                   </author> 596                 </approval> 597               </subjectOf> 598               <subjectOf><!‐‐Regulatory status of this product‐‐>                599                 <marketingAct> 600                   <code code="1" codeSystem="2.16.840.1.113883.2.20.6.37" 601 displayName="approved"/> 602                   <statusCode code="active"/> 603                   <effectiveTime> 604                     <low value="20170101"/> 605                   </effectiveTime> 606                 </marketingAct> 607               </subjectOf> 608               <!‐‐Characteristics of this product‐‐> 609               <subjectOf>                610                 <characteristic> 611                   <code code="0" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="product 612 class"/> 613                   <value code="2" codeSystem="2.16.840.1.113883.2.20.6.53" displayName="product 614 class display name" 615                     xsi:type="CE"> 616                     <originalText>biologic</originalText> 617                   </value> 618                 </characteristic> 619               </subjectOf> 620 

Page 20: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 20 

              <subjectOf> 621                 <characteristic> 622                   <code code="colour" codeSystem="2.16.840.1.113883.2.20.6.23" 623 displayName="colour"/> 624                   <value code="2" codeSystem="2.16.840.1.113883.2.20.6.24" displayName="blue 625 display name" 626                     xsi:type="CE"> 627                     <originalText>light blue</originalText> 628                   </value> 629                 </characteristic> 630               </subjectOf> 631               <subjectOf> 632                 <characteristic> 633                   <code code="shape" codeSystem="2.16.840.1.113883.2.20.6.23" 634 displayName="shape"/> 635                   <value code="1" codeSystem="2.16.840.1.113883.2.20.6.25" displayName="shape 636 diplay name" 637                     xsi:type="CE"> 638                     <originalText>shape</originalText> 639                   </value> 640                 </characteristic> 641               </subjectOf> 642               <subjectOf> 643                 <characteristic> 644                   <code code="size" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="size"/> 645                   <value unit="mm" value="10" xsi:type="PQ"/> 646                 </characteristic> 647               </subjectOf> 648               <subjectOf> 649                 <characteristic> 650                   <code code="score" codeSystem="2.16.840.1.113883.2.20.6.23" 651 displayName="score"/> 652                   <value value="1" xsi:type="INT"/> 653                 </characteristic> 654               </subjectOf> 655               <subjectOf> 656                 <characteristic> 657                   <code code="imprint" codeSystem="2.16.840.1.113883.2.20.6.23" 658 displayName="imprint"/> 659                   <value xsi:type="ST">value</value> 660                 </characteristic> 661               </subjectOf> 662               <subjectOf> 663                 <characteristic> 664 

Page 21: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 21 

                  <code code="flavour" codeSystem="2.16.840.1.113883.2.20.6.23" 665 displayName="flavour"/> 666                   <value code="1" codeSystem="2.16.840.1.113883.2.20.6.26" xsi:type="CE"> 667                     <originalText>new almond</originalText> 668                   </value> 669                 </characteristic> 670               </subjectOf> 671               <subjectOf> 672                 <characteristic> 673                   <code code="image" codeSystem="2.16.840.1.113883.2.20.6.23" 674 displayName="image"/> 675                   <value xsi:type="ED" mediaType="image/jpeg"> 676                     <reference value="filename.jpg"/> 677                   </value> 678                 </characteristic> 679               </subjectOf> 680               <subjectOf> 681                 <characteristic> 682                   <code code="13" codeSystem="2.16.840.1.113883.2.20.6.23" 683 displayName="Pharmaceutical Standard"/> 684                   <value code="7" codeSystem="2.16.840.1.113883.2.20.6.5" displayName="display 685 name" xsi:type="CV"/> 686                 </characteristic> 687               </subjectOf> 688               <subjectOf> 689                 <characteristic> 690                   <code code="14" codeSystem="2.16.840.1.113883.2.20.6.23" 691 displayName="scheduling symbol"/> 692                   <value code="1" codeSystem="2.16.840.1.113883.2.20.6.2" displayName="Pr" 693                     xsi:type="CV"/> 694                 </characteristic> 695               </subjectOf> 696               <subjectOf> 697                 <characteristic> 698                   <code code="15" codeSystem="2.16.840.1.113883.2.20.6.23" 699 displayName="therapeutic class"/> 700                   <value code="1" codeSystem="2.16.840.1.113883.2.20.6.6" displayName="display 701 name" 702                     xsi:type="CV"/> 703                 </characteristic> 704               </subjectOf> 705               <consumedIn> 706                 <substanceAdministration> 707                   <routeCode code="56" codeSystem="2.16.840.1.113883.2.20.6.7" 708 displayName="oral"/> 709 

Page 22: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 22 

                </substanceAdministration> 710               </consumedIn> 711             </manufacturedProduct> 712           </subject> 713         </section> 714       </component> 715 

2.6.1.2 Validation rules 716 

1. There is a code representing the DIN with the code system 2.16.840.1.113883.2.20.6.42. 717 

2. There is a proprietary name.  718 

3. There is a formCode with the code system 2.16.840.1.113883.2.20.6.3. Display name 719 

matches the code. 720 

4. There is a non‐proprietary name.  721 

5. There is a approval with the code system 2.16.840.1.113883.2.20.6.11. Display name 722 

matches the code. 723 

2.6.2 Description – manufactured product ingredients 724 

Information about the ingredients in this manufactured product.  725 

• <ingredient> is the ingredient information based on role (active, inactive or adjuvant), 726 strength, ingredient code and ingredient name. 727 

• The <ascontent> is the packaging information based on pack code, quantity, pack type 728 and regulatory status of the packaging. 729 

• The <subjectof><approval> is the regulatory activity associated with this manufactured 730 product based on the control number, regulatory activity type and country. 731 

• The <subjectof><marketingact> is the regulatory status for this manufactured product  732 • The <subjectof><characteristic> are the characteristics of this manufactured product; 733 

i.e., Shape, size, score, imprint, flavour, image, pharmaceutical standard, scheduling 734 symbol, therapeutic class. 735 

• The <consumedin><substanceAdministration><routecode> is the route of 736 administration for this product. 737 

2.6.2.1 XML sample – Active Ingredient Base (ACTIB) 738 

<ingredient classCode="ACTIB"> 739   <quantity> 740     <numerator value="5" unit="mg"/> 741     <denominator value="1" unit="1"/> 742   </quantity> 743   <ingredientSubstance> 744     <code code="1" codeSystem="2.16.840.1.113883.2.20.6.14" displayName="ingredient#1"/> 745     <name>ingredient#1 ‐ base</name> 746     <activeMoiety> 747       <activeMoiety> 748         <code code="2" codeSystem="2.16.840.1.113883.2.20.6.14" 749 displayName="ingredient#2"/> 750 

Page 23: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 23 

        <name>ingredient#2 ‐ moiety</name> 751       </activeMoiety> 752     </activeMoiety> 753   </ingredientSubstance> 754 </ingredient> 755 

2.6.2.2 XML sample – Active Ingredient Moiety (ACTIM) 756 

<ingredient classCode="ACTIM"> 757   <quantity> 758     <numerator value="5" unit="mg"/> 759     <denominator value="1" unit="1"/> 760   </quantity> 761   <ingredientSubstance> 762     <code code="1" codeSystem="2.16.840.1.113883.2.20.6.14" displayName="ingredient#1"/> 763     <name>ingredient#1 ‐ base</name> 764     <activeMoiety> 765       <activeMoiety> 766         <code code="2" codeSystem="2.16.840.1.113883.2.20.6.14" 767 displayName="ingredient#2"/> 768         <name>ingredient#2 ‐ moiety</name> 769       </activeMoiety> 770     </activeMoiety> 771   </ingredientSubstance> 772 </ingredient> 773 

2.6.2.3 XML sample – Active Ingredient Reference (ACTIR) 774 

<ingredient classCode="ACTIR"> 775   <quantity> 776     <numerator value="5" unit="mg"/> 777     <denominator value="1" unit="1"/> 778   </quantity> 779   <ingredientSubstance> 780     <code code="1" codeSystem="2.16.840.1.113883.2.20.6.14" 781       displayName="ingredient#1"/> 782     <name>ingredient#1 ‐ base</name> 783     <activeMoiety> 784       <activeMoiety> 785         <code code="2" codeSystem="2.16.840.1.113883.2.20.6.14" 786           displayName="ingredient#2"/> 787         <name>ingredient#2 ‐ moiety</name> 788       </activeMoiety> 789     </activeMoiety> 790     <asEquivalentSubstance> 791       <definingSubstance> 792         <code code="3" codeSystem="2.16.840.1.113883.4.9" displayName="ingredient#3"/> 793 

Page 24: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 24 

        <name>ingredient#3 ‐ referenced as basis of strength</name> 794       </definingSubstance> 795     </asEquivalentSubstance> 796   </ingredientSubstance> 797 </ingredient> 798 

2.6.2.4 XML sample – Inactive Ingredient (IACT) 799 

<ingredient classCode="IACT"> 800   <ingredientSubstance> 801     <code code="4" codeSystem="2.16.840.1.113883.2.20.6.14" 802       displayName="ingredient#4"/> 803     <name>ingredient#4</name> 804   </ingredientSubstance> 805 </ingredient> 806 

2.6.2.5 XML sample – Adjuvant (ADJV) 807 

<ingredient classCode="ADJV"> 808   <ingredientSubstance> 809     <code code="1" codeSystem="2.16.840.1.113883.2.20.6.14" displayName="ingredient#1"/> 810     <name>ingredient#1 ‐ base</name> 811   </ingredientSubstance> 812 </ingredient> 813 

2.6.2.6 Validation rules 814 

1. There is a class code with the code system 2.16.840.1.113883.2.20.6.39 (ingredient role). 815 

Display name matches the code. 816 

2. There is a strength with a numerator and denominator if the ingredient role is ACTIB, ACTIM 817 

or ACTIR. 818 

3. Numerator and denominator have a value greater than zero and a unit. 819 

4. Unit comes from the code system 2.16.840.1.113883.2.20.6.15 (units of measure).  820 

5. For percentages numerator unit is not 1, instead use a volume unit for volume fractions and 821 

a mass unit for mass fractions.  822 

6. The denominators values and units for all ingredients in this product are the same.  823 

7. There is an ingredient code from the code system 2.16.840.1.113883.2.20.6.14 (ingredient 824 

id). 825 

8. The same ingredient code is not used more than once per product.  826 

9. There is an ingredient name. Name matches the code display name. 827 

2.6.3 Packaging 828 

2.6.3.1 Description – general packaging 829 

The packaging includes the quantity of product in the package and the package type, along with 830 all packaging aspect that make up the package (such as inner packages).  831 

Page 25: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 25 

Packaging is represented as a quantity, a product ID if applicable and a package type. The 832 quantity aspect is represented as a numerator and denominator along with a unit of measure 833 and packaging type. The Units of Presentation code (the numerator) is derived from OID: 834 2.16.840.1.113883.2.20.6.15, while the Packaging Type code (the denominator) is derived from 835 OID: 2.16.840.1.113883.2.20.6.32.  836 

2.6.3.2 XML sample – general packaging 837 

<asContent><!‐‐ Packaging ‐‐> 838   <quantity> 839     <numerator value="1" unit="1"/> 840     <denominator value="1"/> 841   </quantity> 842   <containerPackagedProduct> 843     <code code="123‐456" codeSystem="2.16.840.1.113883.2.20.6.56"/><!‐‐company defined 844 pack code‐‐>    845     <formCode code="5" codeSystem="2.16.840.1.113883.2.20.6.32" displayName="bottle"/> 846   </containerPackagedProduct> 847   <subjectOf> 848     <marketingAct> 849       <code code="1" codeSystem="2.16.840.1.113883.2.20.6.37" displayName="approved"/> 850       <statusCode code="active"/> 851       <effectiveTime><!‐‐ regulatory status of this package ‐‐>        852         <low value="20170101"/><!‐‐ Date of Initial Approval ‐‐>         853         <high value="20180101"/><!‐‐ Date of DIN cancellation ‐‐>         854       </effectiveTime> 855     </marketingAct> 856   </subjectOf> 857 </asContent> 858 

2.6.3.3 Validation rules – general packaging 859 

1. A product may have an “as content” (package information) element. 860 

2. Quantity (for package information) includes a numerator and denominator. 861 

3. Numerator (for package amount) has a value greater than zero and a unit. 862 

4. If the product has parts, then the initial numerator value and unit is “1”. 863 

5. Unit of the numerator (for package amount) of the initial package is the same as the units 864 

for the denominators of all the ingredient quantities (strengths). 865 

6. Unit of the numerator (for package amount) of an outer package is the same as the unit for 866 

the denominator of the quantity of the inner package. 867 

7. Denominator has value 1 and either no unit or unit “1”. 868 

8. There is a pack type code from the code system 2.16.840.1.113883.2.20.6.32 and the 869 

display name matches the code. 870 

9. There is a package item code with code and code system 2.16.840.1.113883.2.20.6.56. 871 

Page 26: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 26 

10. If the package item code is mentioned elsewhere in the document, then the package type 872 

code and quantity value and unit are the same. 873 

11. Package type code does not match any other package item code in the same package 874 

hierarchy. 875 

2.6.3.4 Description ‐ kit 876 

When products have more than one part, each part is described under <partProduct>. 877 Currently, when a drug product has parts, it is considered a Kit indicated by the formCode for 878 KIT. Products may be combined in various ways such as:  879 

• Drug kit with a device part.  880 • Drug in a delivery device.  881 

2.6.3.5 XML sample – kit 882 

<manufacturedProduct> 883 <manufacturedProduct> 884 <code code="Company pack code for kit" codeSystem="2.16.840.1.113883.2.20.6.56"/> 885 <name>name of kit</name> 886 <formCode code="36" codeSystem="2.16.840.1.113883.2.20.6.32" displayName="KIT"/>  887 <asEntityWithGeneric .../> 888 <part> 889 

<quantity> 890 <numerator value="amount of this part’s content in one kit" unit="unit for amount"/> 891 <denominator value="1"/> 892 

</quantity> 893 <partProduct> 894 

<code code="DIN code of drug part" codeSystem="2.16.840.1.113883.2.20.6.42"/> 895 <name>name of drug part</name> 896 <formCode code="dosage form code of drug part" 897 

codeSystem="2.16.840.1.113883.2.20.6.3" displayName="display name"/> 898 <ingredient ... /> 899 <asContent> 900 

<quantity> 901 <numerator value="amount of this part in its package" unit="unit of amount"/> 902 <denominator value="1"/> 903 

</quantity> 904 <containerPackagedProduct>  905 

<code code="Company code of part’s package" 906 codeSystem="2.16.840.1.113883.2.20.6.56"/> 907 

<formCode code="package type" codeSystem="2.16.840.1.113883.2.20.6.32" 908 displayName="display name"/> 909 

</containerPackagedProduct> 910 </asContent> 911 

</partProduct> 912 </part> 913 

Page 27: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 27 

<part> 914 <quantity> 915 

<numerator value="amount of this device part in one kit"/> 916 <denominator value="1"/> 917 

</quantity> 918 <partProduct> 919 

<code code="Company pack code for this part" 920 codeSystem="2.16.840.1.113883.2.20.6.56"/> 921 

<name>name of part</name> 922 <desc>description of device part</desc> 923 <asSpecializedKind> 924 

<generalizedMaterialKind> 925 <code code="00" codeSystem="2.16.840.1.113883.2.20.6.32" displayName="PRE‐926 

FILLED SYRINGE"/> 927 </generalizedMaterialKind> 928 

</asSpecializedKind> 929 </partProduct> 930 </part> 931 

2.6.3.6 Validation rules – kit 932 

1. If the pack type is Kit, then there is one or more parts. 933 

2. Each part has an overall quantity. 934 

3. If there is an “as content” (packaging) data element in the part, then the numerator unit is 935 

the same as the numerator unit for the “as content” data element. 936 

4. If there is no “as content” (packaging) data element in the part, then the numerator unit is 937 

1. 938 

5. There is a code and code system is 2.16.840.1.113883.2.20.6.56. 939 

6. There is a name. 940 

7. Procedures for ingredients, characteristics and packaging are the same as for products 941 

without parts. 942 

2.6.4 Regulatory status of packaging 943 

2.6.4.1 Description 944 

The marketing status provides information on when the product is on or off the market. 945 

The <code> indicates the regulatory status. The status of the product is described in the 946 <statusCode> using the appropriate HPFB status code. The status specifies when the product is 947 available on the market or no longer available on the market.  948 

The <effectiveTime> is used to capture the Date of Initial Approval and the date the DIN was 949 cancelled. Effective time low value is the date when the original Notice of Compliance was 950 issued. Effective time high is the date when the DIN was cancelled. 951 

Page 28: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 28 

2.6.4.2 XML sample 952 

<asContent><!‐‐ Packaging ‐‐> 953   <quantity> 954     <numerator value="1" unit="1"/> 955     <denominator value="1"/> 956   </quantity> 957   <containerPackagedProduct> 958     <code code="123‐456" codeSystem="2.16.840.1.113883.2.20.6.56"/><!‐‐company defined 959 pack code‐‐>    960     <formCode code="5" codeSystem="2.16.840.1.113883.2.20.6.32" displayName="bottle"/> 961   </containerPackagedProduct> 962   <subjectOf> 963     <marketingAct> 964       <code code="1" codeSystem="2.16.840.1.113883.2.20.6.37" displayName="approved"/> 965       <statusCode code="active"/> 966       <effectiveTime><!‐‐ regulatory status of this package ‐‐>        967         <low value="20170101"/><!‐‐ Date of Initial Approval ‐‐>         968         <high value="20180101"/><!‐‐ Date of DIN cancellation ‐‐>         969       </effectiveTime> 970     </marketingAct> 971   </subjectOf> 972 </asContent> 973 

2.6.4.3 Validation rules 974 

1. There is not more than one regulatory status on any one item. 975 

2. Regulatory status code is from the code system 2.16.840.1.113883.2.20.6.37 and the display 976 

name matches the code.  977 

3. If the status code is Approved, then there is a low value (marketing start date) and no high 978 

value (marketing end date). 979 

4. If the marketing status code is Cancelled, then there is a low and high value. 980 

5. The effective time low and effective time high have at least the precision of day in the 981 

format YYYYMMDD. 982 

6. If there is an effective time high value, then it is not less than the low value. 983 

2.6.5 Regulatory activity and control number 984 

2.6.5.1 Description 985 

The <approval> structure specifies the regulatory activity and, if applicable, the control number 986 under which the product is approved. The control number is captured in the <id extension>.  987 

2.6.5.2 XML sample 988 

<subjectOf><!‐‐Regulatory Activity associated with this products status‐‐>   989   <approval> 990     <id extension="123456" root="2.16.840.1.113883.2.20.6.49"/><!‐‐ Control Number ‐‐>     991 

Page 29: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 29 

    <code code="2" codeSystem="2.16.840.1.113883.2.20.6.11" displayName="SNDS"/> 992     <author> 993       <territorialAuthority>P 994         <territory> 995           <code code="1" codeSystem="2.16.840.1.113883.2.20.6.17" displayName="canada"/> 996         </territory> 997       </territorialAuthority> 998     </author> 999   </approval> 1000 </subjectOf> 1001 

2.6.5.3 Validation rules 1002 

1. There is one marketing category for every product and product part. 1003 

2. There is a regulatory activity code from the code system 2.16.840.1.113883.2.20.6.11 and 1004 

the display name matches the code. 1005 

3. Territorial authority is the code for Canada from the code system 1006 

2.16.840.1.113883.2.20.6.17 and the display name matches the code. 1007 

2.6.6 Regulatory status of the manufactured product 1008 

2.6.6.1 Description 1009 

The <code> indicates the activity of “marketing” (or in cases of some packages as “marketing of 1010 sample packages not for sale”). The status of the product is described in the <statusCode> as 1011 either “active” for being on the market or “completed” when marketing is done the product is 1012 no longer going to be available on the market. The date when the product is on or off the 1013 market is included in the <effectiveTime>. The date when the product is on the market is 1014 characterized by the <low value>. 1015 

The date off the market such as the expiration date of the last lot released to the market is 1016 characterized by the <high value>. 1017 

2.6.6.2 XML sample 1018 

<subjectOf><!‐‐Regulatory status of this product‐‐>  1019   <marketingAct> 1020     <code code="1" codeSystem="2.16.840.1.113883.2.20.6.37" displayName="approved"/> 1021     <statusCode code="active"/> 1022     <effectiveTime> 1023       <low value="20170101"/> 1024     </effectiveTime> 1025   </marketingAct> 1026 </subjectOf> 1027 

  1028 

Page 30: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 30 

2.6.6.3 Validation 1029 

1. There is not more than one regulatory status on any one item. 1030 

2. Regulatory status code is from the code system 2.16.840.1.113883.2.20.6.37 and the display 1031 

name matches the code.  1032 

3. If the status code is active or new, then there is a low value (marketing start date) and no 1033 

high value (marketing end date). 1034 

4. The effective time low value (Notice of Compliance date) and high value (DIN Cancellation 1035 

date) have at least the precision of day in the format YYYYMMDD. 1036 

5. If the regulatory status code is approved, dormant or marketed, there is only a low value. 1037 

6. If the regulatory status code is cancelled, then there is a low and high value. 1038 

2.6.7 Product characteristics 1039 

Product characteristics include a range of items that includes: the scheduling symbol, the 1040 therapeutic class, pharmaceutical standard, colour, score, shape, size, imprint and image 1041 flavour.  1042 

Characteristic value types are as follows: 1043 

• Physical Quantity (PQ): A dimensioned quantity expressing the result of measuring. 1044 • Integer Number (INT): Integer numbers (‐1,0,1,2, 100, 3398129, etc.) are precise 1045 

numbers that are results of counting and enumerating. Integer numbers are discrete, 1046 the set of integers is infinite but countable. No arbitrary limit is imposed on the range of 1047 integer numbers. Two NULL flavors are defined for the positive and negative infinity. 1048 

• Interval (IVL): A set of consecutive values of an ordered base data type. 1049 • Interval of Physical Quantities (IVL_PQ): A range of physical quantity can either be 1050 

expressed using "low" and "high" child elements to define the bounds of the interval (if 1051 only one of these is sent, then the other is assumed to be unbounded), or by sending 1052 the "center" element to express a single quantity instead of a range. The IVL_PQ flavour 1053 is used when there is a single value in an attribute that is able to contain an interval of 1054 quantity values. This is equivalent to Quantity in Standard Units. 1055 

• Coded Value (CV): Coded data, specifying only a code, code system, and optionally 1056 display name and original text. Used only as the type of properties of other data types. 1057 

• Coded with Equivalents (CE): Coded data that consists of a coded value and, optionally, 1058 coded value(s) from other coding systems that identify the same concept. Used when 1059 alternative codes may exist. 1060 

• Character String (ST): The character string data type stands for text data, primarily 1061 intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, 1062 symbols, and formal expressions. 1063 

• Encapsulated Data (ED): Data that is primarily intended for human interpretation or for 1064 further machine processing outside the scope of HL7. This includes unformatted or 1065 formatted written language, multimedia data, or structured information in as defined by 1066 a different standard (e.g., XML‐signatures.) Instead of the data itself, an ED may contain 1067 only a reference (see TEL.) Note that ST is a specialization of the ED where the 1068 mediaType is fixed to text/plain. 1069 

Page 31: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 31 

• Boolean (BL): BL stands for the values of two‐valued logic. A BL value can be either true 1070 or false, or, as any other value may be NULL. 1071 

2.6.7.1 XML sample – characteristics 1072 

<subjectOf>  1073   <characteristic> 1074     <code code="0" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="product class"/> 1075     <value code="2" codeSystem="2.16.840.1.113883.2.20.6.53" displayName="product class 1076 display name" 1077       xsi:type="CE"> 1078       <originalText>biologic</originalText> 1079     </value> 1080   </characteristic> 1081 </subjectOf> 1082 <subjectOf> 1083   <characteristic> 1084     <code code="colour" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="colour"/> 1085     <value code="2" codeSystem="2.16.840.1.113883.2.20.6.24" displayName="blue display 1086 name" 1087       xsi:type="CE"> 1088       <originalText>light blue</originalText> 1089     </value> 1090   </characteristic> 1091 </subjectOf> 1092 <subjectOf> 1093   <characteristic> 1094     <code code="shape" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="shape"/> 1095     <value code="1" codeSystem="2.16.840.1.113883.2.20.6.25" displayName="shape diplay 1096 name" 1097       xsi:type="CE"> 1098       <originalText>shape</originalText> 1099     </value> 1100   </characteristic> 1101 </subjectOf> 1102 <subjectOf> 1103   <characteristic> 1104     <code code="size" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="size"/> 1105     <value unit="mm" value="10" xsi:type="PQ"/> 1106   </characteristic> 1107 </subjectOf> 1108 <subjectOf> 1109   <characteristic> 1110     <code code="score" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="score"/> 1111     <value value="1" xsi:type="INT"/> 1112   </characteristic> 1113 

Page 32: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 32 

</subjectOf> 1114 <subjectOf> 1115   <characteristic> 1116     <code code="imprint" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="imprint"/> 1117     <value xsi:type="ST">value</value> 1118   </characteristic> 1119 </subjectOf> 1120 <subjectOf> 1121   <characteristic> 1122     <code code="flavour" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="flavour"/> 1123     <value code="1" codeSystem="2.16.840.1.113883.2.20.6.26" xsi:type="CE"> 1124       <originalText>new almond</originalText> 1125     </value> 1126   </characteristic> 1127 </subjectOf> 1128 <subjectOf> 1129   <characteristic> 1130     <code code="image" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="image"/> 1131     <value xsi:type="ED" mediaType="image/jpeg"> 1132       <reference value="filename.jpg"/> 1133     </value> 1134   </characteristic> 1135 </subjectOf> 1136 <subjectOf> 1137   <characteristic> 1138     <code code="13" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="Pharmaceutical 1139 Standard"/> 1140     <value code="7" codeSystem="2.16.840.1.113883.2.20.6.5" displayName="display name" 1141 xsi:type="CV"/> 1142   </characteristic> 1143 </subjectOf> 1144 <subjectOf> 1145   <characteristic> 1146     <code code="14" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="scheduling 1147 symbol"/> 1148     <value code="1" codeSystem="2.16.840.1.113883.2.20.6.2" displayName="Pr" 1149       xsi:type="CV"/> 1150   </characteristic> 1151 </subjectOf> 1152 <subjectOf> 1153   <characteristic> 1154     <code code="15" codeSystem="2.16.840.1.113883.2.20.6.23" displayName="therapeutic 1155 class"/> 1156     <value code="1" codeSystem="2.16.840.1.113883.2.20.6.6" displayName="display name" 1157       xsi:type="CV"/> 1158 

Page 33: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 33 

  </characteristic> 1159 </subjectOf> 1160 

2.6.7.2 Validation 1161 

1. There is a characteristic code from the code system 2.16.840.1.113883.2.20.6.23 and the 1162 

display name matches the code. 1163 

2. There is a characteristic value code from the corresponding code system and the display 1164 

name matches the code.  1165 

3. The characteristic value code is compliant with the specified value typev. 1166 

4. Value type is PQ, INT, IVL_PQ, CV, CE, ST, ED, or BL. 1167 

2.6.8 Route of administration 1168 

2.6.8.1 Description 1169 

The route of administration for the product. 1170 

2.6.8.2 XML sample 1171 

<consumedIn> 1172   <substanceAdministration> 1173     <routeCode code="56" codeSystem="2.16.840.1.113883.2.20.6.7" displayName="oral"/> 1174   </substanceAdministration> 1175 </consumedIn> 1176 

2.6.8.3 Validation 1177 

1. There is a route of administration code from the code system 1178 2.16.840.1.113883.2.20.6.7 and the display name matches the code. 1179 

2.7 Narrative text sections 1180 

2.7.1 General 1181 

The narrative text that makes up the Title Page, Part I: Health Professional Information, Part II: 1182 Scientific Information and Part III: Patient Medication Information.  1183 

The human readable text content of the document is contained within the <text> element. The 1184 actual content is contained within a <paragraph>, <table>, and/or <list>.  1185 

• If a section consists only of nested sections, the <text> tag is not included.  1186 • Elements that can be used within the <text> element to capture the human readable 1187 

content include paragraphs (<paragraph>), lists (<list>), tables (<table>) and images 1188 (<renderMultimedia>).  1189 

• Elements permitted as children of the <text> element, used as children of the 1190 <paragraph> element or within <table> and <list> include superscripts (<sup>), 1191 subscripts (<sub>), links (<linkHtml>), line breaks (<br>), footnotes (<footnote>), 1192 footnote references (<footnoteRef>).  1193 

• Images may be included in the content of labeling using the <renderMultiMedia> tag. 1194 This tag may be used as a direct child of <text> for ‘block’ images or as a child of 1195 <paragraph> for inline images. 1196 

Page 34: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 34 

2.7.1.1 Formatting 1197 

There are certain aspects of the content that must be specified in the source to insure that the 1198 content of labeling is formatted correctly when rendered, as an example: 1199 

<text> 1200  <paragraph> 1201 

The next snippet <content styleCode="bold italics">will appear as bold italics</content> in the 1202 rendering. 1203 

</paragraph> 1204 

</text> 1205 

Will be rendered as: The next snippet will appear as bold italics in the rendering. 1206 

The <content styleCode=””> can be nested, for example:  1207 

<text> 1208  <paragraph> 1209  <content styleCode="bold italics">bold italics</content> 1210  1211 But it can also be represented as: 1212 <text> 1213  <paragraph> 1214  <content styleCode="bold”> 1215 

<content styleCode="italics”> bold italics.</content> 1216  </content> 1217 

Both of the above will appear as bold italics  1218 

The values for <styleCode> for font effect are bold, italics and underline. To assist people who 1219 are visually impaired, the <styleCode=”emphasis”> is used to prompt computer screen reader 1220 programs to emphasize text such as a box warning. The bold, italics and underline font effects 1221 may be used together with each other and the emphasis styleCode. For example: 1222 

<content styleCode=”bold”> 1223  <content styleCode=”emphasis”> 1224  </content> 1225 </content> 1226 

Will appear as bold and be emphasized by screen reader programs.  1227 

2.7.1.2 Symbols and special characters 1228 

Special characters can be included in the text. Superscripts and subscripts are accomplished 1229 using the <sup> and <sub> tags.  1230 

Since the SPL encoding is UTF‐8, any Unicode character can be included as is. Unicode 1231 references may also be inserted as either &#dddd; where dddd is the Unicode value in decimal 1232 notation or &#xdddd; where dddd is the Unicode value in hexadecimal notation. The font used 1233 in the standard HPFB stylesheet is a Unicode font assuring that most Unicode characters will be 1234 rendered correctly if viewed by a browser supporting this font.  1235 

Page 35: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 35 

The only prohibited characters in XML that cannot be directly used are less‐than “<” (because 1236 SPL XML tags begin with it) and ampersand “&” (because XML entity references begin with it). 1237 Use of these two symbols must be replaced by the XML entity references &lt; and &amp.  1238 

2.7.1.3 Footnotes 1239 

The SPL schema includes a specific footnote element <footnote>. Footnotes are rendered 1240 automatically by the standard HPFB stylesheet. <footnoteRef> is used to refer to another 1241 (usually earlier) footnote. For example,  1242 

<footnote ID=”testNote”>This is the footnote content</footnote> 1243 

will generate the following footnote at the appropriate end of a section. “This is footnote 1244 content”. 1245 

The <footnoteRef> element with the appropriate IDREF attribute, e.g., 1246 <footnoteRefIDREF=”testNote”/> will display the footnote reference in the text corresponding 1247 to the footnote with the same ID.  1248 

Footnotes are rendered by the standard HPFB stylesheet using Arabic numbers; e.g., 1,2 3. 1249 Footnotes within tables are rendered at the bottom of the table. 1250 

2.7.1.4 Lists 1251 

All lists are marked up using the <list> tag, and each item in a list is marked with an <item> tag. 1252 The ‘listType’ attribute identifies the list as ordered (numbered) or unordered (bulleted). The 1253 default numbering and bulleting are controlled by the standard HPFB stylesheet. 1254 

<text>  1255 

<paragraph>Fist Para ...</paragraph>  1256 

<list listType="ordered" styleCode="BigRoman">  1257 

<item>Fist Item</item>  1258 

<item>Second Item</item>  1259 

</list>  1260 

<paragraph>2nd Para ...</paragraph>  1261 

</text> 1262 

Lists featuring a standard set of specialized markers (standard specialized lists) can be created 1263 using the styleCode attribute with the <list> element. Options available for ordered lists are:  1264 

• Arabic (List is ordered using Arabic numerals: 1, 2, 3)  1265 • LittleRoman (List is ordered using little Roman numerals: i, ii, iii)  1266 • BigRoman (List is ordered using big Roman numerals: I, II, III)  1267 • LittleAlpha (List is order using little alpha characters: a, b, c)  1268 • BigAlpha (List is ordered using big alpha characters: A, B, C)  1269 

For example: <list listType="ordered" styleCode="LittleRoman">  1270 

For unordered lists the following options exist:  1271 

• Disc (List bullets are simple solid discs: ●)  1272 

Page 36: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 36 

• Circle (List bullets are hollow discs: ○)  1273 • Square (List bullets are solid squares: ■)  1274 

For example: <list listType=”unordered” styleCode=”Disc”>  1275 

In addition to the standard specialized lists, user‐defined characters are also permitted as 1276 markers by nesting <caption> within the <item> tag. Note that any character, XML entity, or 1277 Unicode symbol, may be used in the <caption>, and that the <caption> for each <item> are not 1278 restricted to the same character. For example: <item><caption>*</caption> the asterisk is used 1279 as item marker here.<item>. 1280 

2.7.1.5 Tables 1281 

Tables can be created with the full structure (header (e.g. for column names), body (e.g. for the 1282 rows of the table) and footer e.g. for table footnotes)). The element <tbody> is required for an 1283 SPL table while the elements <thead> and <tfoot> are optional in the SPL schema. The structure 1284 will display a standard typographical table with rules between the caption (table title) and 1285 head, the head and body, and the body and <tfoot>. If a <tfoot> element is included and 1286 footnotes are present in a table, then footnotes are rendered after the existing content of the 1287 <tfoot> element.  1288 

It is recommended to always start with a standard table (i.e. <thead> and <tbody> elements) 1289 and test to see whether the rendering is unambiguous and interpretable. In the unusual 1290 situation where additional formatting is needed, the rule styleCode specified or certain 1291 attributes may be used to modify the table.  1292 

The rule codes are as follows (note that the control names are case sensitive): 1293 

• Rule on left side of cell is Lrule  1294 • Rule on right side of cell is Rrule  1295 • Rule on top of cell is Toprule  1296 • Rule on bottom of cell is Botrule  1297 

Note: More than one rule control may be used in a cell, e.g., <td styleCode code=”Botrule 1298 Lrule”>Cell content</td>. 1299 

Rule control codes should be used only when necessary for the interpretability of the table. Use 1300 of these codes may result in overriding the default rules for tables. Rather than setting the rule 1301 for each cell, table rules may also be controlled according to entire rows or columns by use of 1302 the styleCode attributes with <col>, <colgroup>, <thead>, <tfoot>, <tbody> and <tr> elements.  1303 

To make rowgroups appear with horizontal rules, use the styleCode attribute "Botrule" with the 1304 appropriate <tr> element. The Botrule value is rarely needed on the <td> element. 1305 

The preferred method for using vertical rules is to define colgroup with styleCode="Lrule” or 1306 “Rrule" (or both). Only if this does not yield the desired vertical rule should the Lrule or Rrule 1307 code value with styleCode attributes on the <td> or <th> element itself be used. Note: In 1308 general, vertical rules should not be used. Good typography for tables means using few vertical 1309 rules.  1310 

To merge cells vertically and horizontally, the rowspan and colspan attributes should be used 1311 on the <td>element.  1312 

Page 37: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 37 

To determine the width of a table, the width attribute may be used on the <table> element and 1313 to determine the width of a table column, the width attribute may be used on the <col> and 1314 <colgroup> elements. Note: best practice is to omit the width aspect. This ensures the 1315 rendering is done to the width. The only time the width should be specified is when the 1316 information is to be smaller than the standard width and in those cases a relative size (%) 1317 should be used. 1318 

For horizontal alignment, the preferred method for aligning cell content within the margins is to 1319 use <col align=”.. ”/> in the <colgroup> element, though this can be used in the <colgroup> 1320 element as well. Valid values for align are “left”, “center”, “right”, “justify” (for full justification 1321 of contents within the cells), and “char” (for character alignment within the cells). Using the 1322 <col align=”.. ”/> markup ensures that the contents for all cells in the column share the same 1323 alignment. 1324 

For vertical alignment, the valign attribute can be used within cells. For cases in which the cell 1325 alignment must be different from other cells in the column, align is also available as an attribute 1326 on the other table elements, including <td>.  1327 

Markup for table footnote is rendered in the <tfoot> tag. This element does not need to be 1328 included in SPL; the standard stylesheet will include a <tfoot> tag if a <footnote> element is 1329 present within either the <thead> or <tbody> sections. A <tfoot> section should be included in 1330 SPL only if there is additional information other than footnotes that needs to be rendered in 1331 this section.  1332 

For table text spacing, in some instances, the use of a “tab” or text indentation is desirable in a 1333 given table cell. In an SPL document, this effect is achieved by using the nonbreaking space 1334 (&#160;) as if it were a “tab” space. As the following snippet of XML shows, two nonbreaking 1335 spaces were used to offset the word “Male” from the margin: <td>&#160;&#160;Male</td>. 1336 The nonbreaking space can also be used to keep text in a table from breaking inappropriately 1337 due to browser resizing.  1338 

2.7.1.6 Hypertext links 1339 

SPL offers hypertext linking capabilities generally similar to those found in the HTML 1340 specification.  1341 

Links are specified by the <linkHtml> construct, where the value for the href attribute of 1342 <linkHtml> (the target of the link) is the ID attribute value of a <section>, <paragraph>, <table>, 1343 <list>, <content>,<renderMultimedia> element. The stylesheet does not support the styleCode 1344 attribute of the <linkHtml> element; if a styleCode is needed for a link, this should be coded via 1345 the <content> element within the link as with other text. 1346 

2.7.1.7 Recent major label changes 1347 

SPL offers a notation to identify recent major changes in the product monograph text including 1348 table elements <table> and table data <td>. The recent major text is tagged using the <content 1349 styleCode=“xmChange”>, for example: 1350 

<text>This is an example of text that is not changed. 1351 <content styleCode=“xmChange”> 1352 

This is an example of text that is a recent major change 1353 

Page 38: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 38 

</content> 1354 This is an example of changed text that is not considered a recent major change 1355 

</text>  1356 

2.7.1.8 XML sample 1357 

      <component><!‐‐ Part I: Health Professional Information ‐‐> 1358         <section ID="L16a947eb‐e2be‐45c0‐8b2e‐15d0d0eebea8"> 1359           <id root="e6bb83b9‐2602‐4f96‐9077‐b8b9535c254e"/> 1360           <code code="P1" codeSystem="2.16.840.1.113883.2.20.6.8" displayName="Part I: Health 1361 Professional Information"/> 1362           <title>Part I: Health Professional Information</title> 1363           <effectiveTime value="20180101"/> 1364           <component> 1365             <section ID="L52ea4fad‐2b79‐4dbc‐8d99‐6843adc2dec8"> 1366               <id root="9a3f869a‐7734‐425a‐85d8‐b8bd4d3500a5"/> 1367               <code code="P1‐1" codeSystem="2.16.840.1.113883.2.20.6.8" displayName="1 1368 Indications"/> 1369               <title>1 Indications</title> 1370               <text> 1371                 <paragraph> 1372                   sample text 1373                 </paragraph> 1374               </text> 1375               <effectiveTime value="20180101"/> 1376               <component> 1377                 <section ID="f2aa7e0e‐2042‐4a4c‐a783‐9ad4e8717a32"> 1378                   <id root="b9db4be0‐3f46‐437a‐bd7b‐4a3e010adaad"/> 1379                   <code code="P1‐1.1" codeSystem="2.16.840.1.113883.2.20.6.8" displayName="1.1 1380 Pediatrics"/> 1381                   <title>1.1 Pediatrics</title> 1382                   <text> 1383                     <paragraph> 1384                       sample text 1385                     </paragraph> 1386                   </text> 1387                   <effectiveTime value="20180101"/> 1388                 </section> 1389               </component> 1390 

2.7.1.9 Validation rules – narrative text 1391 

1. Text is enclosed under <paragraph>, <list>, or <table> elements. 1392 

Page 39: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 39 

2.7.2 Images 1393 

2.7.2.1 Description 1394 

The SPL schema uses <observationMedia> elements to identify graphic files to be rendered at 1395 the locations where they are referenced by <renderMultiMedia> elements in the <section>. An 1396 image in a SPL will be rendered wherever it is referenced by the renderMultimedia markup, no 1397 matter where the observationMedia markup appears.  1398 

The referencedObject attribute of the renderMultiMedia element identifies the corresponding 1399 observationMedia instance by means of its ID identifier such as <renderMultiMedia 1400 referencedObject="MM1"/>. For example, 1401 

<section>  1402  <text>  1403 

 <paragraph>...</paragraph>  1404  <renderMultiMedia referencedObject="MM1"/>  1405  <paragraph>...</paragraph>  1406 

 </text>  1407   <component>  1408 

 <observationMedia ID="MM1">  1409  <text>descriptive text</text> 1410  <value xsi:type="ED" mediaType="image/jpeg"> 1411 

 <reference value="filename.jpg"/>  1412  </value>  1413 

 </observationMedia>  1414  </component>  1415 

</section> 1416 

The <observationMedia> element does not contain the graphics file, but instead points at the 1417 file.  1418 

For image placement, if an image is a block image (i.e., should appear in its own space), insert 1419 the renderMultimedia tag between <paragraph> elements. If an image is inline (i.e., should 1420 appear alongside text), insert the renderMultimedia tag in the text of a <paragraph> as 1421 appropriate. Inline images are expected to be uncommon and basically represent symbols that 1422 cannot be represented by Unicode characters. In addition, <caption> are not applicable for 1423 inline images since these are not offset from the surrounding text.  1424 

The standard HPFB stylesheet does not perform any resizing of graphics or changing the 1425 resolution of graphics files. Thus, all images are rendered in the browser as‐is, with all 1426 characteristics of the actual graphic file itself. To ensure that a graphic will appear as desired, it 1427 is important that the graphic file is edited to a dimension appropriate for its presentation within 1428 the browser. If this is not done, the appearance of the graphic may reduce the readability of the 1429 file. JPEG image file type using appropriate pixels per inch for images for viewing in a browser 1430 using the standard HPFB style sheet.  1431 

Only file formats detailed in Error! Reference source not found. are permitted 1432 

  1433 

Page 40: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 40 

2.7.2.2 Validation rules 1434 

1. There is text. 1435 

2. Value xsi:type is as above. 1436 

3. Media type is image/jpeg. 1437 

4. Reference value is the file name for a valid image. 1438 

5. Size of image file is less than 1 MB. 1439 

6. File is a JPEG image and the name has the extension “.jpg”. 1440 

7. Image components are referenced at least once in the text of any section. 1441 

8. Image reference in text has an image “observationMedia” element with a matching ID in 1442 

the same document. 1443 

2.7.3 Title page 1444 

2.7.3.1 Description 1445 

The title page of the product monograph which includes the title, company name and address, 1446 control number, date of initial approval and date of last revision. 1447 

2.7.3.2 XML sample 1448 

      <component><!‐‐Title Page section‐‐> 1449         <section ID="Ld8d30d86‐e343‐48f4‐9cec‐524834b3803b"> 1450           <id root="eed00b53‐cdb2‐4aa6‐9e82‐88b7d793b208"/> 1451           <code code="TP" codeSystem="2.16.840.1.113883.2.20.6.8" displayName="title page"/> 1452           <title>Title Page</title> 1453           <effectiveTime value="20180101"/> 1454           <component> 1455             <section ID="Lbe75cfb9‐3131‐4903‐800b‐267427388a13"> 1456               <id root="b9db4be0‐3f46‐437a‐bd7b‐4a3e010adaad"/> 1457               <code code="TP‐1.1" codeSystem="2.16.840.1.113883.2.20.6.8" 1458 displayName="TITLE"/> 1459               <title>title</title> 1460               <text> 1461                 <paragraph> 1462                   Scheduling Symbol, Brand Name, Proper name, Dosage Form(s), Strength(s) and 1463                   Route(s) of Administration, Pharmaceutical Standard, Pharmaceutical Standard, 1464 Pharmaceutical 1465                   Standard, Therapeutic Classification 1466                 </paragraph> 1467               </text> 1468               <effectiveTime value="20180101"/> 1469             </section> 1470           </component> 1471           <component> 1472             <section ID="f187daf9‐5e75‐425a‐9de6‐f6ce1af2a965"> 1473               <id root="ac26f58c‐721a‐4c51‐8bbc‐c9dddb1f1233"/> 1474 

Page 41: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 41 

              <code code="TP‐1.2" codeSystem="2.16.840.1.113883.2.20.6.8" 1475 displayName="Company Name and address"/> 1476               <title>Company Name and Address</title> 1477               <text> 1478                 <paragraph> 1479                   Company Name and Address 1480                 </paragraph> 1481               </text> 1482               <effectiveTime value="20180101"/> 1483             </section> 1484           </component> 1485           <component> 1486             <section ID="bf2dab4e‐fd04‐4ec9‐9cdc‐247188622d0f"> 1487               <id root="v5f1dea3‐d907‐4664‐b46f‐e1d9736d47af"/> 1488               <code code="TP‐1.3" codeSystem="2.16.840.1.113883.2.20.6.8" displayName="DATE 1489 OF INITIAL APPROVAL"/> 1490               <title>Date of Initial Approval</title> 1491               <text> 1492                 <effectivetime> 1493                   <low value="20170101"/> 1494                 </effectivetime> 1495               </text> 1496               <effectiveTime value="20180101"/> 1497             </section> 1498           </component> 1499           <component> 1500             <section ID="k0184119‐8fd7‐4378‐af77‐b227c39e8445"> 1501               <id root="ad78301c‐29a9‐41af‐96f8‐d58815fed296"/> 1502               <code code="TP‐1.4" codeSystem="2.16.840.1.113883.2.20.6.8" displayName="DATE 1503 OF REVISION"/> 1504               <title>Date of Revision</title> 1505               <text> 1506                 <effectivetime> 1507                   <high value="20180101"/> 1508                 </effectivetime> 1509               </text> 1510               <effectiveTime value="20180101"/> 1511             </section> 1512           </component> 1513           <component> 1514             <section ID="ebc3f3dc‐71be‐424f‐91ef‐8aca8c138b21"> 1515               <id root="efd8c4c1‐d0dd‐434d‐b1c2‐4daa18752fa8"/> 1516               <code code="TP‐1.5" codeSystem="2.16.840.1.113883.2.20.6.8" 1517 displayName="CONTROL NUMBER"/> 1518               <title>Control Number</title> 1519 

Page 42: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 42 

              <text> 1520                 <paragraph> 1521                   123456 1522                 </paragraph> 1523               </text> 1524               <effectiveTime value="20180101"/> 1525             </section> 1526           </component> 1527         </section> 1528       </component> 1529 

2.7.3.3 Validation rules 1530 

1. Date of initial approval and date of revision are encoded with an effective time low value 1531 

and high value. 1532 

2. The control number is a six digit integer with no other text. 1533 

2.7.4 Recent major changes 1534 

2.7.4.1 Description 1535 

List the section headings in the product monograph where any major label changes related to 1536 safety and efficacy have been made within the past 24 months, under the following sections: 1537 

• Serious Warnings and Precautions Box 1538 • Indications 1539 • Contraindications 1540 • Dosage and Administration 1541 • Warnings and Precautions 1542 

2.7.4.2 XML sample 1543 

      <component><!‐‐ Recent Major Changes ‐‐> 1544         <section ID="l7cee5c8‐7ee9‐4fd2‐884e‐7a50c06b27e1"> 1545           <id root="dd1e1c43‐f0d3‐4ba8‐b1f5‐ad009a5dd5a8"/> 1546           <code code="RMLC" codeSystem="2.16.840.1.113883.2.20.6.8" displayName="RECENT 1547 MAJOR LABEL CHANGES"/> 1548           <title>Recent Major Label Changes</title> 1549           <text> 1550             <paragraph> 1551               Section Heading, Subsection heading (Section or Subsection number), yyyymmdd 1552             </paragraph> 1553           </text> 1554           <effectiveTime value="20180101"/> 1555         </section> 1556       </component> 1557 

2.7.4.3 Validation rules 1558 

1. No specific validation rules other than what is described in Section 0. 1559 

Page 43: Draft Guidance Document · 161 Structured Product Labeling (SPL) is a Health Level Seven International (HL7) standard which 162 defines the content of human prescription drug labeling

 

Validation Rules for Product Monographs in the Extensible Markup Language Format   | 43 

3. Appendices 1560 

3.1 Appendix A – glossary 1561 

Acronyms 1562 

DIN  Drug Identification Number 

eCTD  Electronic Common Technical Document 

GUID  Globally Unique Identifier 

HL7  Health Level 7 

HPFB  Health Products and Food Branch 

HTML  Hypertext Markup Language 

ID  Identifier 

IDMP  Identification of Medicinal Product 

ISO  International Organization for Standardization  

JFIF  JPEG File Interchange Format 

JPEG  Joint Photographic Experts Group 

OID  Object Identifier 

PDF  Portable Document Format 

SPL  Structured Product Label 

UTF  Unicode Transformation Format 

W3C  World Wide Web Consortium 

XML  Extensible Markup Language 

3.2 Appendix B – references 1563 

1. Guidance Document: Preparation of Product Monographs in the Extensible Markup 1564 Language Format  1565 

2. Guidance Document ‐ Product monograph 1566 3. Guidance Document Questions and Answers: Plain Language Labelling Regulations 1567 4. HL7 SPL Release 7 specification 1568