Validation

library(hprimxml)
library(tibble)

hprimxml embarque les schémas XSD officiels d’Interop’Santé. Ils servent à valider un message : structure, ordre des éléments, valeurs autorisées, formats des dates et des codes. La validation s’appuie sur libxml2 (via xml2), comme le package Python avec lxml.

Valider un fichier : hprim_validate()

hprim_validate() renvoie la liste des erreurs : un vecteur vide si le message est conforme. Le fichier PMSI d’exemple, produit par un autre logiciel, ne l’est pas tout à fait :

f <- system.file("extdata", "pmsi_00001.xml", package = "hprimxml")
hprim_validate(f)
#> [1] "Element '{http://www.hprim.org/hprimXML}agent': Missing child element(s). Expected is ( {http://www.hprim.org/hprimXML}code )."                                                 
#> [2] "Element '{http://www.hprim.org/hprimXML}seance': '' is not a valid value of the atomic type '{http://www.hprim.org/hprimXML}seance'."                                           
#> [3] "Element '{http://www.hprim.org/hprimXML}radiotherapie', attribute 'nombreFaisceau': '' is not a valid value of the atomic type '{http://www.hprim.org/hprimXML}attrNbFaisceau'."
#> [4] "Element '{http://www.hprim.org/hprimXML}radiotherapie', attribute 'typeDosimetrie': [facet 'enumeration'] The value '' is not an element of the set {'1', '2', '3', '4'}."      
#> [5] "Element '{http://www.hprim.org/hprimXML}radiotherapie', attribute 'typeMachine': '' is not a valid value of the atomic type '{http://www.hprim.org/hprimXML}attrTypeMachine'."  
#> [6] "Element '{http://www.hprim.org/hprimXML}seance': '' is not a valid value of the atomic type '{http://www.hprim.org/hprimXML}seance'."                                           
#> [7] "Element '{http://www.hprim.org/hprimXML}radiotherapie', attribute 'nombreFaisceau': '' is not a valid value of the atomic type '{http://www.hprim.org/hprimXML}attrNbFaisceau'."
#> [8] "Element '{http://www.hprim.org/hprimXML}radiotherapie', attribute 'typeDosimetrie': [facet 'enumeration'] The value '' is not an element of the set {'1', '2', '3', '4'}."      
#> [9] "Element '{http://www.hprim.org/hprimXML}radiotherapie', attribute 'typeMachine': '' is not a valid value of the atomic type '{http://www.hprim.org/hprimXML}attrTypeMachine'."

L’agent destinataire n’a pas de code, obligatoire dans le XSD. La fonction accepte un chemin, une chaîne XML, un vecteur raw ou un document xml2.

Versions et namespace

Le schéma utilisé est celui de la version déclarée dans le message (version="2.00") :

hprim_available_versions()
#>  [1] "1.03a" "1.04"  "1.05"  "1.06"  "1.07"  "2.00"  "2.1"   "2.2"   "2.3"   "2.4"

Chaque XSD n’accepte que sa propre version. Les schémas existent en deux variantes, avec et sans namespace : un message sans namespace (xmlns = NULL) ou à namespace vide (xmlns = "") est validé automatiquement avec la variante adaptée.

msg <- hprim_parse_xml(f)
for (ns in list(HPRIM_NS, NULL, "")) {
  print(length(hprim_validate(hprim_to_xml(msg, xmlns = ns))))
}
#> [1] 1
#> [1] 1
#> [1] 1

Valider à l’écriture : validate_xsd

Les fonctions d’écriture valident chaque message avant de l’écrire. Un message invalide n’est pas déposé : ni .xml, ni .ok.

evenements <- tibble(evt_id = "S000001", ipp = "123", sexe = "F", date_naissance = as.Date("1960-04-02"),
                     nda = "240000001", venue_date_entree = as.Date("2024-05-02"))
rum <- tibble(evt_id = "S000001", rum_id = 1L, um = "1201", um_date_entree = as.Date("2024-05-02"),
              um_mode_entree = "8", dp = "CODE-INVALIDE")
entete <- list(emetteur = "DIM", destinataire = "DPI")

Par défaut (validate_xsd = "error"), l’écriture échoue avec le message du validateur :

write_evenements_pmsi(evenements, rum, entete = entete, out_dir = "erreur")
#> Error:
#> ! Événement S000001 : XML non conforme au XSD :
#> Element '{http://www.hprim.org/hprimXML}codeCim10': [facet 'pattern'] The value 'CODE-INVALIDE' is not accepted by the pattern '[A-Z][0-9]{2}(([0-9]{0,3})|([+][0-9]{1,2})|([0-9][+][0-9]))'.
list.files("erreur")
#> character(0)

Avec "warn", le fichier est écrit et l’erreur devient un avertissement ; avec FALSE, aucune validation n’est faite.

p <- withCallingHandlers(
  write_evenements_pmsi(evenements, rum, entete = entete, out_dir = "avertissement", validate_xsd = "warn"),
  warning = function(w) { message("Avertissement : ", substr(conditionMessage(w), 1, 70), "..."); invokeRestart("muffleWarning") }
)
basename(p)
#> [1] "S000001.xml"

Contrôles faits avant le XSD

Certaines erreurs sont détectées par le package lui-même, avec un message explicite :

# colonne obligatoire manquante
write_evenements_pmsi(evenements[, -2], rum, entete = entete, out_dir = "x")
#> Error:
#> ! Table evenements : colonnes obligatoires manquantes : ipp
# identifiant du message (= nom du fichier) de plus de 12 caractères
write_evenements_pmsi(evenements, transform(rum, dp = "I21.0"), entete = entete, out_dir = "x",
                      filename = "SEJOUR_{nda}.xml")
