Annuaire_sante_fr_DSFT_WebServices_Consultation_ _V1.0.0.docx

Transcription

1 S

2 Identification du document Référence Annuaire_sante_fr_DSFT_WebServices_Consultation_ _V1.0.0.docx Date de création 23 janvier 2013 Date de dernière mise à jour Etat Version Classification Nombre de pages décembre 2013 Validé V1.0.0 Non sensible Public Historique du document Version Date Auteur Commentaires V0.X 2013 ASIP Santé Versions de travail successives du document V /07/13 ASIP Santé Première version pour diffusion Classification : public 2 / 91

3 Documents de référence Référence [ref.1 ] CI-SIS_TRANSPORT_VOLET-SYNCHRONE [ref.2 ] CI-SIS : EVOLUTION DU VIHF : PROFIL POUR ANNUAIRE DE PROFESSIONNEL DE SANTÉ [ref.3] VOLET STRUCTURATION MINIMALE DES DOCUMENTS MÉDICAUX [ref 4] NAS-Modèle de données- Principes et Définitions- Descriptif Cadre d interopérabilité des Systèmes de santé (Ci-SIS) - Couche Transport - Volet Synchrone pour Client Lourd CI-SIS : Evolution du VIHF : profil pour annuaire de professionnel de santé Couche Contenu - Volet Structuration Minimale de Documents Médicaux NAS et Modèle de données de annuaire.sante.fr - Principes et définitions [ref 5] NAS-Modèle de données du RASS [ref 6] NAS-Ressources terminologiques utilisées par le RASS [ref 7] Annuaire.sante.fr_WebServices_Consultation-Annexeswsdl_xsd NAS - Modèle des données d identification des acteurs pris en charge par le système annuaire.sante.fr NAS - Ressources terminologiques associées aux données publiées par annuaire.sante.fr WSDL et XSD du service Classification : public 3 / 91

4 Sommaire 1. Introduction Objet du document Gestion des versions successives Guide de lecture Contexte de mise en œuvre des Web Service de annuaire.sante.fr Présentation de l ASIP Santé Historique Définition d «annuaire.sante.fr» Cadre juridique de mise en œuvre Description des acteurs du système Accès sécurisé aux Webservices de annuaire.sante.fr : disposition générale Exigences de confidentialité spécifiques aux données du RPPS Sécurité et intégrité spécifique aux échanges avec le système «annuaire.sante.fr» Présentation des services offerts par les Webservices de annuaire.sante.fr Les différents Webservices proposées Webservices pour accéder aux données des personnes physiques Webservices pour accéder aux données personnes morales dans lesquelles exerce un PS Trajectoire et méthodologie Obtenir un certificat CPS Obtenir l autorisation d accès aux données RPPS Développer une application cliente Tester son application sur un environnement de test Cas d utilisation identifiés Processus d utilisation d un web service de annuaire.sante.fr Description Scénario principal Scénarios alternatifs Description détaillée du système Protocole et référence Encodage et espaces de nommage Principe d authentification et d identification Description des échanges Principe de construction des messages Principe d échanges Version des données échangées Version des web services Classification : public 4 / 91

5 5.5 Description des ressources terminologiques Description du message d entête Description fonctionnelle détaillée des services Recherche de personnes physiques Principe de construction des flux Description du flux d entrée Description du flux de sortie Traitements métier, contrôles Consultation de personnes physiques Principe de construction des flux Description du flux d entrée Description du flux de sortie Traitements métier, contrôles Recherche de personnes morales Principe de construction des flux Description du flux d entrée Description du flux de sortie Traitements métier, contrôles Consultation de personnes morales Principe de construction des flux Description du flux d entrée Description du flux de sortie Traitements métier, contrôles Gestion des erreurs Réponses standards en cas d erreur Annexes WSDL - Contrats d interfaces XSD Identifiants des Ressources Terminologiques utilisées par le système annuaire.sante.fr Droit de rectification des données collectées par le service annuaire.sante.fr Lexique, abréviations et légende Lexique Abréviations Liste des figures Liste des tableaux Classification : public 5 / 91

6 1. Introduction 1.1 Objet du document L objectif du présent document est de décrire en détail les principes, les fonctionnalités et les interfaces d accès à la consultation des données rattachées aux personnes morales et physiques à partir de «annuaire.sante.fr». Nous vous proposons donc de : rappeler le contexte de mise en œuvre de «annuaire.sante.fr» ; décrire les acteurs du processus de consultation des données rattachées aux personnes morales et physiques et expliciter son organisation ; rappeler les exigences de sécurité et de confidentialité attachées aux services offerts par l ASIP Santé ; présenter les services proposés, les cas d utilisation et la méthode pour y accéder ; définir les spécifications fonctionnelles détaillées des interfaces mises à disposition. préciser les modalités d accès aux données présentes dans «annuaire.sante.fr». 1.2 Gestion des versions successives La présente spécification sera mise à jour pour tenir compte des évolutions du système, pour des raisons réglementaires, fonctionnelles ou techniques. Cette gestion de versions est prise en compte dès la conception du système. Le cycle d élaboration du DSFT des interfaces annuaire.sante.fr, est disponible dans un tableau au début du document. Plusieurs versions majeures des interfaces d accès du système annuaire.sante.fr peuvent coexister en même temps, ceci afin de laisser suffisamment de temps aux éditeurs pour adapter leurs produits. Il est possible d être automatiquement informé des dernières mises à jour de ce dossier en s abonnant aux notifications «RNR» disponible sur le site web (onglet de droite) abritant ce document. 1.3 Guide de lecture Ce document est destiné principalement aux décideurs et aux profils techniques. Selon son profil, le lecteur pourra se concentrer sur certains chapitres spécifiques : Profil 1 Décideurs, chefs de projet : Chapitres 2 à 4 Profil 2 - Développeurs, architectes logiciels, consultants techniques : Chapitres 4 à 6 La lecture des documents relatifs au modèle de données et aux ressources terminologiques est un préalable à la lecture des chapitres techniques de ce document (à partir du chapitre 5). Classification : public 6 / 91

7 2. Contexte de mise en œuvre des Web Service de annuaire.sante.fr Ce chapitre décrit le contexte ayant amené la mise en œuvre du service proposé par le système annuaire.sante.fr 2.1 Présentation de l ASIP Santé L Agence des Systèmes d Information Partagés de Santé (ASIP Santé) a été créée en 2009 sous l impulsion de Roselyne Bachelot-Narquin, ministre de la Santé et des Sports. Agence d Etat placée sous la tutelle du ministère en charge de la santé, sa mise en œuvre résulte de la volonté des pouvoirs publics de renforcer la maîtrise d ouvrage publique des systèmes d information en France ; elle regroupe depuis novembre 2009 le GIP Dossier Médical Personnel, le GIP Carte de Professionnel de Santé et les missions du GMSIH relatives à l interopérabilité. Le rôle de l ASIP Santé consiste à promouvoir et encadrer le développement des systèmes d information dans le secteur de la santé et du médico-social. L instruction générale interministérielle n 6600/SGDN/PSE/PPS relative à la sécurité des activités d importance vitale du 26 septembre 2008 a classé ce secteur parmi les secteurs d activités d importance vitale pour l État. En matière d e-santé, l ASIP Santé conçoit et développe des systèmes d information partagés de santé qui mettent en œuvre les référentiels nationaux et internationaux qu elle promeut. En outre, elle encadre le développement de la télémédecine. L Agence contribue également à la définition des conditions d une protection efficace des données de santé à caractère personnel qui jouissent d un encadrement juridique important. De plus, les missions reprises du GIP - Carte de Professionnel de Santé donnent à l Agence un rôle officiel dans la constitution des annuaires de référence des acteurs de santé. C est à ce titre qu elle assure la maîtrise d ouvrage de annuaire.sante.fr. Les activités métier assurées par l ASIP Santé sont les suivantes : maîtrise d ouvrage de projets délégués par les pouvoirs publics ; élaboration et promotion de référentiels d interopérabilité sémantique, technique et de sécurité de l information ; élaboration et promotion des référentiels d identification des Acteurs Sanitaires et Sociaux ; conduite des projets pour la construction de systèmes d information de santé partagés dont la maîtrise d ouvrage est assurée par l Agence (exemple : DMP) ; activité d identification des acteurs de santé et la mise en œuvre par l agence du service de annuaire de référence associé ; accompagnement et communication envers les partenaires : relations avec les professionnels de santé et les patients, relations avec les institutionnels, relations avec les maîtrises d ouvrage régionales de SISP, relations avec les industriels ; mise en place et pilotage des Appels à Projets contribuant au développement des systèmes d information partagés activité de prestataire de service de confiance dans le cadre de la gestion des Cartes de Professionnels de Santé (CPS), d autres types de cartes de la famille CPx et d autres dispositifs équivalents visés à l article du code de santé publique ; assistance et secrétariat du Comité d agrément des hébergeurs de données de santé à caractère personnel pour l instruction des dossiers de demandes d agrément. Classification : public 7 / 91

8 2.2 Historique Créé par l arrêté du 6 février 2009 modifié par l arrêté du 23 décembre 2011 (dit «arrêté RPPS»), le RPPS a vocation à identifier de manière unique et pérenne les professionnels de santé. L ASIP Santé assure la mise en œuvre et la maintenance du RPPS, en coopération avec l Etat, le Service de Santé des Armées, les Ordres professionnels et la CNAMTS, constitué à partir des informations certifiées et transmises par les Autorités d Enregistrement. Les Autorités d Enregistrement assurent une fonction de guichet unique pour l ensemble des professionnels de santé relevant de leur ressort. Elles ont pour mission la régulation de l'accès à la profession (vérification de la qualification professionnelle, éventuellement la validation de diplômes) et son suivi (tenue de registres d'immatriculation des professions réglementées). Ainsi, en qualité d Autorité d Enregistrement, les ordres professionnels doivent tenir à jour la liste des membres de leur profession en situation d exercice régulier, ainsi que les structures non gérées dans FINESS (cabinets libéraux, autres établissements, ) dans lesquels ces membres exercent après avoir procédé aux contrôles nécessaires. La fonction de guichet unique est respectivement assurée par les Ordres pour les professionnels à ordre, le Service de Santé des Armées pour les professionnels qui ont le statut militaire, les services concernés de l État et ses établissements publics tels les Agences Régionales de Santé, pour les professionnels de santé relevant de leur compétence administrative. Dès son inscription au tableau de son ordre ou auprès de son autorité d enregistrement, les informations sur le professionnel de santé sont portées au RPPS. A ce jour, quatre professions sont dans le RPPS : les chirurgiens-dentistes, les médecins, les pharmaciens et les sages-femmes. L intégration des pédicures-podologues, masseurskinésithérapeutes et infirmiers est en phase d étude. En sa qualité de responsable de traitement au sens de la loi n du 6 janvier 1978 modifiée relative à l informatique, aux fichiers et aux libertés, l ASIP Santé est tenue de respecter les finalités du RPPS définies par l arrêté du 6 février 2009 modifié portant création du RPPS. Ces finalités sont les suivantes : identifier les professionnels de santé en exercice, ayant exercé ou susceptibles d exercer ; suivre l exercice de ces professionnels ; contribuer aux procédures de délivrance et de mise à jour des cartes de professionnel de santé ; permettre la réalisation d études et de recherches ainsi que la production de statistiques relatives aux professionnels répertoriés, à partir d une base de référence anonymisée. En outre, l ASIP Santé a pour mission de mettre les données librement communicables du RPPS à disposition du public au moyen d un service de communication sous forme électronique. 2.3 Définition d «annuaire.sante.fr» «annuaire.sante.fr» permet de mettre à disposition des utilisateurs autorisés l ensemble des données de description des professionnels de santé enregistrés dans le RPPS (données d identité, exercice professionnel, situations d exercice ) dans le respect des règles définies par l arrêté RPPS. «annuaire.sante.fr» permet aussi d accéder aux données d identification des établissements dans lesquels ces professionnels de santé exercent, que ces établissements soient du domaine sanitaire, médico-social ou social. Classification : public 8 / 91

