Règles de validation pour les monographies de produit en format XML ("Extensible Markup Language")
Date : 1 septembre 2022
Notre numéro de dossier : 9999
Santé Canada a actualisé les règles de validation pour les monographies de produit (MP) en format XML à la suite d'une période d'essais de production. Ces règles sont élaborées conformément aux renseignements fournis dans les documents suivants :
- Document d'orientation : Préparation des monographies de produit en format "Extensible Markup Language"
- Secrétariat américain aux produits alimentaires et pharmaceutiques : Structured Product Labeling (SPL) Implementation Guide with Validation Procedures (en anglais seulement)
Les règles de validation ont pour but de s'assurer que les promoteurs fournissent un fichier XML valide (et les images qui s'y rattachent) à Santé Canada et de réduire les erreurs et le suivi auprès des promoteurs. On encourage les promoteurs à utiliser un outil offert sur le marché pour valider leurs MP XML avant de les soumettre à Santé Canada.
Santé Canada valide chaque MP XML dès qu'elle est reçue. Un rapport de validation de MP XML décrivant toutes les erreurs ainsi que les avertissements et les énoncés sera acheminé par courriel au promoteur dans un fichier PDF en pièce jointe. Même si les présentations au format eCTD ne seront pas retardées pour le moment, on s'attend à ce que les promoteurs corrigent toutes les erreurs en temps opportun.
Version des règles de validation pour les MP XML : 2.1
Date d'entrée en vigueur : 2022-09-01
Si vous avez des questions concernant le contenu du présent document, veuillez les faire parvenir par courriel à l'adresse xmlpm-pmxml@hc-sc.gc.ca.
| Date | Version | Résumé des modifications |
|---|---|---|
| 2022-09-01 | 2.1 | 2.02 : Emplacement de la feuille de style révisée |
| ID# | Nom de la règle | Description de la règle | Gravité |
|---|---|---|---|
| 1 | Généralités | ||
| 1.01 | Fichier XML | Les fichiers XML doivent être bien structurés et être conformes au schéma. | Erreur |
| 1.02 | Type de fichier image | Les fichiers image incorporés par renvoi doivent être sous format JPEG avec l'extension.jpeg. | Erreur |
| 1.03 | Emplacement du fichier | Tous les fichiers image incorporés par renvoi doivent se trouver dans le même dossier que le fichier XML. | Erreur |
| 1.04 | Nom du fichier XML | Les fichiers XML doivent être intitulés avec le GUID ("Globally Unique Identifier") provenant de l'attribut <document> <ID> root. | Erreur |
| 1.05 | GUID | L'attribut <setID> root et l'attribut <id> root doivent contenir une valeur, être uniques et être un GUID. Les GUID doivent respecter les règles de structure canonique, de contenu et de formatage : affichés en cinq groupes séparés par des tirets, dans le format 8-4-4-4-12, pour un total de 36 caractères (32 caractères alphanumériques et quatre tirets); seuls le tiret et les caractères a à f et 0 à 9 sont autorisés. Nota : Cette règle ne s'applique pas à l'attribut <representedOrganization> root et à l'attribut <assignedOrganization> root. |
Erreur |
| 1.06 | Format de date | Les valeurs de date associées à <effectiveTime> doivent être fournies dans le format AAAAMMJJ. | Erreur |
| 1.07 | Vocabulaire contrôlé | Les valeurs codées et les noms affichés doivent correspondre au VC qui s'y rattache. | Erreur |
| 1.08 | Vocabulaire contrôlé | Les valeurs codées doivent comprendre un attribut codeSystem valide ou un attribut root et être présentes seulement dans un contexte admissible, tel qu'il est énoncé à l'Annexe 1. | Erreur |
| 1.09 | Vocabulaire contrôlé | Les termes de valeur codée utilisés doivent avoir le statut = Actif du système VC. D'autres valeurs de statut entraîneront des avertissements ou des erreurs. La gravité globale de la règle correspondra à la gravité la plus élevée des valeurs non actives en fonction du tableau suivant. |
- |
| 1.10 | Nom affiché | Les attributs displayName doivent correspondre au nom affiché du VC dans la langue correspondante. Cela ne s'applique pas aux éléments suivants :
|
Erreur |
| 1.11 | Extensions des identificateurs | Les attributs <id> extension ne doivent pas contenir d'espaces. | Erreur |
| 1.12 | Éléments vides | <text>, <title>, <caption> et <content> doivent contenir une valeur entre les balises d'ouverture et de fermeture. | Erreur |
| 1.13 | Caractéristiques | <characteristics> ne doit pas avoir un attribut classCode. | Erreur |
| 1.14 | Contenu dans l'en-tête des sections principales | L'en-tête des sections principales énumérées ci-dessous ne doit pas être immédiatement suivie de <text> ou <paragraph> :
|
Erreur |
| 1.15 | Éléments de données et attributs non applicables | Les éléments et attributs suivants ne doivent pas être utilisés :
|
Erreur |
| 1.16 | Commentaires | Les commentaires (c.-à-d. « <!-- --> ») ne sont pas autorisés. | Erreur |
| 2 | Prologue XML | ||
| 2.01 | Version XML | L'attribut de version <?xml> doit correspondre à « 1.0 ». L'attribut d'encodage doit correspondre à « UTF-8 ». | Erreur |
| 2.02 | Feuille de style | L'attribut <?xml-stylesheet> href doit correspondre à « https://health-products.canada.ca/product-monograph/style-sheet/v_#_#/spl_canada.xsl ». |
Erreur |
| 2.03 | Instructions de traitement | Seules les déclarations XML <?xml> et <?xml-stylesheet> sont autorisées. | Erreur |
| 2.04 | Versions des feuilles de style | Les valeurs pour la version de feuille de style "v_#_#" doivent être extraites du CV codeSystem 2.16.840.1.113883.2.20.6.65 et doivent être égales à un code CV. La sévérité globale de la règle sera la sévérité la plus élevée des valeurs non actives en fonction du table suivant. |
- |
| 3 | Document | ||
| 3.01 | Emplacement du schéma | L'attribut <document> xmlns doit correspondre à « urn:hl7-org:v3 ». L'attribut <document> xsi:schemaLocation doit correspondre à |
Erreur |
| 3.02 | Identificateur de document | L'attribut <document> <id> root doit contenir une valeur, être unique et être un GUID. | Erreur |
| 3.03 | Type de document | Les valeurs pour <document> <code> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.10. Plus précisément :
|
Erreur |
| 3.04 | Langue | Les valeurs pour <languageCode> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.29. Plus précisément :
|
Erreur |
| 3.05 | setId | L'attribut <setId> root doit contenir une valeur, être unique et être un GUID. | Erreur |
| 3.06 | Numéro de version | L'attribut <versionNumber> value doit être un nombre entier supérieur à zéro. | Erreur |
| 4 | Organisation (titulaire d'autorisation de mise sur le marché / importateur ou distributeur) | ||
| 4.01 | Entreprise | Les valeurs pour <representedOrganization> et <assignedOrganization> doivent être tirées du VC root 2.16.840.1.113883.2.20.6.31. Plus précisément :
|
Erreur |
| 4.02 | Pays | Les valeurs pour <country> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.17. Plus précisément :
|
Erreur |
| 4.03 | Titulaire d'autorisation de mise sur le marché | <representedOrganization> […] <addr> doit contenir une valeur pour :
|
Erreur |
| 4.04 | Distributeur ou importateur | Une <representedOrganization> dont l'attribut <country> code ne correspond pas à « CAN » doit contenir les renseignements <assignedOrganization> <contactParty>. | Erreur |
| 4.05 | Distributeur ou importateur canadien | L'attribut <assignedOrganization> […] <country> code doit correspondre à « CAN ». | Erreur |
| 4.06 | Adresse du distributeur ou de l'importateur | <assignedOrganization> […] <addr> doit contenir une valeur pour :
|
Erreur |
| 4.07 | Format de code postal | Le <postalCode> doit contenir des caractères alphanumériques. Les codes postaux canadiens doivent être indiqués dans le format « A1A 1A1 » avec un seul espace blanc séparant les troisième et quatrième caractères. | Avertissement |
| 4.08 | Coordonnées | Il doit y avoir trois éléments <telecom> avec une valeur d'attribut commençant par :
|
Avertissement |
| 4.09 | Adresse courriel | La valeur d'attribut <telecom> pour « mailto: » doit être dans le format local-part@domain. | Avertissement |
| 5 | Produit fabriqué | ||
| 5.01 | Identification numérique de drogue (DIN) | Le <manufacturedProduct> <code> est requis. La valeur d'attribut du code doit être un nombre à 8 chiffres qui peut commencer par des zéros. | Avertissement |
| 5.02 | Marque nominative | Le <manufacturedProduct> <name> doit contenir une valeur. | Avertissement |
| 5.03 | Forme posologique | Les valeurs pour <formCode> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.3. Plus précisément :
|
Erreur |
| 5.04 | Dénomination commune | Un <genericMedicine> <name> est requis. | Avertissement |
| 5.05 | Nom de l'ingrédient | Les valeurs pour <ingredientSubstance> <code> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.14. Plus précisément :
|
Erreur |
| 5.06 | Nom de l'ingrédient | Le <ingredientSubstance> <name> doit correspondre à l'attribut <ingredientSubstance> <code> displayName. | Erreur |
| 5.07 | Code de l'ingrédient | À l'intérieur d'un <manufacturedProduct>, l'attribut <ingredientSubstance> <code> code ne doit être utilisé qu'une seule fois. | Erreur |
| 5.08 | Rôle de l'ingrédient | Les valeurs pour <ingredient> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.39. Plus précisément :
|
Erreur |
| 5.09 | Concentration de l'ingrédient actif | Si l'attribut <ingredient> classCode correspond à « ACTIB », « ACTIM » ou « ACTIR », les champs <quantity> <numerator> et <quantity> <denominator> doivent contenir une valeur. | Erreur |
| 5.10 | Concentration de l'ingrédient | L'attribut value et l'attribut unit doivent contenir une valeur dans les champs <quantity> <numerator> et <quantity> <denominator>. | Erreur |
| 5.11 | Concentration de l'ingrédient | Les valeurs pour <quantity> <numerator> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.15. Plus précisément :
|
Erreur |
| 5.12 | Concentration de l'ingrédient | Les valeurs pour <quantity> <denominator> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.15. Plus précisément :
|
Erreur |
| 5.13 | Quantité | À l'intérieur d'un <manufacturedProduct>, tous les attributs <quantity> <denominator> value et les attributs unit doivent être les mêmes. | Erreur |
| 5.14 | Fourchette de concentrations de l'ingrédient actif | Si la <quantity> <numerator> est exprimée sous la forme d'une fourchette :
|
Erreur |
| 6 | Statut de l'emballage | ||
| 6.01 | Emballage | Chaque <manufacturedProduct> doit contenir <asContent>. | Erreur |
| 6.02 | Identificateur d'emballage | L'attribut <containerPackagedProduct> <code> code doit contenir une valeur. | Énoncé |
| 6.03 | Description de l'emballage - quantité | Chaque <manufacturedProduct> <asContent> <quantity> doit contenir un attribut <numerator> value et un attribut <denominator> value. | Erreur |
| 6.04 | Description de l'emballage | L'attribut <quantity> <numerator> value doit être supérieur à zéro et l'attribut unit doit contenir une valeur. | Erreur |
| 6.05 | Description de l'emballage - unités | L'attribut <quantity> <numerator> unit doit être un code tiré du VC codeSystem 2.16.840.1.113883.2.20.6.15. | Erreur |
| 6.06 | Description de l'emballage intérieur | L'occurrence la plus à l'extérieur de l'attribut <asContent> <quantity> <numerator> unit doit correspondre à l'attribut <ingredient> <quantity> <denominator> unit. | Erreur |
| 6.07 | Description de l'emballage - hiérarchie | Si un <asContent> contient un <asContent> imbriqué, l'attribut supérieur de <quantity> <denominator> unit doit correspondre à l'attribut inférieur de <asContent> <quantity> <numerator> unit. Remarque : l'attribut unit peut être vide, ce qui représente « 1 ». |
Avertissement |
| 6.08 | Description de l'emballage intérieur | L'occurrence la plus à l'extérieur de l'attribut <asContent> <quantity> <denominator> value doit correspondre à 1. L'occurrence la plus à l'extérieur de l'attribut <asContent> <quantity> <denominator> unit, le cas échéant, doit correspondre à 1. |
Erreur |
| 6.09 | Type d'emballage | Les valeurs pour <formCode> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.32. Plus précisément :
|
Erreur |
| 6.10 | Type d'emballage | Un attribut <containerPackagedProduct> <formCode> code ne peut figurer qu'une seule fois dans la hiérarchie d'un emballage donné. P. ex., une boîte ne peut contenir une boîte. | Erreur |
| 6.11 | Statut de l'emballage | <manufacturedProduct> <asContent> <subjectOf> <marketingAct> <effectiveTime> doit contenir l'attribut <low> value dans le format AAAAMMJJ. | Avertissement |
| 7 | Statut de l'emballage (produits en plusieurs parties) | ||
| 7.01 | Règle abrogée | Règle abrogée | - |
| 7.02 | Description de l'emballage global | Si un <manufacturedProduct> contient une <part>, le <manufacturedProduct> <asContent> <quantity> <numerator> doit avoir un attribut unit et un attribut value qui correspondent à 1. | Erreur |
| 7.03 | Description de l'emballage global | Si un <manufacturedProduct> contient une <part> : Le <manufacturedProduct> doit contenir l'attribut <part> <quantity> <numerator> value. Le <manufacturedProduct> doit contenir l'attribut <part> <quantity> <denominator> value. |
Erreur |
| 7.04 | Quantité totale du produit | L'attribut <part><quantity><numerator> unit doit correspondre à l'attribut <part><partProduct><asContent> <quantity><numerator> unit. | Erreur |
| 7.05 | Contenu - élément de données | Si une <part> ne contient pas <asContent> (c.-à-d., aucun emballage interne propre à une partie n'est décrit), l'attribut <part><quantity><numerator> unit doit correspondre à « 1 ». | Erreur |
| 7.06 | Identificateur d'emballage | L'attribut <part> […] <containerPackagedProduct> <code> code doit contenir une valeur. | Énoncé |
| 8 | Emballage disponible (règles abrogées) | ||
| 8.01 | Règle abrogéePartie du produit | Règle abrogéePartie du produit | - |
| 8.02 | Règle abrogéePartie du produit | Règle abrogéePartie du produit | - |
| 9 | Statut du produit | ||
| 9.01 | Type d'activité de réglementation | Les valeurs pour <approval> <code> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.37. Plus précisément :
|
Erreur |
| 9.02 | Type d'activités de réglementation | Le <manufacturedProduct> doit avoir un <approval> <code>. | Erreur |
| 9.03 | Autorité territoriale | L'attribut <approval> […] <territory> <code> code doit être tiré du VC codeSystem 2.16.840.1.113883.2.20.6.17 et correspondre à « CAN ». Plus précisément :
|
Erreur |
| 9.04 | Numéro de contrôle | L'attribut <approval> <id> doit contenir une valeur. L'attribut <id> extension doit être un nombre à 6 chiffres. | Avertissement |
| 9.05 | Statut du produit | Si la séquence <manufacturedProduct> <subjectOf> <marketingAct> <effectiveTime> contient l'attribut <high> value, il doit être dans le format AAAAMMJJ et être supérieur à l'attribut <low> value de la même séquence. | Avertissement |
| 10 | Caractéristiques du produit | ||
| 10.01 | Caractéristiques du produit | La valeur pour <characteristic> <code> doit être tirée du VC codeSystem 2.16.840.1.113883.2.20.6.23. Plus précisément :
|
Erreur |
| 10.02 | Types de caractéristiques | La valeur pour <characteristic> <value> doit être tirée du VC codeSystem indiqué ci-dessous. Plus précisément :
|
Erreur |
| 10.03 | Caractéristique - type de valeur | La valeur de l'attribut <characteristic> <code> code doit correspondre à la valeur de l'attribut <characteristic> <value> xsi:type, conformément au tableau. |
Erreur |
| 10.04 | Types de valeurs numériques | Si le <characteristic> <value> xsi:type est « PQ » (TAILLE), l'attribut value doit être un nombre entier supérieur à zéro, et l'attribut <characteristic> <value> unit doit contenir une valeur. | Erreur |
| 11 | Voie d'administration | ||
| 11.01 | Voie d'administration | La valeur pour <substanceAdministration> <routeCode> doit être tirée du VC codeSystem 2.16.840.1.113883.2.20.6.7. Plus précisément :
|
Erreur |
| 12 | Contenu narratif | ||
| 12.01 | Modèle de monographie de produit | Les valeurs pour <section> <code> doivent être tirées du VC codeSystem 2.16.840.1.113883.2.20.6.60 ou 2.16.840.1.113883.2.20.6.63. Plus précisément :
|
Erreur |
| 12.02 | Sections | L'en-tête des sections principales suivantes doit être fournie :
|
Erreur |
| 12.03 | Sections | L'en-tête des sections principales suivantes doit être fournie :
|
Avertissement |
| 12.04 | En-tête de section | L'attribut <section> displayName doit correspondre au <title>. Cette règle ne s'applique pas :
|
Erreur |
| 12.05 | Id root | L'attribut <section> <id> root ne doit pas contenir d'extensions ou d'autres éléments de données. | Erreur |
| 12.06 | Id root | L'attribut <id> root doit contenir une valeur, être unique et être un GUID. | Erreur |
| 12.07 | Date de prise d'effet de la section | La <section> doit avoir une <effectiveTime> au format AAAAMMJJ. | Erreur |
| 12.08 | En-tête de section | L'attribut <section> ID doit contenir une valeur. | Avertissement |
| 12.09 | Texte narratif | Le texte narratif doit être incorporés dans les éléments <paragraph>, <list> ou <table>. Le texte ne doit pas être incorporé directement dans l'élément <text>. | Erreur |
| 13 | Renvois | ||
| 13.01 | Renvois internes | Si la valeur de l'attribut <linkHtml> href commence par « # », elle doit faire renvoi à l'un des attributs suivants :
|
Erreur |
| 13.02 | Renvois externes | Si la valeur de l'attribut <linkHtml> href ne commence pas par « # », il doit s'agit d'un renvoi Web formaté correctement. | Erreur |
| 14 | Page titre | ||
| 14.01 | Structure de la date d'approbation | Une valeur d'attribut <section> <code> code correspondant à « 0tp1.3 » doit exister même si le <paragraph> est vide. | Erreur |
| 14.02 | Format textuel de la date | <section> <text> doit avoir un seul <paragraph> au format « AAAA-MM-JJ » (p. ex., 2020-03-15) si la valeur de l'attribut <section> <code> code est l'une des suivantes :
|
Avertissement |
| 14.03 | Structure du numéro de contrôle | Une valeur d'attribut <section> <code> code correspondant à « 0tp1.5 » doit exister même si le <paragraph> est vide. | Erreur |
| 14.04 | Numéro de contrôle | Si la valeur de l'attribut <section> <code> code correspond à « 0tp1.5 », il doit avoir un seul <paragraph> avec un nombre à 6 chiffres. | Avertissement |
| 15 | Images | ||
| 15.01 | Description de l'image | L'attribut <observationMedia> <text> doit contenir une valeur. | Erreur |
| 15.02 | Type de données de l'image | L'attribut <observationMedia> <value> xsi:type doit correspondre à « ED ». | Erreur |
| 15.03 | Type de support de l'image | L'attribut <observationMedia> <value> mediaType doit correspondre à « image/jpeg ». | Erreur |
| 15.04 | Nom du fichier de référence | L'attribut <reference> value doit correspondre au nom de fichier d'une image fournie et ne doit pas contenir de renseignements sur le chemin de répertoire. | Erreur |
| 15.05 | Taille de l'image | La taille du fichier image ne doit pas dépasser 1 Mo. | Énoncé |
| 15.06 | Images inutilisées | Le <observationMedia> doit être associé à un attribut <renderMultiMedia> referencedObject. | Erreur |
| 15.07 | Référence invalide | L'attribut <renderMultiMedia> referencedObject doit correspondre à un attribut <observationMedia> ID. | Erreur |
| Codesystem Oid | Codesystem Name | Valid Xml Contexts |
|---|---|---|
| 2.16.840.1.113883.2.20.6.2 | Annexe | <Characteristic> <Value> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.3 | Formes Posologiques | <Formcode> <Code> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.4 | Rainure | <Characteristic> <Value> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.5 | Norme Pharmaceutique | <Characteristic> <Value> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.6 | Classification Thérapeutique | <Characteristic> <Value> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.7 | Voie D'Administration | <Substanceadministration> <Routecode> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.10 | Type De Document | <Document> <Code> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.11 | Emballage Disponible | Inactif |
| 2.16.840.1.113883.2.20.6.14 | Identifiant Des Ingrédients | <Ingredientsubstance> <Code> Codesystem Attribute <Activemoiety> <Code> Codesystem Attribute <Definingsubstance> <Code> Codesystem Attribute |
2.16.840.1.113883.2.20.6.15 Remark : Cet Oid Est Utilisé Pour La Validation Mais N'Apparaît Pas Dans Le Xml |
Unités De Mesure | <Quantity> <Numerator> Unit Attribute <Quantity> <Denominator> Unit Attribute |
| 2.16.840.1.113883.2.20.6.17 | Code De Pays | <Country> Codesystem Attribute <Approval> [...] <Territory> <Code> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.23 | Caractéristiques Du Produit | <Characteristic> <Code> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.24 | Couleur | <Characteristic> <Value> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.25 | Forme | <Characteristic> <Value> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.26 | Saveur | <Characteristic> <Value> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.29 | Code De Langue | <Languagecode> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.31 | Identificateur D'Entreprise | <Representedorganization> <Id> Root Attribute <Assignedorganization> <Id> Root Attribute |
| 2.16.840.1.113883.2.20.6.32 | Type D'Emballage | <Formcode> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.37 | Activité Réglementaire | <Approval> <Code> Codesystem Attribute |
2.16.840.1.113883.2.20.6.39 Note : Cet Oid Est Utilisé Pour La Validation Mais N'Apparaît Pas Dans Le Xml |
Rôle Des Ingrédients | <Ingredient> Classcode Attribute |
| 2.16.840.1.113883.2.20.6.53 | Classe De Produit | <Characteristic> <Value> Codesystem Attribute |
| 2.16.840.1.113883.2.20.6.60 | 2016 Modèle De Monographie De Produit - Norme | Inactif |
| 2.16.840.1.113883.2.20.6.63 | Modèle Principal - 2020 | <Section> <Code> Codesystem Attribute |
Détails de la page
- Date de modification :