#> Error:
#> ! Événement S000001 : le nom de fichier 'SEJOUR_240000001.xml' ne peut pas servir d'identifiantMessage ('SEJOUR_240000001') : 12 caractères au plus (sans l'extension), parmi lettres, chiffres, - , _. Raccourcir evt_id ou le gabarit filename.
# DP donné deux fois pour un même RUM
diag <- tibble(evt_id = "S000001", rum_id = 1L, type = "DP", code = "I10")
write_evenements_pmsi(evenements, transform(rum, dp = "I21.0"), diag, entete = entete, out_dir = "x")
#> Error:
#> ! RUM 1 : plusieurs DP
# clé inconnue du XSD dans une liste (mode strict, par défaut)
msg$evenementsPMSI$enteteMessage$champInvente <- "x"
hprim_to_xml(msg)
#> Error:
#> ! evenementsPMSI/enteteMessage : clés inconnues du XSD 2.00 : champInvente

Éléments vides

Les fichiers reçus contiennent parfois des éléments vides, non conformes : <seance></seance>, des attributs à "". À l’écriture, drop_empty = TRUE (par défaut) les supprime, sauf les éléments obligatoires du XSD, conservés même vides (<diagnostics/>, <divers/> en 2.4).

msg <- hprim_parse_xml(f)
brut <- hprim_to_xml(msg, drop_empty = FALSE)
nettoye <- hprim_to_xml(msg)
c(brut = grepl("<seance", brut), nettoye = grepl("<seance", nettoye))
#>    brut nettoye 
#>    TRUE   FALSE

Anciennes versions

Les dix versions embarquées (1.03a à 2.4) s’écrivent et se lisent avec les mêmes fonctions, via l’argument version. Quelques particularités :

  • Valeurs énumérées et accents. Les versions 1.0x n’admettent que création (accentué), les versions 2.x acceptent aussi creation. À l’écriture, une valeur absente de l’énumération du XSD est remplacée par la forme du XSD quand une seule valeur autorisée lui correspond aux accents près : creation devient création en 1.0x, et réel, lu dans un vieux fichier, devient reel dans une version qui n’admet que cette forme.
  • Champs propres à une version. Certains champs sont obligatoires dans certaines versions seulement (nom usuel et prénom en PMSI 1.0x, venue/@projetTherapeutique et divers/@litDedie en états patient 2.1 à 2.3), d’autres n’existent pas encore dans les anciennes (medecinResponsable/noRPPS en 1.03a). La validation et le mode strict le signalent ; une colonne facultative laissée vide n’est jamais un obstacle.
  • XSD PMSI 1.06. Le XSD officiel PMSI de la version 1.06 est lui-même invalide : il ne peut pas être compilé. Les fichiers 1.06 se lisent normalement, mais leur validation est impossible (erreur de classe hprim_schema_error) : pour écrire en 1.06, passer validate_xsd = FALSE.
x <- sub('version="2.00"', 'version="1.06"', paste(readLines(f, warn = FALSE), collapse = "\n"), fixed = TRUE)
tryCatch(hprim_validate(x), hprim_schema_error = function(e) conditionMessage(e))
#> [1] "Le XSD officiel HPRIM 1.06 (evenementsPMSI) n'est pas valide et ne peut pas être compilé : validation impossible avec cette version. Détail : complex type 'typeUniteMedRhs': If <simpleContent> and <extension> is used, the base type must be a simple type. The base type '{http://www.hprim.org/hprimXML}typeCode10Libelle35' is a complex type."

Fichiers d’une version sans XSD

Un fichier qui déclare une version absente (1.0, par exemple) se lit avec le XSD d’une version proche, en forçant version. Pour trouver la plus proche :

x1 <- sub('version="2.00"', 'version="1.0"', paste(readLines(f, warn = FALSE), collapse = "\n"), fixed = TRUE)
for (v in hprim_available_versions()) {
  n <- tryCatch(length(grep("'version'", hprim_validate(x1, version = v), invert = TRUE, value = TRUE)),
                hprim_schema_error = function(e) NA)
  cat(v, ":", if (is.na(n)) "XSD officiel invalide" else paste(n, "erreur(s)"), "\n")
}
#> 1.03a : 8 erreur(s) 
#> 1.04 : 8 erreur(s) 
#> 1.05 : 8 erreur(s) 
#> 1.06 : XSD officiel invalide 
#> 1.07 : 12 erreur(s) 
#> 2.00 : 9 erreur(s) 
#> 2.1 : 9 erreur(s) 
#> 2.2 : 9 erreur(s) 
#> 2.3 : 9 erreur(s) 
#> 2.4 : 9 erreur(s)

Puis read_evenements_pmsi(fichier, version = "1.03a"), et les tables relues se réécrivent dans une autre version (version = "2.00"), avec validation : c’est une façon de convertir des fichiers anciens. Pour une conversion exhaustive, passer par la liste (hprim_parse_xml(f, version = ...) puis hprim_to_xml(..., version = "2.00")) : le mode strict signale chaque élément qui n’existe plus dans la version cible. Des feuilles XSL de montée de version (serveur d’actes, 1.03a et suivantes) sont aussi publiées par Frédéric Laurent : https://github.com/flrt/hprimxml.

Ce que la validation ne vérifie pas

Le XSD contrôle la forme d’un message, pas son sens :

  • l’existence d’un code CIM-10 ou CCAM (seul son format est vérifié) ;
  • la cohérence des dates (une sortie avant l’entrée passe la validation) ;
  • les règles propres au logiciel récepteur (rattachement d’un état patient à un RUM, identifiants attendus…).

Pour un contrôle indépendant, l’ANS propose un validateur en ligne des messages HPRIM XML (EVS Client, sur interop.esante.gouv.fr).