9 Il comprend plusieurs canaux de publication : une IHM web, permettant une consultation des données en mode authentifié ou non authentifié ; une mise à disposition des données sous forme de fichiers (extractions), accessibles uniquement en accès authentifié (un accès non authentifié doit également être mis en œuvre au regard de l évolution récente de l article 6 de l arrêté dit «RPPS» du 6 février 2009; des webservices, accessibles uniquement en accès authentifié. C est ce dernier canal de publication qui est détaillé dans le présent document. 2.4 Cadre juridique de mise en œuvre Les différents services de publication de données présents dans annuaire.sante.fr s inscrivent dans le cadre de la réglementation «RPPS», soit l arrêté du 6 février 2009 modifié les 23 décembre 2011 et 2 octobre 2013 (cette dernière modification n est pas encore techniquement traduite dans ce document). Les informations relatives aux établissements soumis à autorisation ont pour source le répertoire FINESS (Ministère des Affaires Sociales et de la Santé DREES Description des acteurs du système Acteurs UML (*) Description ASIP Santé Système initiateur ou Consommateur Système annuaire.sante.fr Maître d'ouvrage du service. Organisme utilisant les services exposés par le système «annuaire.sante.fr» (personne physique et/ou personne morale) Fournisseur des web services de «annuaire.sante.fr» Tableau 1: Description des acteurs (*) Un acteur UML est une entité qui interagit avec «annuaire.sante.fr». En réponse à l action d un acteur, "annuaire.sante.fr" fournit un service et/ou une réponse qui correspond à son besoin. Classification : public 9 / 91

10 3. Accès sécurisé aux Webservices de annuaire.sante.fr : disposition générale Ce chapitre décrit les dispositions générales de sécurité à respecter dans le cadre de l utilisation des webservices de «annuaire.sante.fr». 3.1 Exigences de confidentialité spécifiques aux données du RPPS Les droits d accès aux données contenues dans le RPPS sont définis réglementairement pour chaque catégorie d utilisateurs (cf. annexe 2 de l arrêté du 6 février 2009 modifié) : seules les données dites communicables au public librement accessibles ; les autres données sont accessibles uniquement aux catégories d utilisateurs définies à l article 7 de l arrêté dit «RPPS» du 6 février L utilisation des données du RPPS au travers des services exposés par le système «annuaire.sante.fr» rend l organisme «responsable de traitement» au sens de la loi Informatique et Libertés à l égard des données transmises. Il lui appartient de respecter les obligations s imposant à tout responsable de traitement au sens de cette même loi. L utilisation de ces données dans le respect de la finalité déclarée dans le formulaire est placée sous votre responsabilité. Vous êtes responsable pénalement de toute utilisation frauduleuse qui pourrait être commise à l égard des données qui vous ont été transmises. La constitution - ou l alimentation - d une application informatique avec les données à caractère personnel issues du RPPS doit faire l objet des formalités préalables prévues au chapitre IV de cette loi. Si l organisme utilisant les services exposés par le système «annuaire.sante.fr» poursuit d autres finalités que les finalités initiales susdécrites du RPPS, vous devez le mentionner lors de vos démarches auprès de la CNIL. L organisme est également tenus de respecter les droits des personnes mentionnés au chapitre V de la même loi, notamment le droit des personnes concernées à l information préalable et le droit de s opposer, pour un motif légitime, à ce que ses données à caractère personnel fassent l objet d un tel traitement. Lorsque l organisme a accès en extraction aux données du RPPS, il doit prendre toutes les précautions utiles pour que ces données soient conservées dans des conditions garantissant leur sécurité, leur intégrité et leur confidentialité. Enfin, la rediffusion des données est interdite, sauf si vous appartenez à l une des catégories d utilisateurs identifiées à l article 8 de l arrêté RPPS autorisées à rediffuser ces données, dont fait partie l ASIP Santé. 3.2 Sécurité et intégrité spécifique aux échanges avec le système «annuaire.sante.fr» La sécurité des échanges entre le système «annuaire.sante.fr» et les autres applications comporte plusieurs niveaux : - le transport - le non répudiation des messages - la validation des données La mise en œuvre des Webservices de annuaire.sante.fr s effectue dans le respect des standards utilisés dans les échanges de données de santé définis par le Cadre d Interopérabilité des Systèmes d Information de Santé (CI-SIS) pour ce qui concerne les fonctions de d identification et d authentification. Les Web services de annuaire.sante.fr appliquent les spécifications de la «couche transport volet synchrone pour client lourd» du CI-SIS. Ce volet est complété, en attente de sa Classification : public 10 / 91

11 mise à jour, d un document de définition du profil du VIHF (Vecteur d Identification et d Habilitation Formelles) pour l échange de données d identité. Pour être conforme au CI-SIS un système émetteur d une demande d utilisation des web services de annuaire.sante.fr, doivent utiliser un certificat émis par l'igc-cps que celui-ci soit associé à une personne physique (CPS personnelle et nominative) ou à une personne morale (certificat serveur). Les échanges se font sur le protocole http 1.1 encapsulé dans une connexion sécurisée TLS. La version TLS minimale admise est la 1.0. Les exigences de sécurité et d intégrité sont détaillées dans le document [ref.1 ] CI- SIS_TRANSPORT_VOLET-SYNCHRONE. Classification : public 11 / 91

12 4. Présentation des services offerts par les Webservices de annuaire.sante.fr Ce chapitre détaille les différents services proposés, les cas d utilisations et l ensemble des étapes nécessaires à l obtention de l accès aux Webservices de annuaire.sante.fr. 4.1 Les différents Webservices proposées Les Webservices fonctionnent en mode synchrone. On distingue 4 web services pour la consultation des données des personnes physiques et des personnes morales Webservices pour accéder aux données des personnes physiques Web Service de recherche de personnes physiques : o Le client du Web service recherche les personnes physiques répondant à un filtre de sélection. En réponse, annuaire.sante.fr lui renvoie les identifiants des personnes physiques répondant à ces critères. Web Service de consultation des données d une ou plusieurs personnes physiques o Le client du Web service communique dans sa requête le (ou les) identifiants des personnes physiques sélectionnées. En retour, annuaire.sante.fr lui retourne l ensemble des attributs qu il est habilité à extraire de annuaire.sante.fr Webservices pour accéder aux données personnes morales dans lesquelles exerce un PS Les Web services sont du même type que ceux dédiés aux personnes physiques. Web service de recherche de personnes morales Web Service de consultation des données d une ou plusieurs personnes morales. Annuaire.sante.fr communique en outre la liste des PP exerçant au sein de la personne morale. Figure 1: Synoptique d utilisation des web services Classification : public 12 / 91

13 Nom du WS WS1 WS2 WS3 WS4 Description Web Service de recherche des PP Web Service de recherche des PM Web Service de consultation des PP Web Service de consultation des PM Tableau 1: Liste des web services 4.2 Trajectoire et méthodologie L accès aux données doit est réalisé dans le respect des règles définies par l arrêté RPPS. En conséquence, l usage des Web services est conditionné par l instruction par l ASIP Santé d une demande d accès au RPPS. Afin de respecter les règles de contrôles d accès aux données, l accès aux Webservices s effectue via une authentification forte par certificat CPS. L utilisateur du service annuaire.sante.fr doit donc être détenteur d une autorisation d accès au RPPS et d un certificat d authentification de la famille CPS. (*)Si vous ne disposez pas d un tel contrat Obtenir un certificat CPS Le niveau de confidentialité des données exposées par les WebServices de annuaire.sante.fr requiert un niveau de sécurisation justifiant l utilisation de cartes et/ou de certificats de la famille CPS. La commande de ces produits de certification est subordonnée à l établissement d un contrat CPS avec l ASIP Santé. Pour vous assurer qu un contrat n a pas déjà été établi avec votre organisme, il vous faut contacter le service Établissements de l ASIP Santé qui pourra vous confirmer l existence ou non d un Contrat. La phase technique de distribution d un certificat serveur consistera à procéder à la génération des clés de sécurité des serveurs, à leur certification par l ASIP Santé et à l installation du certificat dans les serveurs de votre organisation. Pour plus d information, vous pouvez accéder aux étapes de commandes d un certificat CPS Classification : public 13 / 91

14 Pour plus d information sur l accès aux conditions d établissement d un contrat CPS et de commandes de produits de certification sur le portail de l ASIP Santé, nous vous invitons à visiter l espace CPS au sein du portail esanté.gouv.fr L accès au système annuaire.sante.fr est soumis à l obtention d un certificat dédié. Si vous disposez déjà d un certificat CPS, celui-ci ne peut être utilisé afin d accéder aux données de annuaire.sante.fr pour des raisons de sécurité Obtenir l autorisation d accès aux données RPPS Le service annuaire.sante.fr est le vecteur de publication des données du RPPS. Les règles d accès aux données sont fixées par l arrêté «RPPS» du 6 février 2009 modifié par l arrêté du 23 décembre L ASIP Santé doit s assurer que seules les personnes autorisées peuvent accéder aux données à caractère personnel contenues dans le RPPS et annuaire.sante.fr, dans le respect de ses règles de fonctionnement. C est pourquoi les demandes d accès font l objet d une fiche de demande d accès au RPPS, instruite par l ASIP Santé. Les droits d accès aux données sont définis en fonction de catégories d utilisateurs spécifiées en annexe II de l arrêté RPPS. En fonction de la nature de votre organisation, l ASIP Santé associe à celleci une catégorie d utilisateur Développer une application cliente L ASIP Santé met à disposition des éditeurs souhaitant implémenter l utilisation des WebServices de annuaire.sante.fr : le modèle de données et les ressources terminologiques (nomenclatures) associées, que vous retrouverez dans la page dédiée "Nomenclature des Acteurs de Santé"; Classification : public 14 / 91

15 le dossier de spécifications techniques des WebServices de annuaire.sante.fr; les schémas et WSDL associés ; d un exemple de code du client (Java) des Web Service implémentant les fonctions : o d authentification par certificat serveur; o de génération d un jeton VIHF; o d établissement d une connexion TLS ; o de génération de requêtes clientes des Web Services exposés par le système annuaire.sante.fr Tester son application sur un environnement de test Une plateforme de test des WebServices de annuaire.sante.fr est mise à disposition des organismes par l ASIP Santé. Cette plateforme contient des jeux de données fictifs permettant aux partenaires de tester leur application cliente. L ASIP Santé ne réalise aucune homologation des applications clientes utilisant les WebServices de annuaire.sante.fr. Les éléments suivants doivent être communiqués à l ASIP Santé afin de permettre l accès à l environnement de test : La liste des adresses IP qui accèderont à l environnement de test ; L identifiant du certificat serveur CPS à paramétrer sur la plateforme de test. Celui-ci peut être le certificat de test inclus dans le contrat éditeur CPS ou un certificat de production si vous disposez d un tel produit. Deux processus distinct peuvent être utilisés pour accéder à cette plateforme en fonction des produits de certifications dont vous disposez : Cas 1 : Accès avec un certificat de test Cas 2 : Accès avec un certificat de production 4.3 Cas d utilisation identifiés Les cas d utilisation sont classifiés suivant 2 processus : Classification : public 15 / 91

16 récupération des identités (identifiants) des personnes (physiques ou morales) répondant à un filtre de sélection communiqué dans la requête par le système initiateur. En réponse, le système annuaire.sante.fr lui renvoie les identifiants des personnes physiques répondant à ces critères. consultation des dossiers d une ou plusieurs dossiers personnes (physiques ou morales) en fonction du (des) identifiants communiqués dans sa requête par le système initiateur. En retour, le système annuaire.sante.fr lui retourne l ensemble des attributs rattachés au(x) dossiers(s) qu il est habilité à extraire de annuaire.sante.fr. Code UC Cas d utilisation Acteurs UML Récupérer des identifiants des personnes (PP ou PM) Système initiateur Consulter des dossiers personnes (PP ou PM) Système initiateur 4.4 Processus d utilisation d un web service de annuaire.sante.fr Description Le processus d utilisation d un web service de consultation de annuaire.sante.fr est identique pour les deux cas. Classification : public 16 / 91

17 Cas d utilisation Utilisation d un web service de consultation exposé par le système annuaire.sante.fr Permettre à un système initiateur d extraire des informations à partir de annuaire.sante.fr : Résumé soit de(s) identifiant(s) personnes (PP ou PM) soit les dossiers descriptifs d une ou plusieurs personnes (PP ou PM) Déclencheur Invocation de l URL correspondant au web service exposé par le système initiateur Mode Interactif Objectif Fournir un ensemble d informations précisées dans la requête sur les personnes (PP ou PM). Fréquence d utilisation A la demande Acteur(s) principal(aux) Les systèmes initiateurs Pré conditions L utilisateur est inscrit* au service annuaire.sante.fr et il possède un moyen d identification (certificat émis par l'igc-cps que celui-ci soit associé à une personne physique (CPS personnelle et nominative) ou à une personne morale (certificat serveur)) en cours de validité. Post conditions L exécution de ce Web service ne provoquera aucune modification sur les informations extraites Scénario principal Étapes Activité Scénario Alternatif 1 Un utilisateur, qui souhaite récupérer des informations à partir de annuaire.sante.fr, invoque par l intermédiaire d un système initiateur le web service en établissant une session TLS avec authentification mutuelle. Il envoie un message avec sa requête accompagnée d un jeton VIHF qui est porteur des informations d identification et d habilitation. SA1 2 Le système annuaire.sante.fr réceptionne le message accompagné du jeton VIHF et procède à son interprétation. SA2 3 annuaire.sante.fr : Identifie l utilisateur, vérifie qu il est inscrit au système annuaire.sante.fr, effectue le contrôle d accès par rapport aux droits accordés à l utilisateur via les matrices de responsabilités SA3 SA4 Classification : public 17 / 91

18 Étapes Activité Scénario Alternatif 4 Le système annuaire.sante.fr traite la requête et fournit en retour un message contenant le résultat du traitement Scénarios alternatifs Étapes Activité Scénario Alternatif SA1 : Le service n est pas disponible. 2 Il n y a pas de message de réponse de la part du système annuaire.sante.fr SA2 : Le message envoyé est mal formaté 4 Le système annuaire.sante.fr envoie un message d erreur sans traiter la demande SA3 : Les informations d identification et d habilitation sont insuffisantes 4 Si les informations d identification sont insuffisantes pour déterminer l identité de l utilisateur le contrôle d accès le système annuaire.sante.fr envoie un message d erreur sans traiter la demande. SA4 : L Utilisateur n est pas inscrit au service annuaire.sante.fr 4 Si l utilisateur n est pas inscrit, le système annuaire.sante.fr envoie un message d erreur sans traiter la demande. Classification : public 18 / 91

19 5. Description détaillée du système Ce chapitre détaille d un point de vue technique les Webservices proposés par annuaire.sante.fr. 5.1 Protocole et référence Le tableau suivant présente les protocoles utilisés pour la mise en place des web services. Protocole Version Description SOAP 1.2 Spécifier les formats de messages HTTP 1.1 Protocole d échange WS-I Security 1.1 Sécurisation des échanges TLS Transport Layer Security SAML 2.0 Security Assertion Markup Language Tableau 2: Protocoles et référence La structure des messages SOAP décrit dans la suite du document est conforme aux exigences de conformité définie dans le cadre d interopérabilité de SIS couche transport décrites dans le document CI-SIS_TRANSPORT_VOLET-SYNCHRONE_V1.3.0.pdf. Le principe de construction des messages est présenté en section Encodage et espaces de nommage L encodage standard pour les documents XML est l UTF8. Les espaces de nommage des entités manipulées ont le format suivant : du WS> «ACTION»: consultation ou recherche «VERSION»: Correspond à la version des web services NOM DU WS WSRECHERCHEPP WSRECHERCHEPM WSCONSULTATIONPP WSCONSULTATIONPM DESCRIPTION Web Service de recherche des PP Web Service de recherche des PM Web Service de consultation des PP Web Service de consultation des PM Tableau 3: Nommage des web services Les types de données utilisés pour les représentations des entités sont ceux définis par le standard du schéma XML ( Pour qualifier les types de données, le préfixe «xsd» sera utilisé pour distinguer les données standards. Il est déclaré ainsi : xmlns:xsd=" Classification : public 19 / 91

20 Pour les types primtifs : xsd :decimal,, xsd :date, xsd:time, xsd :datetime, xsd :base64binary, xsd :boolean Pour les types dérivés : xsd : token, xsd :positiveinteger, xsd :nonnegativeinteger Les types de données spécifiques utilisés dans le cadre de annuaire.sante.fr sont déclarés comme suit : xmlns:annuairesante=" xmlns:annuairesanteentete=" te" xmlns:annuairesanteexception=" xception" 5.3 Principe d authentification et d identification Le cadre d interopérabilité «du volet transport» définit deux configurations d authentification qui pourront être utilisées : en configuration «authentification indirecte» : c est le cas d un système initiateur hébergé au sein d'un établissement de santé qui s'authentifie auprès du système annuaire.sante.fr via un certificat serveur. L'utilisateur final s'authentifie localement au sein de la structure, qui porte ainsi la responsabilité des échanges avec le système annuaire.sante.fr. en configuration «authentification directe» : l authentification est effectuée par le système annuaire.sante.fr à partir de certificats contenus dans la carte CPS du professionnel de santé. L identification et l authentification sont effectuées par le système annuaire.sante.fr par rapport aux informations transmises par le système initiateur. Les éléments fonctionnels récupérés afin d effectuer cette opération sont : Le certificat émetteur ; L identifiant de l utilisateur ; Le profil de l utilisateur ; Le périmètre du profil utilisateur. Le contrôle d accès est réalisé par rapport aux droits accordés à l utilisateur dans le système annuaire.sante.fr via la matrice d accès aux données et en fonction des informations transmises par le système initiateur. Le schéma ci-dessous présente le diagramme de séquences d identification d un utilisateur par le système annuaire.sante.fr à partir du jeton VIHF. Classification : public 20 / 91

21 Figure 2: Principe d authentification et d identification La cinématique est la suivante pour chaque requête de consultation de personnes physiques ou morales : Etablissement d une session TLS avec authentification mutuelle entre le système annuaire.sante.fr et l application consommatrice ; Présentation du jeton VIHF à chaque requête ; Contrôles de sécurité du système annuaire.sante.fr ; Réponse du système annuaire.sante.fr à la requête ; Fin de la session TLS. Le processus d identification est basé sur l usage du VIHF. Le modèle VIHF impose l utilisation du jeton de sécurité SAML 2.0. Le jeton VIHF est transmis au système annuaire.sante.fr à chaque requête. Il contient l identité de l utilisateur et les éléments nécessaires à la détermination des habilitations. Le système annuaire.sante.fr, selon la configuration utilisée et les informations d identification et d habilitation transmises, vérifie la conformité des informations et calcule ses droits. Le principe d authentification est décrit dans le document de référence «CI-SIS_TRANSPORT_VOLET- SYNCHRONE_V1.3.0.pdf». La signature du VIHF n'est pas demandée. Classification : public 21 / 91

22 Connexion sécurisée TLS mutuelle La connexion sécurisée s effectue via une authentification TLS mutuelle. Les certificats utilisés sont ; Certificat établissement du système initiateur connu par le système annuaire.sante.fr ; Certificat serveur du système annuaire.sante.fr. 5.4 Description des échanges Les messages s appuient sur les descriptions décrites dans le cadre d interopérabilité et sur l utilisation du protocole SOAP. Les sections suivantes décrivent la structure des messages véhiculés entre les systèmes sources et le système annuaire.sante.fr Principe de construction des messages Chaque message est constitué d une Envelope (Enveloppe) qui contient un élément Header (en-tête) et un élément Body (corps). L enveloppe constitue la racine du document XML et spécifie le Namespace SOAP-ENV Dans le cadre d interopérabilité la structure d un message SOAP est décrite dans le paragraphe 3.2 «Message SOAP» du document «CI_SIS_TRANSPORT VOLET-SYNCHRONE_V Entête du message Dans le cadre du système annuaire.sante.fr, l élément HEADER du message contient le jeton VIHF et les informations sur le message (WS-Adressing). Eléments spécifiques de l entête Dans le cas des SIS français l élément Header (en-tête) du message SOAP est obligatoire et aucun nœud intermédiaire n est prévu entre système initiateur et système cible. Le jeton VIHF, permet d identifier le système initiateur par le système cible (annuaire.sante.fr). Le message SOAP proposé est étendu avec la spécification WS-Addressing qui permet d indiquer le destinataire du message (élément <To>), l identifiant du message (élément <MessageID>), l action à réaliser (élément <Action>) et l adresse à laquelle le message de réponse doit être envoyé (élément <ReplyTo>). Ces éléments sont obligatoires Corps du message Le corps du message BODY véhicule un ensemble d éléments composés chacun d un espace de noms avec des attributs portant les données applicatives. Le corps du message contient également un élément FAULT, qui permet éventuellement de renvoyer vers l émetteur le type d erreur intervenu lors du traitement du message par le destinataire Principe d échanges Les échanges avec les web services de consultation de personnes physiques et de personnes morales sont de type requête/réponse donc synchrone Version des données échangées Les données sont gérées dans annuaire.sante.fr avec une date de fin présente dans chaque entité. Cette dernière permet de déterminer l état de la donnée (Active ou Historisée). L accès aux données en fonction de leur état est géré par la matrice d habilitation en accès. Classification : public 22 / 91

23 5.4.4 Version des web services La version est portée par l URI d invocation du web service. Chaque version est considérée comme un service différent à part entière. Chaque service est associé à un namespace différent, portant le numéro de version. La version courante du web service est la V Description des ressources terminologiques Les ressources terminologiques décrivant les personnes physiques et morales sont gérées dans le NAS (Nomenclatures du Référentiel d identification des acteurs du domaine sanitaire). Ce sont des concepts codés avec une structuration des valeurs codées conforme à la description donnée au paragraphe «Types de données "CS", "CV", "CE", "CD"» du document [ref 3] «CI- SIS_CONTENU_VOLET-STRUCTURATION-MINIMALE_V pdf» : Pour rappel la structuration d une ressource terminologique est la suivante: code (cs) : la valeur du code du concept ; codesystem (uid): OID de la table de la terminologie source (cf. document [ref 6]) ; codesystemname (st): le nom lisible de la terminologie source qui correspond à l'information "Code Table" (cf. document [ref 6]) ; codesystemversion (st): la version de la terminologie source ; displayname (st): le libellé court associée au code dans la terminologie source qui correspond au Libellé de la table. originaltext (ED) : texte ou phrase utilisé comme base du codage 5.6 Description du message d entête Le modèle de l en-tête «ENTETE» est identique pour tous les web services. L en-tête est obligatoire dans chaque message. Elle contient une entrée WS-Adressing obligatoire qui étend les spécifications du protocole SOAP L entrée WS-Adressing Le paramètre est actif dans le message SOAP avec la syntaxe suivante : <wsaw:usingaddressing wsdl:required="true" /> ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE WS-ADRESSING ACTION Action à réaliser sur le message X(I) X TO Le destinataire du message X(I) annuaire.sante.fr MESSAGEID l identifiant du message X(I) X REPLYTO l adresse à laquelle le message de réponse doit être envoyé X(I) X Classification : public 23 / 91

24 ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE FAULTO Identité du consommateur Communiqué par le système annuaire.sante.fr après l abonnement ou l inscription X(1024) Tableau 4: Eléments du WS-Adressing Le contenu du jeton VIHF Dans le contexte d un Web service de consultation appelé par un système utilisateur de annuaire.sante.fr, l identification de l appelant ne permet pas à elle seule de déterminer le contexte d usage du Web service. Le système initiateur doit préciser le contexte dans lequel s inscrit la transaction via le jeton VIHF. Le contenu du jeton VIHF est dépendant de la configuration utilisée (directe ou indirecte) par le système utilisateur. En plus des champs SAML standards le jeton comporte des informations complémentaires telles que le profil et le périmètre métier de l utilisateur. Ces informations dépendent du contexte applicatif et sont exploitées pour le contrôle d accès aux données en consultation. De façon générale, les informations contenues dans le jeton VIHF proviennent : du certificat émis par l IGC-CPS pour les : o personnes disposant d une carte et de certificats, o établissements disposant de certificats serveur, du SI de l'établissement qui émet l'assertion, Le processus d authentification du système annuaire.sante.fr lit dans le jeton l identité de l émetteur (personne physique ou personne morale) de l assertion afin d effectuer les contrôles de cohérence avec le certificat d authentification qui a initié la connexion TLS : o o le certificat serveur émis par l IGC-CPS, en cas d authentification indirecte, le certificat CPS de la personne physique en cas d authentification directe. Le tableau suivant présente les champs présents dans le jeton VIHF avec leur valorisation pour un profil et un contexte d utilisation «annuaire de professionnels de santé». Ce tableau complète les spécifications d'utilisation et de format définies dans le document de référence «CI- SIS_TRANSPORT_VOLET-SYNCHRONE». CHAMP DESCRIPTION REQUIS : (R) OPTIONNEL : (O) FORMAT VALEUR / CONTRÔLE CHAMPS STANDARDS //Assertion/@xmlns:saml2 namespace xml SAML R //Assertion/@Version Version utilisée R Alpha numérique Alpha numérique Constante :"urn:oasis:names:tc:saml:2. 0:assertion" Constante : "2.0" //Assertion/@ID Identifiant unique de l assertion R Alpha numérique Id de l assertion Classification : public 24 / 91

25 CHAMP DESCRIPTION REQUIS : (R) OPTIONNEL : (O) FORMAT VALEUR / CONTRÔLE //Assertion/@IssueInstant Date et heure d'émission de l'assertion SAML R xs: datetime Date et heure d'émission de l'assertion SAML Pas de contrôle //Assertion/Issuer //Assertion/Issuer/@Form at //Assertion/ds:Signature Identité de l émetteur contenue dans le certificat (DN) Type de valeur utilisée pour renseigner le champ Issuer (X509) Emplacement réservé à la signature R R R Si le jeton est signé DN (Distinguishe d Name) Alpha numérique Alpha numérique DN de la Personne Physique ou Personne Morale ayant émis l'assertion. Si le VIHF n'est pas signé : contrôle de cohérence avec le DN du certificat ayant initié la connexion TLS. Si le VIHF est signé : contrôle de cohérence avec le DN du certificat ayant signé le VIHF. Constante : urn:oasis:names:tc:saml:1.1 :nameidformat:x509subjectname Eléments de la signature //Assertion/Subject/Name ID l identifiant de l utilisateur final envoyé par le système initiateur L identifiant national de la personne «PS_IdNat», ou identifiant de la personne responsable du traitement, dans le cas d un traitement automatisé. //Assertion/AuthnStateme nt/authncontext/authnco ntextclassref La méthode d authentification de l'utilisateur R R Alpha numérique Alpha numérique En authentification directe : doit être renseigné avec le PS_Idnat contenu dans le DN du certificat d authentification En authentification indirecte (authent serveur) : pas de contrôle En authentification directe par CPS la valeur est "urn:oasis:names:tc:saml:2. 0:ac:classes:SmartcardPKI". En authentification indirecte, la valeur est laissée au choix de l'émetteur de l'assertion dès lors qu'elle est sélectionnée dans le document /saml-authn-context-2.0- Classification : public 25 / 91

26 CHAMP DESCRIPTION REQUIS : (R) OPTIONNEL : (O) FORMAT VALEUR / CONTRÔLE //Assertion/AuthnStateme nt/@authninstant //Assertion/Conditions/Au diencerestriction //Assertion/Conditions/@ NotBefore La date et l heure exprimée en UTC.à laquelle l authentification a été réalisée par le système initiateur Plusieurs champs Audience qui contient chacun un URI qui référence la PSSI du O système initiateur applicable pour traiter l assertion R xs: datetime OID La date et l heure UTC de début de validité de l assertion O xs: datetime os.pdf Date/heure d authentification SI Présent si une PSSI est définie Date/heure de début de validité de l assertion pas de contrôle //Assertion/Conditions/@ NotOnOrAfter La date et l heure UTC de fin de validité de l assertion O xs: datetime Date/heure de fin de validité de l assertion pas de contrôle CHAMPS COMPLEMENTAIRES - SITUES DANS LA BALISE <SAML:ATTRIBUTESTATEMENT> DU JETON SAML VIHF_Version Version du VIHF utilisée R Numérique Constante : "2.0" urn:oasis:names:tc:xacml: 2.0:subject:role Rôle fonctionnel de l utilisateur (profession) qui peut être multi-valeur O Type donnée d HL7 v3 de CE Les règles de valorisation sont détaillées dans le & du Volet Transport Synchrone Secteur_Activite Secteur d activité dans lequel exerce l utilisateur O OID Nomenclature Secteur d activité code : Code du secteur d activité codesystem: codesystemname : optionnel displayname : optionnel urn:oasis:names:tc:xacml: 2.0:resource:resource-id Identifiant du patient concerné par la requête N/A CX de HL7 v2.5. Vide (Non applicable pour annuaire.sante.fr) Ressource_URN Ressource visée par l utilisateur. R URN Constante: "urn:annuairesante" Classification : public 26 / 91

27 CHAMP DESCRIPTION REQUIS : (R) OPTIONNEL : (O) FORMAT VALEUR / CONTRÔLE urn:oasis:names:tc:xspa:1. 0:subject:purposeofuse Indique le mode d accès demandé par l utilisateur Non significatif dans le contexte annuaire.sante.fr O CE d HL7 v3 Valeurs possibles: normal, bris de glace ou centre 15 Valeurs par défaut: normal Mode_Acces_Raison Explication de la raison de l usage du bris de glace. O Alpha numérique Non significatif dans le contexte annuaire.sante.fr urn:oasis:names:tc:xspa:1. 0:subject:subject-id Identité de l utilisateur R Si authentificati on indirecte Alpha numérique Identification explicite de l utilisateur (ex. nom, prénom, service au sein d un établissement ) ou Identification explicite de la machine (ex. nom du logiciel, nom du modèle, service au sein d un établissement ) Pas de contrôle sur la valeur Identifiant_Structure Identifiant de l établissement de santé ou du cabinet depuis lequel la requête a été émise O Alpha numérique L identifiant national de la structure «Struct_IdNat» LPS_Nom Nom du logiciel utilisé O Alpha numérique Non significatif dans le contexte annuaire.sante.fr LPS_Version Version du logiciel utilisé O Alpha numérique Non significatif dans le contexte annuaire.sante.fr LPS_ID Numéro de série ou identifiant de l installation du logiciel O Alpha numérique Non significatif dans le contexte annuaire.sante.fr PROFIL_UTILISATEUR Le profil de l utilisateur Nomenclature Catégorie utilisateur R OID code : catégorie utilisateur valeur : Voir Liste des valeurs pour l élément Profil_Utilisateur codesystem : codesystemname (attribut Classification : public 27 / 91

28 CHAMP DESCRIPTION REQUIS : (R) OPTIONNEL : (O) FORMAT VALEUR / CONTRÔLE optionnel) : R78 displayname optionnel) (attribut Contrôle de cohérence du profil avec l utilisateur parmi les utilisateurs inscrits. PROFIL_UTILISATEUR_PERI METRE VIHF_PROFIL Le contexte métier ou périmètre de l utilisateur Le profil VIHF O La présence de ce champ dépend de la OID valeur de PROFIL_UTILI SATEUR OID Tableau 5: Descriptifs des attributs du jeton SAML 2.0 Nomenclature utilisateur Périmètre valeur : Voir «règle de gestion de l élément «Profil_utilisateur_perimetr e» Contrôle de cohérence du code ordre ou de l identifiant de la structure avec l utilisateur parmi les utilisateurs inscrits. Nomenclature Profil VIHF code : profil_annuaire_ps codesystem: codesystemname (attribut optionnel) : profil VIHF displayname (attribut optionnel) : Profil pour annuaire de professionnels de santé du VIHF 2.0 La récupération de l émetteur se fera à partir des attributs Issuer et/ou Subject/NameId respectivement de type : «urn:oasis:names:tc:saml:2.0:namid-format:x509subjectname» et alphanumérique Liste des valeurs pour l élément «Profil_Utilisateur» Ci-dessous la liste des valeurs du l attribut «code» de l élément «Profil_Utilisateur» VALEUR DESCRIPTION CU01 CU02 CU03 CU04 Services du ministère chargé de la santé Agences régionales de santé SSA et autres autorités employeurs Conseils des Ordres Classification : public 28 / 91

29 VALEUR DESCRIPTION CU05 CU06 CU07 CU08 CU09 CU10 CU11 CU12 CU13 CU14 CU15 CU16 CU17 Autorités et représentants Etat dans COM CNAMTS Régimes d'amo dans les COM ASIP Santé CPAM et CGSS Autres services de l'etat Etablissements et services de santé 6ème partie CSP & Collectivités territoriales et associations gestionnaires d'un service sanitaire ou social Etablissements médico-sociaux ou sociaux Autres établissements publics, groupements, organismes créés par la loi ou le règlement dans le domaine sanitaire et social Hébergeurs, éditeurs, imprimeurs d'ordonnances Organismes et établissements scientifiques ayant pour mission d'agir pour le développement et la diffusion des connaissances dans le domaine sanitaire et social Autres régimes d'amo et organismes d'amc Professionnel de santé Tableau 6: Liste des valeurs possibles pour l élément «Profil_Utilisateur» Règle de gestion de l élément «Profil_Utilisateur_Perimetre» Cas où le Profil_Utilisateur est égal à CU04 Si l utilisateur d un service web s authentifie avec le profil «CU04» (l attribut «code» de l élément «Profil_Utilisateur» est positionné à «CU04»), l attribut «code» de l élément «Profil_Utilisateur_Perimetre» est positionné avec une des valeurs issue de la terminologie de référence «Ordre» (code system , codesystemname R82) dont le contenu est rappelé ci-dessous : VALEUR DESCRIPTION CNOM ONCD CNOP CNOSF Ordre des Médecins Ordre des Chirurgiens-Dentistes Ordre des Pharmaciens Ordre des Sages-Femmes Cas où le Profil_Utilisateur est égal à CU11 Tableau 7: Liste des valeurs de la terminologie de référence «Ordre» Classification : public 29 / 91

30 Si l utilisateur d un service web s authentifie avec le profil «CU11», l élément «originaltext» de l élément «Profil_Utilisateur_Perimetre» est valorisé avec la valeur de l identifiant de la structure (Struct_IdNat). Cas où le profil_utilisateur est égal à CU05, CU07 ou CU12 La règle de gestion relative à l attribut «Profil_Utilisateur_Perimetre» sera définie dans une version ultérieure des web service. Autres cas Dans les autres cas, l attribut «Profil_Utilisateur_Perimetre» n est pas utilisé Exemples de jetons VIHF Ci-dessous un exemple de la structure d un jeton VIHF en mode authentification directe : <saml2:assertion xmlns:hl7="urn:hl7-org:v3" xmlns:saml2="urn:oasis:names:tc:saml:2.0:assertion" xmlns:xsi=" ID="34c34ba6-ba3f-47c8-b906-db079425d6af" IssueInstant=" T15:22:51.003Z" Version="2.0"> <saml2:issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:X509SubjectName">CN=30B /CDET SURNAME=ENFANCE GIVENNAME=CHRISTINE, OU=10B , L=Paris (75), O=TEST, C=FR</saml2:Issuer> <saml2:subject> <saml2:nameid>30b /cdet0001</saml2:nameid> </saml2:subject> <saml2:authnstatement AuthnInstant=" T15:22:51.042Z"> <saml2:authncontext> <saml2:authncontextclassref>urn:oasis:names:tc:saml:2.0:ac:classes:smartcardpki</saml2:authncontextclassref> </saml2:authncontext> </saml2:authnstatement> <saml2:attributestatement> <saml2:attribute Name="VIHF_Version"> <saml2:attributevalue>2.0</saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="Secteur_Activite"> <saml2:attributevalue>sa07^ </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="Ressource_URN"> <saml2:attributevalue>urn:annuairesante</saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="urn:oasis:names:tc:xspa:1.0:subject:subject-id"> <saml2:attributevalue>christine ENFANCE </saml2:AttributeValue> </saml2:attribute> <saml2:attribute Name="Identifiant_Structure"> <saml2:attributevalue>10b </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="LPS_Version"> <saml2:attributevalue>1.1</saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="LPS_ID"> <saml2:attributevalue>id DU LPS </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="LPS_Nom"> <saml2:attributevalue>super_lps</saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="Profil_Utilisateur"> <saml2:attributevalue> <Profil_Utilisateur xmlns="urn:hl7-org:v3" xmlns:xsi="urn:hl7-org:v3" hl7:code="cu04" hl7:codesystem=" " hl7:codesystemname="r78" hl7:displayname=" Conseils des Ordres ="CE"/> </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="Profil_Utilisateur_Perimetre"> Classification : public 30 / 91

31 <saml2:attributevalue> <Profil_Utilisateur_Perimetre xmlns="urn:hl7-org:v3" xmlns:xsi="urn:hl7-org:v3" hl7:code="cnom" hl7:codesystem=" " hl7:codesystemname="r82" hl7:displayname=" Ordre des Médecins " xsi:type="ce"> <originaltext/> </Profil_Utilisateur_Perimetre> </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="VIHF_Profil"> <saml2:attributevalue> <VIHF_Profil xmlns="urn:hl7-org:v3" xmlns:xsi="urn:hl7-org:v3" hl7 :code="profil_annuaire_ps" hl7:codesystem=" " hl7:codesystemname="profil VIHF" hl7:displayname="profil pour annuaire de professionnels de santé du VIHF 2.0" xsi:type="ce"/> </saml2:attributevalue> </saml2:attribute> </saml2:attributestatement> </saml2:assertion> Ci-dessous un exemple de la structure d un jeton VIHF en mode authentification indirecte : <saml2:assertion xmlns:hl7="urn:hl7-org:v3" xmlns:saml2="urn:oasis:names:tc:saml:2.0:assertion" xmlns:xsi=" ID="4df fc6-4f21-a fb4153bed" IssueInstant=" T15:49:24.669Z" Version="2.0"> <saml2:issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:X509SubjectName">CN=Client webservices, OU=annuairesante, O=ASIP, ST=IDF, C=FR</saml2:Issuer> <saml2:subject> <saml2:nameid>30b /cdet0001</saml2:nameid> </saml2:subject> <saml2:authnstatement AuthnInstant=" T15:49:24.706Z"> <saml2:authncontext> <saml2:authncontextclassref>urn:oasis:names:tc:saml:2.0:ac:classes:password</saml2:authncontextclassref> </saml2:authncontext> </saml2:authnstatement> <saml2:attributestatement> <saml2:attribute Name="VIHF_Version"> <saml2:attributevalue>2.0</saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="Secteur_Activite"> <saml2:attributevalue>sa07^ </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="urn:oasis:names:tc:xacml:2.0:resource:resource-id"> <saml2:attributevalue/> </saml2:attribute> <saml2:attribute Name="Ressource_URN"> <saml2:attributevalue>urn:annuairesante</saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="urn:oasis:names:tc:xspa:1.0:subject:subject-id"> <saml2:attributevalue>jean Dupont </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="Identifiant_Structure"> <saml2:attributevalue>10b </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="LPS_Version"> <saml2:attributevalue>1.1</saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="LPS_ID"> <saml2:attributevalue>id du LPS </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="LPS_Nom"> <saml2:attributevalue>super_lps</saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="Profil_Utilisateur"> <saml2:attributevalue> Classification : public 31 / 91

32 <Profil_Utilisateur xmlns="urn:hl7-org:v3" xmlns:xsi="urn:hl7-org:v3" hl7:code="cu11" hl7:codesystem=" " hl7:codesystemname="r78" hl7:displayname=" Etablissements et services de santé 6ème partie CSP & Collectivités territoriales et associations gestionnaires d'un service sanitaire ou social " xsi:type="ce"/> </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="Profil_Utilisateur_Perimetre"> <saml2:attributevalue> <Profil_Utilisateur_Perimetre xmlns="urn:hl7-org:v3" xsi:type="ce"> <originaltext>10b </originaltext> </Profil_Utilisateur_Perimetre> </saml2:attributevalue> </saml2:attribute> <saml2:attribute Name="VIHF_Profil"> <saml2:attributevalue> <VIHF_Profil xmlns="urn:hl7-org:v3" xmlns:xsi="urn:hl7-org:v3" hl7 :code="profil_annuaire_ps" hl7:codesystem=" " hl7:codesystemname="profil VIHF" hl7:displayname="profil pour annuaire de professionnels de santé du VIHF 2.0" xsi:type="ce"/> </saml2:attributevalue> </saml2:attribute> </saml2:attributestatement> </saml2:assertion> Classification : public 32 / 91

33 6. Description fonctionnelle détaillée des services Ce chapitre détaille d un point de vue fonctionnel les Webservices proposés par annuaire.sante.fr. 6.1 Recherche de personnes physiques Principe de construction des flux Présentation du flux d entrée Chaque message en entrée est constitué de deux parties : Une structure d en-tête qui contient les informations propres au flux de données (utilisées par la couche technique) - ENTETE ; Le corps du message qui contient les critères en entrée du web service - FILTRERECHERCHEPP. Figure 3: Corps de message pour la recherche de personnes physiques Présentation du flux de sortie Chaque message en sortie est constitué de deux parties essentielles : Une structure d en-tête qui contient les informations propres au flux de données - ENTETE ; Le corps du message composé de : o Une entrée contenant les critères en entrée - FILTRERECHERCHEPP ; o o o Une entrée qui contient l ensemble des résultats trouvés dans annuaire.sante.fr. Les données retournées sont fonction des habilitations de l application consommatrice LISTEPP ; Une entrée contenant des informations complémentaires sur les résultats de recherche - INFORESULTATSRECHERCHEPP ; Une entrée contenant l exception en cas d erreur - FAULT. A noter : le nombre de résultats retournés dans le flux de sortie (LISTEPP) est limité à 30 Professionnels de santé. Au-delà, les résultats ne sont pas fournis. Classification : public 33 / 91

34 Figure 4: Corps de message pour la réponse du service de recherche de personnes physiques Description du flux d entrée Entête de la requête La structure «ENTETE»est identique à celle présenté en section Critères de recherche La structure «FILTRERECHERCHEPP» regroupant les critères de recherche est détaillé dans le tableau suivant : ATTRIBUT COMMENTAIRE Nom de TR (CodeSystemName) OID TR (CodeSystem) TYPE Longue ur NOM EXERCICE Nom d exercice du professionnel de santé N/A N/A X(80) 80 IDENTIFIANTPP Structure contenant l identifiant de la PP + le type d identifiant : 8 pour RPPS, 0 pour ADELI. Dans la version actuelle du service, seule la valeur 8 (RPPS) est prise en compte. N/A G X(20) 20 PRENOM EXERCICE CODEPROFESSION CODETYPESAVOIR FAIRE CODESAVOIRFAIR E Prénom d exercice du professionnel de santé Code issu du NASS Référence : NPROFESSION Code appartenant à une nomenclature Référence : NTYPESAVOIRFAIRE Code issu du NASS Référence : NSAVOIFAIRE N/A N/A X(50) 50 G X(2) 2 R X(15) 15 R38 ; , R39 ; , R40 ; , X(15) 15 R41 ; , Classification : public 34 / 91

35 ATTRIBUT COMMENTAIRE Nom de TR (CodeSystemName) OID TR (CodeSystem) TYPE Longue ur R42 ; , R43 ; , R44 ; , R45 ; , R Indicateur Présence adresse MSS (*) Indicateur Présence adresse MSS Cet attribut sera pris en compte dans une version ultérieure du web service LD (oui, non) 1 Indicateur Présence DAM (*) Indicateur Présence DAM Cet attribut sera pris en compte dans une version ultérieure du web LD (oui, non) 1 VILLEEXERCICE CODEDEPARTEME NTEXERCICE Code postal ou libellé de la commune du lieu d exercice Code département du lieu d exercice R X(100) 100 G X(3) 3 CODETERRITOIRE DESANTE(*) CODECOMMUNE NAISSANCE (*) Cet attribut sera pris en compte dans une version ultérieure du web service Code postal de la commune de naissance Cet attribut sera pris en compte dans une version ultérieure du web service N/A N/A N/A 15 R X(5) 5 CODEPAYS NAISSANCE (*) Code pays de naissance Cet attribut sera pris en compte dans une version ultérieure du web service R X(5) 5 DTNAISSANCE (*) Date de naissance du professionnel de santé Cet attribut sera pris en compte dans une version ultérieure du web service N/A N/A DT(AAA AMMJJ ) NOCARTECPx (*) Numéro de carte CPx N/A N/A X(10) 10 IDENTIFIANTPM CODESECTEURAC Structure contenant l identifiant de la PM + le type d identifiant : FINESS, SIREN, SIRET, RPPSRang, etc. Code Secteur d activité issu N/A X(20) 20 G X(1) 1 R X(15) 15 Classification : public 35 / 91

36 ATTRIBUT COMMENTAIRE Nom de TR (CodeSystemName) OID TR (CodeSystem) TYPE Longue ur TIVITE de annuaire.sante.fr CODECATEGORIE ETABLISSEMENT CODEAGREGAT CATEGORIEETABLI SSEMENT Code catégorie d établissement issu de annuaire.sante.fr Code agrégat de catégorie d établissement issu de annuaire.sante.fr R X(3) 3 R X(3) 3 (*) Champ prédéfini non utilisable dans la version actuelle. Tableau 8: Description d un filtre de recherche pour les personnes physiques La structure «IDENTIFIANTPP» permet de représenter l identifiant d une personne physique. Cidessous illustrée et détaillée la structure. Figure 5:Structure Identifiant d une personne physique ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE CLASSE IDENTIFIANTPP : CONTENEUR DE L IDENTIFIANT PP IDENTIFIANTPP Identifiant de la personne physique (1) X(20) X TYPEIDENTIFIANTPP Type de l identifiant RPPS ou ADELI NOMENCLATURE X Référence annuaire.sante.fr : NTYPEIDNATIONALPP Code SystemName : G Tableau 9: Description des attributs Identifiant d une personne physique Classification : public 36 / 91

37 (1) Numéro RPPS pour un PS inscrit au RPPS, numéro ADELI pour un PS dont la profession n est pas prise en compte par le RPPS, identifiant délivré par l application consommatrice et stockés dans les éléments de preuve Description du flux de sortie Entête La structure «ENTETE»est identique à celle présenté en section 5.6. Les données retournées correspondent à celles fournies en entrée Critères de recherche La structure «FILTRERECHERCHE» est identique à celle présenté en section Les données retournées correspondent à celle fournie en entrée Résultat de recherche Pour un identifiant de personne donnée, si la personne existe, le résultat est communiqué dans un liste de PP trouvées, sinon, l identifiant est inscrit dans une liste de PP non trouvées Informations complémentaires sur le résultat de la recherche Les informations complémentaires sur le résultat de la recherche sont communiquées dans cette structure «INFORESULTATSRECHERCHEPP». ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE STRUCTURE_INFORECHERCHE : CONTENEUR DES INFORMATIONS COMPLEMENTAIRES SUR LA RECHERCHE NOMBRERESULTATS Nombre de résultats trouvés par annuaire.sante.fr LIMITMAX Nombre de résultats maximums autorisé N(5) N(5) X X MESSAGE Message d information retourné par annuaire.sante.fr X(1024) Tableau 10: Description des infos complémentaires retournées par le service recherche des PP Message d exception Un message est stocké dans l entrée FAULT en cas d erreur Traitements métier, contrôles Traitements effectués sur les critères de recherche Le tableau suivant donne pour chaque critère, les règles qui lui sont appliquées pour rechercher les personnes physiques. Classification : public 37 / 91

38 DONNEES REGLES METIER ASSOCIEES DONNEES PUBLIQUES RM_RECH_PP1, NOM EXERCICE IDENTIFIANTPP PRENOM EXERCICE PROFESSION TYPE DE SAVOIR FAIRE SAVOIR FAIRE RM_RECH_PP3, RM RECH_PP4 RM RECH_PP1, RM RECH_PP3, RM RECH_PP4 RM RECH_PP1, RM RECH_PP3, RM RECH_PP4 RM RECH_PP2, RM RECH_PP3, RM RECH_PP4 RM RECH_PP2, RM RECH_PP3, RM RECH_PP4 RM RECH_PP2, RM RECH_PP3, RM RECH_PP4 O O O O O O Indicateur Présence adresse MSS (*) RM RECH_PP3 (*) Indicateur Présence DAM (*) RM RECH_PP3 (*) VILLE D EXERCICE DEPARTEMENT D EXERCICE TERRITOIRE DE SANTE(*) COMMUNE DE NAISSANCE (*) PAYS DE NAISSANCE (*) RM RECH_PP1, RM RECH_PP3, RM RECH_PP4 RM RECH_PP2, RM RECH_PP3, RM RECH_PP4 RM RECH_PP2, RM RECH_PP3, RM RECH_PP4 RM RECH_PP2,RM RECH_PP3, RM RECH_PP4 RM RECH_PP2, RM RECH_PP3, RM RECH_PP4 O O (*) N N DATE DE NAISSANCE (*) RM RECH_PP3, RM RECH_PP4 N NUMERO DE CARTE CPx (*) RM RECH_PP3, RM RECH_PP4 N IDENTIFIANTPM SECTEUR D ACTIVITE RM RECH_PP1, RM RECH_PP3, RM RECH_PP4, RM RECH_PP4, RM RECH_PP9 RM RECH_PP2, RM RECH_PP3, RM RECH_PP4 O O CATEGORIE D ETABLISSEMENT RM RECH_PP2, RM RECH_PP3, O Classification : public 38 / 91

39 DONNEES REGLES METIER ASSOCIEES DONNEES PUBLIQUES RM RECH_PP4 AGREGAT DE CATEGORIE D ETABLISSEMENT RM RECH_PP2, RM RECH_PP3, RM RECH_PP4 O Tableau 11: Règles métiers appliquées aux critères pour le service recherche des PP (*) Champ prédéfini non utilisable dans la version actuelle Description des règles Code Description Concerne RM RECH_PP1 Chaîne de caractères pouvant inclure les motifs «*» et «?» RM RECH_PP2 Code issu des nomenclatures de référence (2) RM RECH_PP3 Critère non obligatoire Pour information, aucun critère de recherche n est obligatoire L opérateur «=» est appliqué sur le critère RM RECH_PP4 RM RECH_PP5 RM RECH_PP6 RM RECH_PP7 RM RECH_PP8 Exemple : RPPSRANG=<valeur contenue dans le message> Au moins un critère doit être renseigné. Le nombre maximum de résultat de recherche est limité. Ce nombre est paramétrable dans le système annuaire.sante.fr. La recherche doit être exacte. La recherche prend en compte les critères faisant référence à des données publiques. Seules sont sélectionnées les PP dont les attributs correspondent aux critères saisis. La recherche interprète le motif «?» comme joker sur un caractère et le motif «*» comme joker sur un ensemble de caractères). L identifiant de la personne morale est une clé composée du type d'identifiant de personne morale et la valeur de l'identifiant. Les valeurs du type d identifiant sont données par la table G07 : 0 - Id. Cabinet ADELI 1 FINESS (Juridique ou Géographique) RM RECH_PP9 2 SIREN 3 SIRET 4 - Id. Cabinet RPPS 5 - FINESS Juridique 6 - FINESS Géographique recherche d une entité juridique : Classification : public 39 / 91

40 Code Description Concerne 2 SIREN 1 ou 5 - FINESS Juridique recherche d une entité géographique 0 - Id. Cabinet ADELI 3 SIRET 4 - Id. Cabinet RPPS 1 ou 6 - FINESS Géographique Tableau 12: Description des règles métiers du service recherche des PP 6.2 Consultation de personnes physiques Principe de construction des flux Présentation du flux d entrée Chaque message en entrée est constitué de deux parties : Une structure d en-tête qui contient les informations propres au flux de données (utilisées par la couche technique) - ENTETE ; Le corps du message qui contient les critères en entrée du web service - IDENTIFIANTCONSULTATIONPP. Figure 6: Corps de message pour la consultation de personnes physiques Attention : Le nombre d'identifiants en entrée est limité à 20 identités. Ce nombre est paramétrable dans le système annuaire.sante.fr Présentation du flux de sortie Chaque message en sortie est constitué de deux parties essentielles : Une structure d en-tête qui contient les informations propres au flux de données - ENTETE ; Le corps du message composé de : o Une entrée contenant les critères en entrée IDENTIFIANTCONSULTATIONPP ; Classification : public 40 / 91

41 o Une entrée qui contient l ensemble des résultats trouvés dans annuaire.sante.fr. Les données retournées sont fonction des habilitations de l application consommatrice LISTEPPTROUVEES ; o Une entrée qui contient les identifiants des PP non trouvées dans annuaire.sante.fr - LISTEPPNONTROUVEES ; o o Une entrée contenant des informations complémentaires sur les résultats de recherche - INFOCONSULTATIONPP ; Une entrée contenant l exception en cas d erreur - FAULT. Figure 7: Corps de message pour la réponse du service de consultation de personnes physiques Description du flux d entrée Entête de la requête La structure «ENTETE»est identique à celle présenté en section Critères de recherche Les critères de recherche de recherche sont fournies dans la requête d entrée sous forme de liste d identifiant avec une structure de type «IDENTIANTPP». Cette structure est décrite dans la section Description du flux de sortie Entête La structure «ENTETE»est identique à celle présenté en section Critères de recherche La structure est identique à celle présenté en section Les données retournées correspondent à celle fournies en entrée. Classification : public 41 / 91

42 Résultat de la consultation Les résultats trouvés sont transmis par le web service sous forme de listes : Une liste contenant les PP dont les identifiants sont référencés dans annuaire.sante.fr : «LISTEPPTROUVEES» avec la structure «STRUCTURE_MESSAGEPP» Une liste contenant les identifiants non référencés ou non accessibles dans annuaire.sante.fr : «LISTEPPNONTROUVEES» avec la structure «STRUCTURE_MESSAGEPPNONTROUVEES». Ci-dessous illustrée la structure de message retournée par le web service pour une personne physique présente dans annuaire.sante.fr. Figure 8: Structure des résultats retournés par le service de consultation des personnes physiques ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE STRUCTURE_MESSAGEPP: CONTENEUR DE LA STRUCTURE D UN MESSAGE PP IDENTITE L identifiant de la personne physique STRUCTURE_IDENTITE X ETATCIVIL Conteneur de données de base d une personne physique STRUCTURE_PERSONNE X COORDONNEESCORRE SPONDANCE Coordonnées de correspondance STRUCTURE_COORDONNEES ETUDIANTS Conteneur de données d un Etudiant LISTE DE STRUCTURE_ETUDIANT Classification : public 42 / 91

43 ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE LANGUESPARLEES EXERCICESPROFESSIO NNELS DIPLOMES AUTRESDIPLOMES AUTORISATIONS Conteneur de données d une langue parlée Conteneur de données d un exercice professionnel Conteneur de données d un diplôme Conteneur de données d un diplôme Conteneur de données d une autorisation LISTE DE STRUCTURE_LANGUEPARLEE LISTE DE STRUCTURE_EXERCICEPROFES SIONNEL LISTE DE STRUCTURE_DIPLOME LISTE DE STRUCTURE_AUTREDIPLOME LISTE DE STRUCTURE_AUTORISATION Tableau 13: Description de la structure retournée par le service de consultation des PP Ci-dessous illustrée la structure de message retournée par le web service pour un identifiant de personne physique non trouvé dans annuaire.sante.fr. Figure 9: Structure message des résultats des personnes physiques non trouvées dans annuaire.sante.fr ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE STRUCTURE_MESSAGEPPNONTROUVEES: CONTENEUR DE LA STRUCTURE D UN MESSAGE PP NON TROUVEES IDENTIFIANTPP Structure contenant l identifiant de la PP + le type d identifiant : RPPS, ADELI, etc. IDENTIFIANTPP X MESSAGE Message retourné par le système annuaire.sante.fr X(1024) X Tableau 14: Description de la structure retournée par le service de consultation des PP Identité Ci-dessous illustrée la structure «STRUCTURE_IDENTITE» : Classification : public 43 / 91

44 Figure 10: Structure identité d une personne physique Le modèle de la structure «STRUCTURE_IDENTITE» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_IDENTITE: CONTENEUR DE DONNEES D IDENTITES D UNE PERSONNE PHYSIQUE IDENTIFIANTPP CIVILITE Structure contenant l identifiant de la PP + le type d identifiant : RPPS, ADELI, etc. Civilité IDENTIFIANTPP NOMENCLATURE Référence annuaire.sante.fr : NCIVILITE Code SystemName : R NOMUSAGE Nom d usage X(80) PRENOMUSAGE Prénom d usage X(50) DATEACQUISITIONNATIONALITEFR Date d'acquisition de la nationalité française DT(AAAAMMJJ) DATEEFFET Date d effet DT(AAAAMMJJ) PAYSNATIONALITE Pays de nationalité actuelle NOMENCLATURE Référence annuaire.sante.fr : NPAYS Code SystemName : R Tableau 15: Description des attributs de l identité d une PP Etat Civil Ci-dessous illustrée la structure «STRUCTURE_ETATCIVIL» : Classification : public 44 / 91

45 Figure 11: Structure état civil d une personne physique Le modèle de la structure «STRUCTURE_ETATCIVIL» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_ETATCIVIL: CONTENEUR DE DONNEES D ETAT CIVIL D UNE PERSONNE PHYSIQUE NSTATUTETATCIVIL NSEXE Le code statut de l état-civil Le code sexe NOMENCLATURE Référence annuaire.sante.fr : NSTATUTETATCIVIL Code SystemName : R NOMENCLATURE Référence annuaire.sante.fr : NSEXE Code SystemName : R NOMFAMILLE Nom de famille X(80) PRENOMS Prénoms X(150) DATENAISSANCE Date de naissance DT(AAAAMMJJ) LIEUNAISSANCE Lieu de naissance X(50) DATEDECES Date de décès DT(AAAAMMJJ) DATEEFFET NCOMMUNENAISSANCE Date d effet de l étatcivil Le code de la commune de naissance DT(AAAAMMJJ) NOMENCLATURE Référence annuaire.sante.fr : NCOMMUNE Code SystemName : R13 Classification : public 45 / 91

46 ATTRIBUT DEFINITION TYPE COMMENTAIRE NPAYSNAISSANCE Le code du pays de naissance NOMENCLATURE Référence annuaire.sante.fr : NPAYS Code SystemName : R Tableau 16: Description des attributs de l état civil d une PP Coordonnées de correspondance Ci-dessous illustrée la structure «STRUCTURE_COORDONNEES» : Figure 12: Structure coordonnées d une personne physique Le modèle de la structure «STRUCTURE_COORDONNEES» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_ COORDONNEES : CONTENEUR DES COORDONNEES DE CORRESPONDANCE L2COMPLEMENTLOCALISATION Complément X(38) Classification : public 46 / 91

47 ATTRIBUT DEFINITION TYPE COMMENTAIRE d identification du destinataire ou du point de remise L 3COMPLEMENTDISTRIBUTION Complément d identification de la voie (Bis, Ter, etc.) X(38) L 4NUMEROVOIE Numéro dans la voie X(5) L 4COMPLEMENTNUMEROVOIE NTYPEVOIE Indice de répétition dans la voie Le code type de voie (Rue, Voie, etc.) X(38) NOMENCLATURE Référence annuaire.sante.fr : NTYPEVOIE Code SystemName : R L4LIBELLEVOIE L intitulé de la voie X(38) L5LIEUDITMENTION L6LIGNEACHEMINEMENT Lieu-dit ou Service particulier de distribution Complément d'identification du point géographique (Code postal ou code CEDEX) X(38) X(38) NCODEPOSTAL Le code postal NOMENCLATURE Référence annuaire.sante.fr : NCODEPOSTAL Code SystemName : R NCOMMUNE NDEPARTEMENT Le code de la commune Le code département de la commune NOMENCLATURE Référence annuaire.sante.fr : NCOMMUNE Code SystemName : R NOMENCLATURE Référence annuaire.sante.fr : NDEPARTEMENT Code SystemName : G NPAYS Le code du pays NOMENCLATURE Référence annuaire.sante.fr : NPAYS Classification : public 47 / 91

48 ATTRIBUT DEFINITION TYPE COMMENTAIRE Code SystemName : R TELEPHONE TELEPHONE2 TELECOPIE Le numéro de téléphone Le numéro de téléphone portable Le numéro de télécopie X(15) X(15) X(15) COURRIEL L adresse du courriel X(80) Tableau 17: Description des attributs coordonnés d une PP Etudiant Ci-dessous illustrée la structure «STRUCTURE_ ETUDIANT» : Figure 13: Structure étudiant d une personne physique Le modèle de la structure «STRUCTURE_ETUDIANT» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_ ETUDIANT : CONTENEUR DE DONNEES D UN ETUDIANT AUTORISATIONSREMPLACEMENT S DATEDEBUTETUDE DATEFINETUDE Liste des autorisations de remplacement La date de début des études La date de fin des études LISTE DE STRUCTURE_AUT ORISATIONREMP LACEMENT DT(AAAAMMJJ) DT(AAAAMMJJ) Autorisations d exercice en qualité de remplaçant. Tableau 18: Description des attributs de l étudiant d une PP Autorisation de remplacement Classification : public 48 / 91

49 Ci-dessous illustrée la structure «STRUCTURE_ AUTORISATIONREMPLACEMENT» : Figure 14: Structure autorisation de remplacement d une personne physique Le modèle de la structure «STRUCTURE_AUTORISATIONREMPLACEMENT» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_ AUTORISATIONREMPLACEMENT : CONTENEUR DE DONNEES DES AUTORISATIONS DE REMPLACEMENTS DATEDEBUT La date de début DT(AAAAMMJJ) AUTORISATIONS D EXERCICE EN QUALITE DE REMPLAÇANT. DATEFIN La date de fin DT(AAAAMMJJ) NORDRE AE ayant délivré la licence de remplacement : NOMENCLATURE Référence annuaire.sante.fr : NAUTORITEENREGISTREMEN T Code SystemName : R Tableau 19: Description des attributs Autorisation de remplacement d une PP Langue Parlée Ci-dessous illustrée la structure «STRUCTURE_ LANGUEPARLEE» : Figure 15: Structure d une langue parlée par une personne physique Le modèle de la structure «STRUCTURE_LANGUEPARLEE» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_LANGUEPARLEE : CONTENEUR DE DONNEES D UNE LANGUE NLANGUE Le code de la langue NOMENCLATURE Référence annuaire.sante.fr : NLANGUEPARLE Code SystemName : G00 Classification : public 49 / 91

50 ATTRIBUT DEFINITION TYPE COMMENTAIRE DATEFIN La date de fin DT(AAAAMMJJ) Tableau 20: Description des attributs de Langue parlée d une PP Diplôme Obtenu Ci-dessous illustrée la structure «STRUCTURE_ DIPLOME» : Figure 16: Structure diplôme d une personne physique Le modèle de la structure «STRUCTURE_DIPLOME» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_DIPLOME : CONTENEUR DE DONNEES D UN DIPLOME NLIEUFORMATION Le lieu de formation NOMENCLATURE Référence annuaire.sante.fr : NLIEUFORMATION Code SystemName: R NDIPLOME Le code du diplôme NOMENCLATURE Référence annuaire.sante.fr : NDIPLOME DIPLOMELIBELLE Le libelle du diplôme X(250) Code SystemName: R47, R48, R49, R50, R , , , , Classification : public 50 / 91

51 ATTRIBUT DEFINITION TYPE COMMENTAIRE NTYPEDIPLOME Le type de diplôme NOMENCLATURE Référence annuaire.sante.fr : NTYPEDIPLOME NUMERODIPLOME Le numéro de diplôme X(40) DATEOBTENTION La date d obtention DT(AAAAMMJJ) Code SystemName: R Tableau 21: Description des attributs Diplôme d une PP Autre Diplôme Obtenu Ci-dessous illustrée la structure «STRUCTURE_ AUTREDIPLOME» : Figure 17: Structure autre diplôme d une personne physique Le modèle de la structure «STRUCTURE_AUTREDIPLOME» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_AUTREDIPLOME : CONTENEUR DE DONNEES D UN AUTRE DIPLOME OBTENU NAUTREDIPLOME Le code autre diplôme non référencé dans la nomenclature Diplôme standard NOMENCLATURE Référence annuaire.sante.fr : NAUTREDIPLOME Code SystemName: R AUTREDIPLOMELIBELLE Le libelle du diplôme X(250) NLIEUFORMATION Le lieu de formation NOMENCLATURE Référence annuaire.sante.fr : NLIEUFORMATION NUMERODIPLOME Le numéro de X(40) Code SystemName: R Classification : public 51 / 91

52 ATTRIBUT DEFINITION TYPE COMMENTAIRE diplôme DATEOBTENTION La date d obtention DT(AAAAMMJJ) Tableau 22: Description des attributs Autre Diplôme Obtenu Autorisation Ci-dessous illustrée la structure «STRUCTURE_ AUTORISATION» : Figure 18: Structure autorisation d une personne physique Le modèle de la structure «STRUCTURE_AUTORISATION» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_AUTORISATION : CONTENEUR DE DONNEES D UNE AUTORISATION NPROFESSION Le code de la profession NOMENCLATURE Référence annuaire.sante.fr : NPROFESSION Code SystemName: G NTYPEAUTORISATION Le type d autorisation NOMENCLATURE Référence annuaire.sante.fr : NTYPEAUTORISATION Code SystemName: R DATEEFFET DATEFIN NDISCIPLINE La date d effet de l autorisation La date de fin de l autorisation Le code de la discipline d autorisation DT(AAAAMMJJ) DT(AAAAMMJJ) NOMENCLATURE Référence annuaire.sante.fr : NDISCIPLINE Code SystemName: R18 Classification : public 52 / 91

53 ATTRIBUT DEFINITION TYPE COMMENTAIRE Tableau 23: Description des attributs Autorisation d une PP Exercice Professionnel Ci-dessous illustrée la structure «STRUCTURE_ EXERCICEPROFESSIONNEL» : Figure 19: Structure exercice professionnel d une personne physique Le modèle de la structure «STRUCTURE_EXERCICEPROFESSIONNEL» est détaillé ci-dessous : ATTRIBUT Définition TYPE COMMENTAIRE STRUCTURE_ EXERCICEPROFESSIONNEL : CONTENEUR DE DONNEES D UN EXERCICE PROFESSIONNEL NOMEXERCICE Le nom d exercice X(80) PRENOMEXERCICE Le prénom d exercice X(50) NPROFESSION Le code de la profession NOMENCLATURE Référence annuaire.sante.fr : NPROFESSION Classification : public 53 / 91

54 ATTRIBUT Définition TYPE COMMENTAIRE Code SystemName: G15 Code Système : NCIVILITEEXERCICE Le code de la civilité de l exercice NOMENCLATURE Référence annuaire.sante.fr : NCIVILITEEXERCICE Code SystemName: R NCATEGORIEPROFESSION DATEEFFET DATEFIN Le code de la catégorie du professionnel de santé La date d effet du l exercice La date de fin du l exercice NOMENCLATURE Référence annuaire.sante.fr : NCATEGORIEPS DT(AAAAMMJJ) DT(AAAAMMJJ) Code SystemName: R DATEDEBUTPREMIEREINSCRIPTIO N La date de la première inscription dans l ordre DT(AAAAMMJJ) NORDREPREMIEREINSCRIPTIONC Le code de l ordre de la première inscription NOMENCLATURE Référence annuaire.sante.fr : NAUTORITEENREGISTREM ENT Code SystemName: R NDEPARTEMENTPREMIEREINSCRI PTION Le code du département de la première inscription NOMENCLATURE Référence annuaire.sante.fr : NDEPARTEMENT Code SystemName: G SITUATIONPH La situation du PH STRUCTURE_SIT UATIONPH SAVOIRSFAIRES La période de savoir faire LISTE DE STRUCTURE_PER IODE SAVOIRFAIRE SANCTIONS Les sanctions LISTE DE STRUCTURE_SAN CTION PERIODESATTRIBUTIONSPARTICU Les périodes d attributions LISTE DE STRUCTURE_ Classification : public 54 / 91

55 ATTRIBUT Définition TYPE COMMENTAIRE LIERES particuliers PERIODEATTRIBU TION PARTICULIER REFERENCEMENTAUPRESAE SITUATIONSEXERCICE Les inscriptions auprès des AE La liste des situations de l exercice LISTE DE STRUCTURE_REF ERENCEMENTAE LISTE DE STRUCTURE_ SITUATIONEXERC ICE CARTESCPS Les cartes CPS LISTE DE STRUCTURE_CAR TECPS Tableau 24: Description des attributs Exercice Professionnel d une PP Situation PH Ci-dessous illustrée la structure «STRUCTURE_ SITUATIONPH» : Figure 20: Structure situation praticien hospitalier d un exercice professionnel Le modèle de la structure «STRUCTURE_SITUATIONPH» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_SITUATIONPH : CONTENEUR DE DONNEES D UNE SITUATION HOSPITALIER DATENOMINATION La date de la nomination DT(AAAAMMJJ) EJRATTACHEMENT L établissement juridique de rattachement X(9) NSTATUTPH Le code statut hospitalier NOMENCLATURE Référence annuaire.sante.fr : NSTATUTPH Code SystemName: R Classification : public 55 / 91

56 ATTRIBUT DEFINITION TYPE COMMENTAIRE NSAVOIRFAIRE Type de savoir-faire NOMENCLATURE Référence annuaire.sante.fr : NSAVOIRFAIRE Code SystemName: R38 ; R39 ; R40 ; R41 ; R42 ; R43 ; R44 ; R45 ;R , , , , , , , , DATEDEBUTINSTALL DATEFININSTALL DATEFINSTATUTPH La date de début d installation La date de fin d installation La date de fin de statut hospitalier DT(AAAAMMJJ) DT(AAAAMMJJ) DT(AAAAMMJJ) Tableau 25: Description des attributs Situation PH d une PP Savoir faire Ci-dessous illustrée la structure «STRUCTURE_ PERIODESAVOIRFAIRE» : Figure 21: Structure d une période de savoir-faire d un exercice professionnel Le modèle de la structure «STRUCTURE_PERIODESAVOIRFAIRE» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_ PERIODESAVOIRFAIRE : CONTENEUR DE DONNEES D UNE PERIODE DE SAVOIR FAIRE LIEE A UN EXERCICE PROFESSIONNEL NSAVOIRFAIRE Le code du savoir faire NOMENCLATURE Référence annuaire.sante.fr : NSAVOIRFAIRE Classification : public 56 / 91

57 ATTRIBUT DEFINITION TYPE COMMENTAIRE Code SystemName: R38 ; R39 ; R40 ; R41 ; R42 ; R43 ; R44 ; R45 ; R , , , , , , , , NTYPESAVOIRFAIRE DATERECONNAISSANCE Le code du type de savoir faire La date de la reconnaissance NOMENCLATURE Référence annuaire.sante.fr : NTYPESAVOIRFAIRE DT(AAAAMMJJ) Code SystemName: R DATEABANDON La date d abandon DT(AAAAMMJJ) Tableau 26: Description des attributs Période de savoir-faire d une PP Sanction Ci-dessous illustrée la structure «STRUCTURE_ SANCTION» : Figure 22: Structure d une sanction d un exercice professionnel Le modèle de la structure «STRUCTURE_SANCTION» est détaillé ci-dessous : Classification : public 57 / 91

58 ATTRIBUT Définition TYPE COMMENTAIRE STRUCTURE_SANCTION : CONTENEUR DE DONNEES D UNE SANCTION NTYPESANCTION Le code du type de sanction NOMENCLATURE Référence annuaire.sante.fr : NTYPESANCTION Code SystemName: R NORIGINESANCTION Le code de l origine de la sanction NOMENCLATURE Code issu du NASS table libellée NORIGINESANCTION Code SystemName: R NNIVEAUSANCTION Le niveau de la sanction DT(AAAAMMJJ) Référence annuaire.sante.fr : NNIVEAUSANCTION Code SystemName: R DATEDEBUT La date de début de la sanction DT(AAAAMMJJ) DATEFIN La date de fin de la sanction DT(AAAAMMJJ) MENTION La mention de la sanction X(100) DATEMENTION La date de la mention DT(AAAAMMJJ) NINFRACTION Le code de l infraction NOMENCLATURE Référence annuaire.sante.fr : NINFRACTION Code SystemName: R Tableau 27: Description des attributs Attribution d une PP Attribution particulière Ci-dessous illustrée la structure «STRUCTURE_ ATTRIBUTIONPARTICULIERE» : Figure 23: Structure d une attribution particulière d un exercice professionnel Le modèle de la structure «STRUCTURE_ATTRIBUTIONPARTICULIERE» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE Classification : public 58 / 91

59 ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_ATTRIBUTIONPARTICULIERE : CONTENEUR DE DONNEES D UNE ATTRIBUTION PARTICULIERE NATTRIBUTIONPARTICULIERE Le code de l attribution particulière NOMENCLATURE Référence annuaire.sante.fr : NATTRIBUTIONPARTICULIER E Code SystemName: R DATERECONNAISSANCE La date de reconnaissance DT(AAAAMMJJ) DATEABANDON La date de l abandon DT(AAAAMMJJ) Tableau 28: Description des attributs Période Attribution Particulières d une PP Référencement auprès de l'ae Ci-dessous illustrée la structure «STRUCTURE_ REFERENCEMENTAE» : Figure 24: Structure d un référencent d auprès AE Le modèle de la structure «STRUCTURE_REFERENCEMENTAE» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_REFERENCEMENTAE : CONTENEUR DE DONNEES D UNE INSCRIPTION AUPRES D UNE AE NAUTORITEENREGISTREMENT Le code de l ordre NOMENCLATURE Référence annuaire.sante.fr : NAUTORITEENREGISTREMENT Code SystemName: R DATEENREGISTREMENT DATEDEBUTINSCRIPTION DATEFININSCRIPTION Date d'enregistrement dans le fichier de l'autorité d enregistrement (différent de la date d inscription) Date de l inscription du professionnel de santé auprès de l autorité d enregistrement gérant sa profession Date à partir de laquelle le DT(AAAAMMJJ) DT(AAAAMMJJ) DT(AAAAMMJJ) Classification : public 59 / 91

60 ATTRIBUT DEFINITION TYPE COMMENTAIRE professionnel de santé n est plus autorisé à exercer la profession pour laquelle il a été référencé Statut de l inscription NOMENCLATURE NSTATUTINSCRIPTION Nomenclature indiquant l avancement du traitement du dossier de l inscription : - T : Transfert dossier - P : Provisoire : la commission n a pas encore statué sur la demande de référencement Référence annuaire.sante.fr : NSTATUTINSCRIPTION Code SystemName: R D : Définitif : la commission a statué et a donné son avis (positif ou négatif) - N : Non inscrit NDEPTINSCRIPTION Le département d inscription NOMENCLATURE Référence annuaire.sante.fr : NDEPARTEMENT Code SystemName: G NDEPTACCUEIL Département d accueil (si transfert de dossier) NOMENCLATURE Référence annuaire.sante.fr : NDEPARTEMENT Code SystemName: G Tableau 29: Description des attributs Référencement d auprès AE d une PP Situation exercice Ci-dessous illustrée la structure «STRUCTURE_ SITUATIONEXERCICE» : Classification : public 60 / 91

61 Figure 25: Structure d une activité d un exercice professionnel Le modèle de la structure «STRUCTURE_SITUATIONEXERCICE» est détaillé ci-dessous : ATTRIBUT Définition TYPE COMMENTAIRE STRUCTURE_SITUATIONEXERCICE : CONTENEUR DE DONNEES D UNE SITUATION DE L EXERCICE PROFESSIONNEL IDENTIFIANTACTIVITE L identifiant de l activité X(10) MODEEXERCICE Le mode d exercice (libéral, salarie, etc.) NOMENCLATURE Référence annuaire.sante.fr : NMODEEXERCICE Code SystemName: R DATEDEBUT La date de début de l activité DT(AAAAMMJJ) DATEFIN La date de fin de l activité DT(AAAAMMJJ) NGENREACTIVITE NSECTIONPHARMACIEN Activité standard de soin ou de pharmacien ; Activité non soignante Le code section du tableau de l Ordre des Pharmaciens NOMENCLATURE Référence annuaire.sante.fr : NGENREACTIVITE Code SystemName: R NOMENCLATURE Référence annuaire.sante.fr : NSECTIONPHARMACIEN Classification : public 61 / 91

62 ATTRIBUT Définition TYPE COMMENTAIRE Code SystemName: R NSOUSSECTIONPHARMACIEN NREGIONORDREDUPHARMACIEN NSTATUTPH NTYPEACTIVITELIBERALE Le code de la soussection du tableau de l Ordre des Pharmaciens La région d exercice pour les pharmaciens d officines Le code du statut hospitalier Le code type d activité libérale NOMENCLATURE NOMENCLATURE NOMENCLATURE NOMENCLATURE NFONCTION Le code fonction NOMENCLATURE NSTATUTPSSA Le code du statut des professionnels du SSA NOMENCLATURE Référence annuaire.sante.fr : NSOUSSECTIONPHARMACIE N Code SystemName: R Référence annuaire.sante.fr : NREGION Code SystemName: R Référence annuaire.sante.fr : NSTATUTHOSPITALIER Code SystemName: R Référence annuaire.sante.fr : NTYPEACTIVITELIBERALE Code SystemName: R Référence annuaire.sante.fr : NFONCTION Code SystemName: R Référence annuaire.sante.fr : NSTATUTPSSA Code SystemName: R COORDONNEESSITUATION Les coordonnées STRUCTURE_CO ORDONNEES NMOTIFFINACTIVITE Le code du motif de fin d activité NOMENCLATURE Référence annuaire.sante.fr : NMOTIFFINACTIVITE Code SystemName: R Classification : public 62 / 91

63 ATTRIBUT Définition TYPE COMMENTAIRE STRUCTUREACTIVITE L identifiant de la structure d exercice (lieu d activité) IDENTIFIANTPM Tableau 30: Description des attributs Situation d Exercice d une PP Carte CPS Ci-dessous illustrée la structure «STRUCTURE_ CARTECPS» : Figure 26: Structure d une carte CPS Le modèle de la structure «STRUCTURE_CARTECPS» est détaillé ci-dessous : ATTRIBUT Définition TYPE COMMENTAIRE STRUCTURE_CARTECPS : CONTENEUR DE DONNEES D UNE CARTE CPS NUMERO DATEDEBUTVALIDITE DATEFINVALIDITE DATEOPPOSITION NTYPECPS Le numéro de la carte CPS La date de début de la validité de la carte La date de fin de la validité de la carte La date d opposition de la carte Le type de carte professionnelle X(10) DT(AAAAMMJJ) DT(AAAAMMJJ) DT(AAAAMMJJ) NOMENCLATURE Référence annuaire.sante.fr : NTYPECPS Code SystemName: G02 Code System : Tableau 31: Description des attributs Carte CPS d une PP Informations complémentaires sur le résultat de la consultation Les informations complémentaires sur le résultat de la consultation sont communiquées dans cette structure. Classification : public 63 / 91

64 ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE STRUCTURE_INFOCONSULTATION : CONTENEUR DES INFORMATIONS COMPLEMENTAIRES SUR LA CONSULTATION NOMBRECONSULTATIONS Nombre de résultats trouvés par le système annuaire.sante.fr LIMITMAX Nombre de résultats maximums autorisé MESSAGE Message d information retourné par le système annuaire.sante.fr N(5) N(5) X(1024) x x Tableau 32: Description des attributs Informations complémentaires retournées par le service de consultation des PP Message d exception Un message est stocké dans l entrée FAULT en cas d erreur Traitements métier, contrôles Traitements effectués sur les critères de recherche Le tableau suivant donne pour chaque critère la règle qui lui est appliquée pour rechercher les données. DONNEES Règles métier associées DONNEES PUBLIQUES STRUCTURE IDENTIFIANTCONSULTATION IDENTIFIANTPERSONNE RM_CONS_PP1 O TYPEIDENTIFIANTPERSONNE RM_CONS_PP1 O Tableau 33: Description des règles métiers du service consultation des PP Description des règles Code Description Concerne RM_CONS_PP1 Le critère est obligatoire L opérateur «=» est appliqué sur le critère RM_CONS_PP2 RM_CONS_PP3 RM_CONS_PP4 Exemple : RPPSRANG=<valeur contenue dans le message> Le nombre maximum de résultat de recherche est limité. Ce nombre est paramétrable Le système annuaire.sante.fr recherche les PP dont les identifiants sont passés en critère de recherche. Les PP trouvées sont retournées dans la liste LISTEPPTROUVEES avec une structure contenant les informations de la PP. Classification : public 64 / 91

65 Code Description Concerne Les PP non trouvées sont retournées dans la liste LISTEPPNONTROUVEES contenant l identifiant passé en entrée et un message d information. RM CONS_PP5 RM CONS_PP6 Le nombre de message retourné par le système annuaire.sante.fr est identique au nombre d identifiants passé en entrée du service. Il faut un minimum une structure d identifiant en entrée. Tableau 34: Description des règles métiers du service de consultation des PP Classification : public 65 / 91

66 6.3 Recherche de personnes morales Principe de construction des flux Présentation du flux d entrée Chaque message en entrée est constitué de deux parties : Une structure d en-tête qui contient les informations propres au flux de données (utilisées par la couche technique) - ENTETE ; Le corps du message qui contient les critères en entrée du web service - FILTRERECHERCHEPM. Figure 27: Corps de message pour la recherche de personnes morales Présentation du flux de sortie Chaque message en sortie est constitué de quatre parties essentielles : Une structure d en-tête qui contient les informations propres au flux de données - ENTETE ; Le corps du message composé de : o Une entrée contenant les critères en entrée - FILTRERECHERCHEPM ; o o o Une entrée qui contient l ensemble des résultats trouvés par le système annuaire.sante.fr. Les données retournées sont fonction des habilitations de l application consommatrice LISTESPM ; Une entrée contenant des informations complémentaires sur les résultats de recherche - INFORESULTATSRECHERCHEPM ; Une entrée contenant l exception en cas d erreur - FAULT. A noter : le nombre de résultats retournés dans le flux de sortie (LISTEPM) est limité à 30 Etablissements de santé. Classification : public 66 / 91

67 Figure 28: Corps de message pour la réponse du service de recherche de personnes morales Description du flux d entrée Entête de la requête La structure «ENTETE»est identique à celle présenté en section Critères de recherche La structure «FILTRERECHERCHEPM» regroupant les critères de recherche est détaillé dans le tableau suivant : ATTRIBUT COMMENTAIRE Nom de TR CodeSystemName OID TR CodeSystem TYPE Longueur RAISON SOCIALE S/O X (164) 164 ENSEIGNE COMMERCIALE IDENTIFIANTPM CODETYPE STRUCTURE Indicateur Présence adresse MSS S/O Structure contenant l identifiant de la PM + le type d identifiant : SIRET, FINESS, SIREN, etc. Le code de type structure initialisé avec une des valeurs : EG Entité géographique EJ Entité juridique Indicateur Présence adresse MSS Valeur non traitée dans la version actuelle du système X (50) 50 IDENTIFIANTP M R X(2) 2 LD (oui/non) 1 Classification : public 67 / 91

68 ATTRIBUT COMMENTAIRE Nom de TR CodeSystemName OID TR CodeSystem TYPE Longueur Indicateur DAM Présence Indicateur Présence DAM Valeur non traitée dans la version actuelle du système LD (oui/non) 1 CODESTATUTJURIDIQ UE Le code du statut juridique équivalent à la catégorie juridique issue du RPPS R X(15) 15 CODEETAT Le code d état d un établissement (ouvert ou fermé) R LD (OUVERT, FERME) 10 CODEAPE Sous classe Nomenclature d Activités Française NAF X (15) 15 CODEDOMAINE Le code du domaine Catégories établissement R X (15) 15 CODEAGREGATCATEG ORIEETABLISSEMENT CODECATEGORIEETAB LISSEMENT CODESECTEUR ACTIVITE Le code d agrégat de catégories d établissement Le code de la catégorie d établissement Le code du secteur d activité santé R X (3) 3 R X (3) 3 R X (15) 15 CODEREGION Le code de la région de localisation de l établissement Valeur non traitée dans la version actuelle du système R X (3) 3 CODEDEPARTEMENT CODECOMMUNE CODETERRITOIRESAN TE Le code du département de localisation de l établissement Le code de la commune de localisation de l établissement Territoire de santé Valeur non traitée dans la version actuelle du G X (3) 3 R X (5) 5 Classification : public 68 / 91

69 ATTRIBUT COMMENTAIRE Nom de TR CodeSystemName OID TR CodeSystem TYPE Longueur système Tableau 35: Description u filtre de recherche pour les personnes morales La structure «IDENTIFIANTPM» permet de représenter l identifiant d une personne morale. Ci-dessous illustrée et détaillée la structure. Figure 29: Structure Identifiant d une personne morale ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE CLASSE IDENTIFIANTPP : CONTENEUR DE L IDENTIFIANT PP IDENTIFIANTPM Identifiant de la personne morale (1) X(20) X TYPEIDENTIFIANTPM Type d identifiant de la personne morale (SIRET, SIREN, FINESS, etc). NOMENCLATURE X Référence annuaire.sante.fr : N/A Code SystemName: G Tableau 36: Description des attributs Identifiant d une personne physique (1) Identifiant de personne morale : il peut s agir d un SIREN, d un SIRET, d un numéro FINESS, d un RPPSrang Description du flux de sortie Entête La structure «ENTETE» est identique à celle présenté en section Les données retournées correspondent à celles fournies en entrée. Classification : public 69 / 91

70 Critères de recherche La structure «FILTRERECHERCHEPM» est identique à celle présenté en section Les données retournées correspondent à celle fournies en entrée Résultat de recherche Pour un identifiant de personne morale donnée, si elle existe, le résultat est communiqué dans un liste de PM trouvées, sinon, l identifiant est inscrit dans une liste de PM non trouvées Informations complémentaires sur le résultat de la recherche Les informations complémentaires sur le résultat de la recherche sont communiquées dans cette structure «INFORESULTATSRECHERCHEPM». ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE STRUCTURE_INFORECHERCHE : CONTENEUR DES INFORMATIONS COMPLEMENTAIRES SUR LA RECHERCHE NOMBRERESULTATS Nombre de résultats trouvés par le système annuaire.sante.fr LIMITMAX Nombre de résultats maximums autorisé MESSAGE Message d information retourné par le système annuaire.sante.fr N(5) N(5) X(1024) X X Tableau 37: Description des infos complémentaires retournées par le service recherche des PM Message d exception Un message est stocké dans l entrée FAULT en cas d erreur Traitements métier, contrôles Traitements effectués sur les critères de recherche Le tableau suivant donne pour chaque critère, les règles qui lui sont appliquées pour rechercher les personnes morales. DONNEES Règles métier associées DONNEES PUBLIQUES RAISON SOCIALE ENSEIGNE COMMERCIALE IDENTIFIANTPM RM_RECH_PM1, RM_RECH_PM3 RM_RECH_PM1, RM_RECH_PM3 RM_RECH_PM1, RM_RECH_PM3, RM_RECH_PM9 O O O Classification : public 70 / 91

71 DONNEES Règles métier associées DONNEES PUBLIQUES TYPE STRUCTURE (EG ou EJ) Indicateur Présence adresse MSS (*) Valeur non traitée dans la version actuelle du système RM_RECH_PM2, RM_RECH_PM3 RM_RECH_PM3 O x Indicateur Présence DAM (*) Valeur non traitée dans la version actuelle du système STATUT JURIDIQUE RM_RECH_PM3 RM_RECH_PM2, RM_RECH_PM3 x O ETAT RM_RECH_PM3 O CODE APE DOMAINE AGREGAT DE CATEGORIE D ETABLISSEMENT CATEGORIE D ETABLISSEMENT SECTEUR D ACTIVITE REGION DEPARTEMENT COMMUNE RM_RECH_PM2, RM_RECH_PM3 RM_RECH_PM2, RM_RECH_PM3 RM_RECH_PM2, RM_RECH_PM3 RM_RECH_PM2, RM_RECH_PM3 RM_RECH_PM2, RM_RECH_PM3 RM_RECH_PM2, RM_RECH_PM3 RM_RECH_PM2, RM_RECH_PM3 RM_RECH_PM2, RM_RECH_PM3 O O O O O O O O TERRITOIRE DE SANTE RM_RECH_PM 3 O Tableau 38: Règles métiers appliquées aux critères pour le service recherche des PM (*) Champ non pris en compte dans le filtre de recherche dans la version courante du Web service Description des règles Code Description Concerne RM_RECH_PM1 Chaîne de caractères pouvant inclure les motifs «*» et «?» Classification : public 71 / 91

72 Code Description Concerne RM_RECH_PM2 RM_RECH_PM3 Code issu des nomenclatures de référence Critère non obligatoire Pour information, aucun critère de recherche n est obligatoire L opérateur «=» est appliqué sur le critère RM_RECH_PM4 RM_RECH_PM5 RM_RECH_PM6 RM_RECH_PM7 RM_RECH_PM8 Exemple : RPPSRANG=<valeur contenue dans le message> Au moins un critère est obligatoire. Le nombre maximum de résultat de recherche est limité. Ce nombre est paramétrable La recherche doit être exacte. La recherche prend en compte tous les critères saisis. Seules sont sélectionnées les PM dont les attributs correspondent à l'ensemble des critères saisis. La recherche interprète le motif «?» comme joker sur un caractère et le motif «*» comme joker sur un ensemble de caractères) La recherche des établissements s effectue par rapport à l identifiant PM et le type d identifiant. RM_RECH_PM9 Si le type d'identifiant = 1 alors on recherche, sur l ensemble des établissements juridiques et géographique, la structure correspondante à l identifiant PM. Si le type d'identifiant = 5 alors on recherche l entité juridique correspondante à l identifiant PM Type d'identifiant =6 alors on recherche l entité géographique correspondante à l identifiant PM Tableau 39: Description des règles métiers du service recherche des PM 6.4 Consultation de personnes morales Principe de construction des flux Présentation du flux d entrée Chaque message en entrée est constitué de deux parties : Une structure d en-tête qui contient les informations propres au flux de données (utilisées par la couche technique) - ENTETE ; Le corps du message qui contient les critères de recherche en entrée du web service - IDENTIFIANTCONSULTATIONPM. Classification : public 72 / 91

73 Figure 30: Corps de message pour la consultation de personnes morales Attention : Le nombre d'identifiants en entrée est limité à 20. Ce nombre est paramètre dans le système annuaire.sante.fr Présentation du flux de sortie Chaque message en sortie est constitué de quatre parties essentielles : Une structure d en-tête qui contient les informations propres au flux de données - ENTETE ; Le corps du message composé de : o Une entrée contenant les critères en de recherche IDENTIFIANTCONSULTATIONPM ; o Une entrée qui contient l ensemble des résultats trouvés dans annuaire.sante.fr. Les données retournées sont fonction des habilitations de l application consommatrice LISTEPMTROUVEES ; o Une entrée qui contient les identifiants des PM non trouvées dans annuaire.sante.fr - LISTEPMNONTROUVEES ; o o Une entrée contenant des informations complémentaires sur les résultats de recherche - INFOCONSULTATIONPM ; Une entrée contenant l exception en cas d erreur - FAULT. Figure 31: Corps de message pour la réponse du service de consultation de personnes morales Classification : public 73 / 91

74 6.4.2 Description du flux d entrée Entête de la requête La structure «ENTETE»est identique à celle présenté en section Critères de recherche Les critères de recherche de recherche sont fournies dans la requête d entrée sous forme de liste d identifiant avec une structure de type «IDENTIANTNPM». Cette structure est décrite dans la section Description du flux de sortie Entête La structure «ENTETE»est identique à celle présenté en section Critères de recherche La structure est identique à celle présenté en section Les données retournées correspondent à celle fournies en entrée Résultat de la consultation Les résultats trouvés sont transmis par le web service sous forme de listes : Une liste contenant les PM dont les identifiants sont référencés dans annuaire.sante.fr : «LISTEPMTROUVEES» avec la structure «STRUCTURE_MESSAGEPM» Une liste contenant les identifiants non référencés ou non accessibles dans annuaire.sante.fr : «LISTEPMNONTROUVEES» avec la structure «STRUCTURE_MESSAGEPMNONTROUVEES». Figure 32: Structure des résultats retournés par le service de consultation des personnes morales ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE STRUCTURE_MESSAGEPM: CONTENEUR DE LA STRUCTURE D UN MESSAGE PM IDENTIFIANTPM L identifiant de la personne morale STRUCTURE_IDENTITE X Structure contenant l identifiant de la PM + le type d identifiant : SIRET, FINESS, SIREN, Classification : public 74 / 91

75 ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE etc. STRUCTURE Les informations sur la structure STRUCTURE_STRUCT URE X LISTEPP Liste des PP en exercice dans la structure STRCTURE_MESSAGE PP Les informations restituées sont réduites pour chaque PM (PS : identifiant, Nom Exe, Prénom Exe, Profession & Savoirs Faire) LISTEEG Liste des EG dans le cas où la structure est de type EJ STRCTURE_MESSAGE _EG Les informations restituées sont réduites pour chaque EJ, la liste des EG correspondantes (EG : id, RS, EC, catégorie) Tableau 40: Description de la structure retournée par le service de consultation des PM Ci-dessous illustrée la structure de message retournée par le web service pour un identifiant de personne physique non trouvé dans annuaire.sante.fr. Figure 33: Structure message des résultats des personnes morales non trouvées dans annuaire.sante.fr ATTRIBUT DEFINITION TYPE OBLIGATOIRE COMMENTAIRE STRUCTURE_MESSAGEPMNONTROUVEES: CONTENEUR DE LA STRUCTURE D UN MESSAGE PM NON TROUVEES IDENTIFIANTPM Structure contenant l identifiant de la PM + le type d identifiant : SIRET, SIREN, etc. IDENTIFIANTPM X MESSAGE Message retourné par le système annuaire.sante.fr X(1024) X Tableau 41: Description de la structure retournée par le service de consultation des PM Identifiant de la structure Le modèle de la structure «IDENTIFIANTPM» est détaillé en section Structure Ci-dessous illustrée la structure «STRUCTURE_ STRUCTURE» : Classification : public 75 / 91

76 Figure 34: Structure d une personne morale trouvée dans annuaire.sante.fr Le modèle de la structure «STRUCTURE_STRUCTURE» est détaillé ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_STRUCTURE: CONTENEUR DE DONNEES DE BASE D UNE STRUCTURE (PERSONNE MORALE) IDENTIFIANTPM Identifiant structure IDENTIFIANTPM Structure contenant l identifiant de la PM + le type d identifiant : SIRET, FINESS, SIREN, etc. TYPE STRUCTURE Le type de structure: Valeurs EG (Etablissement géographique) ou EJ NOMENCLATURE Référence annuaire.sante.fr : TYPESTRUCTURE Code SystemName: R67 Classification : public 76 / 91

77 ATTRIBUT DEFINITION TYPE COMMENTAIRE (Entité juridique) Code System : RAISONSOCIALE Libelle Raison Sociale X(164) RAISONSOCIALELONG COMPLEMENTRAISONSOCI ALE Libelle Raison Sociale Long Complément de la Raison Sociale X(164) X(164) ENSEIGNECOMMERCIALE Enseigne Commerciale X(50) NATUREETABLISSEMENT Nature Etablissement X(1) Valeur G ou B NUMEROFINESSETABPRINC IPAL Numéro FINESS Etablissement Principal X(9) NUMEROSIRET Numéro Siret X(14) Information restituée pour les entités géographiques (EG) NUMEROSIREN Numéro Siren X(9) Information restituée pour les entités juridiques (EJ) DATEMAJSIREN La date de mise à jour SIREN DT(AAAAMMJJ) ORIGINEMAJSIREN L origine de mise à jour SIREN X(20) DATEMAJSIRET La date de mise à jour Siret DT(AAAAMMJJ) ORIGINEMAJSIRET L origine de mise à jour SIRET X(20) DATECREATION La date de création DT(AAAAMMJJ) QUALIFICATIONCREATION La qualification création X(3) DATEOUVERTURE La date d ouverture DT(AAAAMMJJ) DATEMAJSTRUCTURE La date de mise à jour de la structure DT(AAAAMMJJ) DATECADUCITE La date de caducité DT(AAAAMMJJ) INDICATEURCADUCITE L indicateur de caducité LD (oui, non) DATEFERMETURE La date de fermeture DT(AAAAMMJJ) Classification : public 77 / 91

78 ATTRIBUT DEFINITION TYPE COMMENTAIRE TYPEFERMETURE Le type de fermeture X(3) DATEAUTORISATION La date d autorisation DT(AAAAMMJJ) NUMEROLICENCEEXPLOITA TION Le numéro de licence d exploitation X(10) NUMEROEDUCATIONNATIO NALE Le numéro de licence de l Education Nationale X(8) NSTATUTJURIDIQUE Le statut juridique NOMENCLATURE Référence annuaire.sante.fr : NSTATUTJURIDIQUE Code SystemName: R CODEAPE Le code APE X (15) NSECTEURACTIVITESANTE Le secteur d activité santé NOMENCLATURE Référence annuaire.sante.fr : NSECTEURACTIVITESANTE Code SystemName: R NCATEGORIEETABLISSEME NT La catégorie d établissement NOMENCLATURE Référence annuaire.sante.fr : NCATEGORIEETABLISSEM ENT Code SystemName: R NAGREGATCATEGORIE L agrégat de la catégorie d établissement NOMENCLATURE Référence annuaire.sante.fr : NAGREGATCATEGORIE Code SystemName: R NESPIC ESPIC (anciennement Service Public Hospitalier) NOMENCLATURE Référence annuaire.sante.fr : NSPH Code SystemName: R NMFT Mode de fixation tarifaire NOMENCLATURE Référence annuaire.sante.fr : NMFT Code SystemName: R74 Classification : public 78 / 91

79 ATTRIBUT DEFINITION TYPE COMMENTAIRE NSOUSCLASSENAFSTRUCTU RE Code APE ou La sousclasse NAF NOMENCLATURE Référence annuaire.sante.fr : NNAF Code SystemName: R COORDONNEES Les coordonnées STRUCTURE_COORD ONNEES IDSTRUCTUREPRED L identifiant de la structure précédente IDENTIFIANTPM Tableau 42: Description des attributs de Structure d une PM Liste des personnes physiques exerçant dans la structure Ci-dessous illustrée la structure «STRUCTURE_ MESSAGEPP_EG» : Figure 35: Structure d une personne physique exerçant dans une structure Le modèle de la structure «STRUCTURE MESSAGEPP_EG» utilisé dans la liste est détaillée ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_MESSAGEPP: CONTENEUR DE DONNEES DE BASE DES PP D UNE STRUCTURE IDENTIFIANTPP L identifiant de la personne physique NOMENCLATURE Structure contenant l identifiant de la PP + le type d identifiant : RPPS, ADELI, etc. NOMEXERCICE Le nom de l exercice X(80) PRENOMEXERCICE Le prénom d exercice X(50) NPROFESSION SAVOIRSFAIRES Le code de la profession Les périodes de savoir faire NOMENCLATURE Référence annuaire.sante.fr : NPROFESSION LISTE DE STRUCTURE_PERIO Code SystemName: G15 Code Système : Classification : public 79 / 91

80 ATTRIBUT DEFINITION TYPE COMMENTAIRE DE SAVOIRFAIRE Tableau 43: Description des attributs des Personnes physiques d une structure Liste des entités géographiques pour les structures de type EJ structure Ci-dessous illustrée la structure «STRUCTURE_ STRUCTURE EG» : Figure 36: Structure d une entité géographique liée à une entité juridique Le modèle de la structure «STRUCTURE_STRUCTURE_EG» utilisé dans la liste est détaillée ci-dessous : ATTRIBUT DEFINITION TYPE COMMENTAIRE STRUCTURE_STRUCTURE_EG: CONTENEUR DE DONNEES DE BASE D UNE STRUCTURE DE TYPE EG(PERSONNE MORALE) IDENTIFIANTPM Identifiant de la structure géographique IDENTIFIANTPM Structure contenant l identifiant de la PM + le type d identifiant : SIRET, FINESS, SIREN, etc. RAISONSOCIALE Libelle Raison Sociale X(164) ENSEIGNECOMMERCIALE Enseigne Commerciale X(50) NCATEGORIEETABLISSEME NT NSECTEURACTIVITESANTE COORDONNEES La catégorie d établissement Le secteur d activité santé Les coordonnées de l établissement NOMENCLATURE Référence annuaire.sante.fr : NCATEGORIEETABLISSEMENT Code SystemName: R NOMENCLATURE Référence annuaire.sante.fr : NSECTEURACTIVITESANTE STRUCTURE_COORDO NNEES Code SystemName: R Tableau 44: Description des attributs des établissements liés à une entité juridiques Classification : public 80 / 91