This page is part of the Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social (v0.3.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Specifications Fonctionnelles
A ce jour, le guide d’implémentation de l’API FHIR du ROR a pour vocation à répondre aux cas d’usage suivants :
- Consultation des données capacitaires en lits et places
- Consultation de l’offre (extraction)
- Recherche d’offre sur critères principaux
- Recherche d’offre avec données capacitaires
- Recherche d’offre sur la base d’informations tarifaires
- Recherche d’offre via une technique « Full text »
- Création et Mise à jour du lieu de réalisation de l’offre
- Signalement d’anomalie
- Mise à jour d’anomalie
- Consultation d’anomalie
- Consultation d’indicateurs de pilotage
La maturité d’implémentation (cf guide de lecture du guide) pour répondre à ces cas d’usage est indiqué dans les spécifications techniques.
Définition d’une Anomalie dans le ROR:
Une anomalie est une irrégularité sur une description d’offre de santé. (exemple adresse, numéro de téléphone, numéro FINESS, RPPS, spécialité etc…).
Il existe différents types d’anomalies dans le contexte ROR national:
- Le non-respect d’une exigence qualité : toute offre ne respectant pas une exigence qualité sera être indiquée en écart par rapport à cette règle.
Exemple d’exigence : Les établissements sont peuplés selon les critères de peuplement définis par l'ANS → cet écart sera remonté au responsable d'établissement
- L’utilisation d’une nomenclature obsolète.
- Une anomalie déclarée sur une offre : un utilisateur peut en effet identifier qu’une information n’est pas correcte sur la description d’une offre.
Toute suspicion d’anomalie peut être jugée infondée par le responsable de l’offre ou un responsable qualité régional ou de l’établissement concerné.
Pour les cas d’usage couverts par ce guide d’implémentation :
- Les préconditions sont :
- Le système consommateur dispose des points d’accès et des moyens d’authentification (authentification mTLS avec des certificats IGC-Santé) pour accéder aux données du ROR National.
- Le système consommateur peut uniquement effectuer les recherches autorisées par son profil d’accès aux données. Plus d’information ici .
- Les postconditions sont :
- L’exécution des transactions ne provoquera aucune modification sur les données sources extraites.
Consultation des données capacitaires
Description du cas d’usage
Un consommateur cherche les capacités des lieux de réalisation de l’offre à partir de critères de recherche.
Le consommateur renseigne son (ses) critère(s) de recherche parmi les critères disponibles.
Le ROR National répond au consommateur les lieux de réalisation de l’offre correspondant aux critères de recherche et les identifiants des offres opérationnelles liées.
|
|
|
Recherche capacité (modèle expo V3.0)
|
Scénarios
- Scénario 1 : Données capacitaires sur le périmètre national
- Un consommateur souhaite mettre à jour toutes les données capacitaires sur le périmètre national.
- Scénario 1 bis : Données capacitaires sur une région
- Un consommateur souhaite mettre à jour toutes les données capacitaires sur une région.
- Scénario 1 ter : Données capacitaires sur une région source
- Un consommateur souhaite récupérer l'ensemble des données capacitaires sur une région source afin de mettre à jour son système.
- Scénario 2 : Données capacitaires sur un lieu de prise en charge identifié
- Un consommateur souhaite mettre à jour dans son système les données de capacité sur un lieu de prise en charge identifié.
- Scénario 3 : Données capacitaires sur plusieurs lieux de prise en charge identifiés
- Un consommateur souhaite mettre à jour dans son système les données de capacité en lits/places de certains lieux de prise en charge (il connait les identifiants et demande à lire la liste de ces données capacitaires).
- Scénario 4 : Données capacitaires à partir d’une date de mise à jour
- Un consommateur souhaite mettre à jour dans son système les données capacitaires mises à jour dans le ROR national depuis une date qu’il précise.
- Scénario 5 : Données capacitaires d’une offre opérationnelle
- Un consommateur, ayant recherché au préalable une offre de santé correspondant à ses critères, souhaite connaitre la situation des capacités pour ces offres. Le service de recherche lui ayant renvoyé les identifiants de ces offres, il les passe en paramètre de la recherche.
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Description du cas d’usage
Un consommateur souhaite :
-
Faire une extraction complète asynchrone sans critère
-
Faire une extraction complète sur une région
-
Consulter une offre à partir de son identifiant
-
Consulter une offre à partir de l'identifiant de son établissement
-
Faire une extraction complète des offres (modèle complet) modifiées depuis une date
Il y a deux cas possibles :
-
Extraction totale : Le consommateur renseigne si besoin son (ses) critère(s) de recherche parmi les critères disponibles. Le ROR National répond au consommateur les offres opérationnelles correspondant aux critères de recherche et toutes les classes liées à l’offre opérationnelle.
-
Extraction partielle : Le consommateur renseigne si besoin son (ses) critère(s) de recherche parmi les critères disponibles et sélectionne les attributs de l’offre opérationnelle qu’il souhaite recevoir. Le ROR National répond au consommateur les attributs demandés des offres opérationnelles correspondant aux critères de recherche et les organisations liées à ces offres opérationnelles.
|
|
|
|
Extraction complète de l'offre
|
Extraction partielle de l'offre
|
Scénarios
- Scénario 1 : Extraction complète synchrone
- Un consommateur souhaite mettre à jour toutes les offres de santé sur le périmètre national.
- Scénario 1 bis : Extraction complète asynchrone
- Un consommateur souhaite mettre à jour toutes les offres de santé sur le périmètre national de manière asynchrone (pour une question de performance et de volumétrie).
- Scénario 1 ter : Extraction complète asynchrone par région
- Un consommateur souhaite mettre à jour toutes les offres de santé sur un périmètre régional de manière asynchrone (pour une question de performance et de volumétrie). Il réalise donc une extraction complète de l’offre régionale.
- Scénario 2 : Extraction de l’ensemble des offres de santé d’un établissement
- Un consommateur souhaite rechercher l'offre de santé proposée par un établissement.
- Scénario 3 : Extraction d’une offre de santé identifiée
- Un consommateur souhaite rechercher une offre de santé à partir de son identifiant.
- Scénario 4 : Extraction à partir d’une date de mise à jour de l’offre opérationnelle
- Un consommateur souhaite mettre à jour toute l'offre mise à jour depuis une certaine date précisée par le consommateur.
- Scénario 5 : Extraction à partir d’une date de mise à jour de l’entité géographique
- Un consommateur souhaite mettre à jour toute l'offre dont l’entité géographique est mise à jour depuis une certaine date.
- Scénario 6 : Extraction à partir d’une date de mise à jour d’un des éléments de l’offre
- Un consommateur souhaite par exemple mettre à jour dans son système toute l’offre mise à jour depuis une certaine date ou dont l’organisation est mise à jour depuis une certaine date.
- Scénario 7 : Extraction de l’offre sur un périmètre limité
- Un consommateur souhaite mettre à jour toute l'offre de santé d'une région. Comme il n'utilise qu’un sous-ensemble des informations de l'offre, il souhaite ne recevoir que ces informations.
- Scénario 8 : Extraction d’une offre de santé identifiée avec anomalie
- Un consommateur souhaite rechercher une offre de santé à partir de son identifiant et consulter les anomalies associées si elle sont existantes.
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Recherche d’offre sur critères principaux
Description du cas d’usage
Un consommateur cherche des offres opérationnelles à partir de critère(s) de recherche.
Le consommateur renseigne son (ses) critère(s) de recherche parmi les critères disponibles.
Le ROR National répond au consommateur les offres opérationnelles correspondant aux critères de recherche et toutes les classes liées à l’offre opérationnelle.
Scénarios
- Scenario 1 : Recherche sur un critère en saisissant une valeur
- Un consommateur cherche les offres ayant une activité opérationnelle qui correspond à l’unique valeur recherchée par le consommateur.
- Scenario 2 : Recherche sur un critère en saisissant une liste de valeurs
- Un consommateur cherche les offres ayant une activité opérationnelle qui correspond à l’une des valeurs recherchées par le consommateur.
- Scenario 3 : Recherche multicritères #1 – ET
- Un consommateur cherche les offres ayant un type d’offre ET une modalité d’accueil qu’il indique.
- Scenario 4 : Recherche multicritères #2 – OU
- Un consommateur cherche les offres ayant un type d’offre OU une activité opérationnelle qu’il indique pour un patient d’âge donné.
- Scenario 5 : Recherche multicritères #3 – ET/OU
- Un consommateur recherche les offres ayant (une catégorie d’établissement OU un type d’offre) ET un acte spécifique qu’il indique.
- Scenario 6 : Recherche à proximité géographique
- Un consommateur cherche les offres ayant une activité opérationnelle particulière, dans un périmètre géographique proche du lieu de résidence d’un patient.
- Scenario 7 : Recherche sur une zone d’intervention
- Un consommateur cherche les offres ayant un type d’offre particulier et une activité opérationnelle particulière, dans une commune faisant partie d’une zone d’intervention.
- Scenario 8 : Recherche sur un département
- Un consommateur recherche les offres ayant une catégorie d’organisation, un mode de prise en charge et une spécialisation de prise en charge, sur un département, ou un ensemble de département (code postal).
- Scenario 9 : Recherche sur une ville #1 – Code Postal
- Un consommateur recherche les offres proposant une activité opérationnelle particulière et un acte spécifique particulier sur une ville, ou un ensemble de villes (code postal).
- Scenario 10 : Recherche sur une ville #2 – Code commune
- Un consommateur recherche les offres proposant une activité opérationnelle particulière et un mode de prise en charge particulier, sur une ville, ou un ensemble de villes (code commune).
- Scenario 11 : Recherche sur un critère du modèle d’exposition 3.0
- Un consommateur recherche les offres proposant une compétence spécifique.
- Scenario 12 : Recherche d’offre en anomalie
- Un responsable qualité recherche les offres en anomalie de sa région.
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Recherche d’offre avec données capacitaires
Description du cas d’usage
Un consommateur cherche les capacités des lieux de réalisation de l’offre à partir de critère(s) de recherche.
Le consommateur renseigne son (ses) critère(s) de recherche parmi les critères disponibles.
Le ROR National répond au consommateur les offres opérationnelles correspondant aux critères de recherche et les lieux de réalisation de l’offre liés.
|
|
|
Recherche offre avec données capacitaires
|
Scénarios
- Scenario 1 : Recherche sur un critère capacitaire #1
- Un consommateur cherche les offres pour une activité opérationnelle donnée, et un capacitaire respectant certaines caractéristiques.
- Scenario 2 : Recherche sur un critère capacitaire #2
- Un consommateur cherche les offres pour une activité opérationnelle donnée, et un capacitaire respectant certaines caractéristiques.
- Scenario 3 : Recherche sur un critère de l’équipement
- Un consommateur cherche une offre pour une activité opérationnelle donnée, et disposant d’équipement respectant certaines caractéristiques.
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Description du cas d’usage
|
|
|
Recherche d'offre sur la base d'informations tarifaires (modèle expo V3.0)
|
Le consommateur renseigne si besoin son (ses) critère(s) de recherche parmi les critères disponibles.
Le ROR National répond au consommateur les offres opérationnelles correspondant aux critères de recherche et les lieux de réalisation de l’offre liés.
Scénarios
- Scénario 1 : Recherche sur critères tarifaires #1
- Un consommateur recherche les offres d’établissements dont
le type de tarifs = 02 | forfait socle hébergement, le montant est inférieur à X euros, pour la date de début de validité la plus récente.
- Scénario 2 : Recherche sur critères tarifaires #2
- Un consommateur recherche les offres d’établissements dont le type de tarif = 02 | forfait socle hébergement, le montant est inférieur ou égal à X euros, le type habitation = 03 | F1, les conditions tarifaires = 03 | tarif agréé ASH.
- Scénario 3 : Recherche sur critères tarifaires #3
- Un consommateur recherche les offres d’établissements dont le type de tarifs = 03 | dépendance, le montant est inférieur à X euros, le niveau de dépendance = 02 | GIR 3-4, la temporalité d'accueil (au niveau du tarif, pas de l'offre opérationnelle) = 02 | permanent.
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Recherche d’offre via une technique « Full text »
Description du cas d’usage
Un consommateur recherche une chaine de caractères libre dans le contenu textuel des offres opérationnelles ou des classes liées.
|
|
|
Recherche « Full text » (modèle expo V3.0)
|
Le consommateur renseigne la chaine de caractères qu’il recherche.
Le ROR National répond au consommateur les offres opérationnelles correspondant à la recherche et toutes les classes liées à l’offre opérationnelle.
Scénarios
- Scénario 1 : Recherche des offres opérationnelles référençant le texte "cardio"
- Un consommateur recherche les offres opérationnelles contenant une chaine de caractères libre (« cardio » par exemple).
- Scénario 2 : Recherche des offres opérationnelles ou des lieux de réalisation de l’offre référençant le texte "cardio"
- Un consommateur recherche les offres opérationnelles ou les lieux de réalisation de l’offre liés contenant une chaine de caractères libre (« cardio » par exemple).
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Création et Mise à jour du lieu de réalisation de l’offre
Description du cas d’usage : création du lieu de réalisation de l’offre
Un établissement souhaite créer un lieu de réalisation de l’offre (dont les données capacitaires).
|
|
|
Création du lieu de réalisation de l'offre (modèle expo
V3.0)
|
L’établissement renseigne les informations nécessaires à l’initialisation du lieu de réalisation de l’offre.
Le ROR National répond à l’établissement toutes les informations saisie, l’identifiant technique et les métadonnées.
Remarque : Après la création du lieu de réalisation de l’offre, il est nécessaire de mettre à jour l’offre pour la rattacher à ce nouveau lieu.
Description du cas d’usage : mise à jour du lieu de réalisation de l’offre
|
|
|
Mise à jour du lieu de réalisation de l'offre (modèle expo V3.0)
|
L’établissement renseigne l’identifiant technique du lieu de réalisation de l’offre à mettre à jour et les informations à modifier (voir description du lieu de réalisation de l’offre).
Le ROR National répond à l’établissement, au moins, l’identifiant technique, les métadonnées et l’identifiant fonctionnel du lieu de réalisation de l’offre mis à jour.
Scénarios
- Scénario 1 : Ajout d’un lieu de réalisation de l’offre
- Un établissement ajoute dans un établissement (EG) existant, un lieu de réalisation de l'offre de fonction "001 | hébergement", associé à une offre opérationnelle existante, dans la communeCog de Versailles, avec une adresse 7 rue porte de Buc, 78000 Versailles.
- Scénario 2 : Ajout d’une capacité de prise en charge
- Un établissement (via bed management, ...) ajoute dans un lieu de réalisation de l'offre existant, des données capacitaires pour : une affectation temporaire "Covid +", 2 lits disponibles (sexe indifférencié), à t0.
- Scénario 3 : Suppression d’une capacité d’accueil opérationnelle
- Un établissement (via bed management, …) supprime dans un lieu de réalisation de l'offre existant tous les enregistrements liés à l'affectation temporaire "Covid-".
- Scénario 4 : Mise à jour de l’adresse du lieu de réalisation de l’offre
- Un établissement modifie le numéro de voie de l’adresse du lieu de réalisation de l’offre.
- Scénario 5 : Ajout d’un équipement spécifique dans un lieu de réalisation de l’offre
- Un établissement ajout un équipement spécifique dans un lieu de réalisation de l’offre : 089 | lit d'hospitalisation obésité (poids entre 250 et 350 kg) - bariatrique, nb en service : 2, limite caractéristique équipement : 001 | poids maximum, valeur limite = 300 kg.
- Scénario 6 : Modification de la quantité d’équipements spécifiques dans un lieu de réalisation de l’offre
- Un établissement modifie la quantité d’équipements spécifiques dans un lieu de réalisation de l’offre : 089 | lit d'hospitalisation obésité (poids entre 250 et 350 kg) - bariatrique, nb en service : 3, limite caractéristique équipement : 001 | poids maximum, valeur limite = 300 kg.
- Scénario 7 : Suppression d’un équipement spécifique dans un lieu de réalisation de l’offre
- Un établissement indique qu’il ne dispose plus de l’échographe 3D, il modifie la quantité d’équipement en service : 030 | Echographe 3D, nb en service : 0, aucune limite équipement associée.
- Scénario 8 : Modification de la valeur limite d’un équipement spécifique dans un lieu de réalisation de l’offre
- Un établissement modifie la valeur limite d’un équipement spécifique dans un lieu de réalisation de l’offre : 089 | lit d'hospitalisation obésité (poids entre 250 et 350 kg) - bariatrique, nb en service : 2, limite caractéristique équipement : 001 | poids maximum, valeur limite = 280 kg.
- [solutions BedManagement] Scénario 9 : Remplacement de toutes les données capacitaires
- Un établissement remplace toutes les données capacitaires (les anciennes données sont écrasées par les nouvelles).
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Signalement d’anomalie
Description du cas d’usage
Un consommateur souhaite signaler une ou plusieurs anomalies qualité sur un élément du modèle d’exposition du ROR.
Le consommateur renseigne les informations de l’anomalie à signaler, en précisant à minima les éléments obligatoires. (voir description de la ressource).
Le ROR National répond au consommateur l’identifiant technique, les métadonnées et l’identifiant fonctionnel de l’anomalie créée.
Scénarios
- Scenario 1 : Signalement d’une anomalie
- Un responsable qualité souhaite signaler une anomalie sur un élément.
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Mise à jour d’anomalie
Description du cas d’usage
Un service numérique souhaite mettre à jour une ou plusieurs anomalies qualité.
Le service numérique renseigne l’identifiant technique de l’anomalie à mettre à jour et les informations à modifier (voir description de la ressource).
Le ROR National retourne au service numérique l’identifiant technique, les métadonnées et l’identifiant fonctionnel a minima de l’anomalie créée.
Scénarios
- Scenario 1 : Mise à jour du statut d’une anomalie
- Le responsable de la donnée en anomalie corrige l’anomalie, le responsable qualité ou un système numérique met à jour le statut de l’anomalie.
- Scenario 2 : Inactivation d’une anomalie
- Un responsable qualité ou un système numérique décide d’inactiver une anomalie (elle a été saisie par erreur par exemple).
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Consultation d’anomalie
Description du cas d’usage
Un consommateur souhaite consulter une ou plusieurs anomalies qualité.
Le consommateur renseigne si besoin son (ses) critère(s) de recherche parmi les critères disponibles.
Le ROR National répond au consommateur la ou les anomalies correspondantes aux critères de recherche.
Scénarios
- Scenario 1 : Consultation du statut d’une anomalie
- Un responsable qualité ou un système numérique consommateur souhaite consulter le statut d’une anomalie.
- Scenario 2 : Consultation de la liste des anomalies
- Un responsable qualité ou le moteur de règle souhaite consulter la liste des anomalies d’un élément.
- Scénario 3 : Consultation de la liste des anomalies sur un périmètre
- Un responsable qualité souhaite consulter la liste des anomalies sur son périmètre (région, établissement, département).
- Scénario 4 : Consommation de toutes les anomalies
- Le BI consomme toutes les anomalies pour faire des tableaux de suivi.
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
Consultation d’indicateurs de pilotage
Description du cas d’usage
Un consommateur souhaite consulter des indicateurs de pilotage.
|
|
|
Consultation d'indicateurs de pilotage (modèle expo V3.0)
|
Le consommateur renseigne si besoin son (ses) critère(s) de recherche parmi les critères disponibles.
Le ROR National répond au consommateur les indicateurs correspondants aux critères de recherche.
Scénarios
- Scénario 1 : Intégration d’un indicateur dans un système externe
- Un consommateur souhaite intégrer un indicateur de pilotage du ROR national dans un système externe.
- Scénario 2 : Intégration d’indicateurs dans un système externe
- Un consommateur souhaite intégrer des indicateurs de pilotage du ROR national dans un système externe à partir d’une date de mesure.
Les spécifications techniques pour répondre à ce cas d’usage sont accessibles ici
