Search FHIR

Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social
0.7.0 - trial-implementation France (la)

Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social - version de développement local (intégration continue v0.7.0) construite par les outils de publication FHIR (HL7® FHIR® Standard). Voir le répertoire des versions publiées

CapabilityStatement: ROR-Consommateur (Experimental)

Official URL: https://interop.esante.gouv.fr/ig/fhir/ror/CapabilityStatement/ror-consommateur Version: 0.7.0
Draft as of 2024-03-12 Computable Name: RORConsommateur

Capability Statement pour les systèmes qui sont autorisés à consommer les données du ROR. Le Répertoire Opérationnel des Ressources (ROR) est le gisement de données qui décrit les offres de santé au niveau national.

Raw OpenAPI-Swagger Definition file | Download

ROR-Consommateur

  • Version du guide d'implémentation : 0.7.0
  • Version de FHIR : 4.0.1
  • Formats supportés : application/fhir+json, application/fhir+ndjson
  • Formats Patch supportés : application/fhir+json
  • Publié sur : 2024-03-12 11:35:00+0100
  • Publié par : ANS

Note aux implémenteurs : capacités FHIR

Toute capacité FHIR peut être 'autorisée' par le système sauf si elle est explicitement marquée comme 'SHALL NOT'. Quelques éléments sont marqués comme MAY dans le guide d'implémentation pour souligner leur pertinence potentielle pour le cas d'usage.

This CapabilityStatement instantiates the CapabilityStatement FHIR Bulk Data Access Implementation Guide

DOIT prendre en charge les guides d’implémentation suivants.

Capacités RESTful FHIR

Mode: client

Recherche d'offres de soins de santé et de leurs capacités

Security
Activer CORS : non
Security services supported: OAuth

L’ANS propose des référentiels dédiés à la politique de sécurité (la PGSSI-S ) et des mécanismes de sécurisation sont définis dans les volets de la couche Transport du Cadre d’Interopérabilité des systèmes d’information de santé (CI-SIS)

Résumé des opérations au niveau du système
ConformitéOpérationDocumentation
SHOULD$export

Utilisation de https://hl7.org/fhir/uv/bulkdata/export.html avec ajout de la valeur _myCompleteExtract pour utiliser le query parameter includeAssociatedData.

Capacités par ressource/profil

Résumé

Le tableau récapitulatif liste les ressources faisant partie de cette configuration, et pour chaque ressource, il liste :

  • Les profils pertinents (le cas échéant)
  • Les interactions supportées par chaque ressource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Tles types sont seulement présents si au moins une des ressources les prend en charge.
  • Les paramètres de recherche (SearchParameters) requis, recommandés, optionnels (le cas échéant).
  • Les ressources liées activées pour _include
  • Les autres ressources activées pour _revinclude
  • Les opérations sur la ressource (le cas échéant)
Type de RessourceProfilRSUPCRecherches_include_revincludeOpérations
Locationhttps://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-locationyyy_filter, _has, _id, _lastUpdated, _tag, type, identifier, near, status, operational-status, address-postalcode, address-city, capacity-status, nb-capacity, additional-bed-type, capacity-closing-type, capacity-type, capacity-update-date, crisis-type, equipment-type, equipment-feature, gender-capacity-available, limit-value, commune-cog, near-insee-code, residential-number, residential-type, temporality-capacity, temporary-assignementHealthcareService:location
HealthcareServicehttps://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-healthcareserviceyy_id, _lastUpdated, _tag, _has, _filter, identifier, name, service-category, service-type, characteristic, specialty, age-range-high, age-range-low, intervention-zone, patient-type, psychiatric-sector, notavailable-closing-reopeningdateHealthcareService:organization, HealthcareService:location, Organization:partof, PractitionerRole:practitionerPractitionerRole:service, Task:focus
Organizationhttps://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-organizationyy_id, _lastUpdated, _tag, _content, identifier, name, type, closing-type, drop-zone, period-end, price-amount-value, price-dependency-level, price-residential-type, price-type, price-unit, price-validity-start-date, price-welcome-type, special-price
Practitionerhttps://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-practitioneryyidentifier, _id, _lastUpdated, _tag
PractitionerRolehttps://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-practitionerroleyyidentifier, _id, _lastUpdated, _tag
Taskhttps://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-taskyyyy_id, _content, _id

Profil système de base
RORLocation
Conformité au Profil
SHALL
Politique de référence

Résumé des interactions
  • Supporte search-type, read
    patch

    Seuls les attributs de 'premier niveau' peuvent être mis à jour avec l'interaction patch.

Paramètres de recherche
ConformitéParamètreTypeDocumentation
SHALL_filterspecial

Paramètre de recherche de filtre qui prend en charge une grammaire de recherche plus sophistiquée. Voir la documentation pour plus de détails

SHALL_hasspecial

Permet la sélection des ressources en fonction des propriétés des ressources qui y font référence (reverse chaining)

SHALL_idtoken

Identifiant logique de la ressource

SHALL_lastUpdateddate

Permet la recherche sur la date de la dernière mise a jour de la ressource

SHALL_tagtoken

Permet la recherche sur le code de la région de la source de la donnée

SHALLtypetoken

Permet la recherche sur sur la destination d'usage du lieu

SHALLidentifiertoken

Permet la recherche sur l'identifiant logique du lieu de réalisation de l'offre. Il correspond à l'identifiant externe de synchronisation est l'identifiant défini par le porteur d'offre pour la zone d'hébergement des lits.

SHALLnearspecial

Permet la recherche positionnelle (coordonnées géographique): lieux proches du lieu de réalisation de l'offre

SHALLstatustoken

Permet la recherche sur le statut de la ressource

SHALLoperational-statustoken

Permet la recherche sur le statut opérationnel du lieu, fermé temporairement ou fermé définitivement.

SHALLaddress-postalcodestring

Permet la recherche sur le code Postal ou code postal spécifique CEDEX

SHALLaddress-citystring

Permet la recherche sur la localité ou Libellé du bureau distributeur CEDEX

SHALLcapacity-statustoken

Permet la recherche sur le statut de la capacité

SHALLnb-capacitynumber

Permet la recherche sur la quantité de lits ou places de la capacité exprimée

SHALLadditional-bed-typetoken

Permet la recherche sur le type des lits disponibles

SHALLcapacity-closing-typetoken

Permet la recherche sur le type de la fermeture de la capacité

SHALLcapacity-typetoken

Permet la recherche sur la nature de la capacité

SHALLcapacity-update-datedate

Permet la recherche sur la date à laquelle la capacité d'accueil a été mise à jour dans la source.

SHALLcrisis-typetoken

Permet la recherche sur le type de la crise qui permet de mobiliser le nombre de lits supplémentaires décrits.

SHALLequipment-typetoken

Permet la recherche sur le type d'un equipement. Les équipements spécifiques décrits sont des ressources propres de la structure ou mises à disposition dans le cadre d'une convention à la condition qu'elles soient utilisées sur site.

SHALLequipment-featuretoken

Permet la recherche sur l'élément qui indique la caractéristique de l'équipement pour laquelle une valeur limite est précisée.

SHALLgender-capacity-availabletoken

Permet la recherche sur le genre disponible de la capacité

SHALLlimit-valuequantity

Permet la recherche sur la valeur limite : correspond à la valeur extrême associée à une caractéristique de l'équipement.

SHALLcommune-cogtoken

Permet la recherche sur le code officiel géographique (cog) de la commune dans laquelle le lieu est situé

SHALLnear-insee-codespecial

Permet la recherche positionnelle (code INSEE commune) : lieux proches du lieu de réalisation de l'offre via le code COG INSEE

SHALLresidential-numbernumber

Permet la recherche sur le nombre d'habitation du même type.

SHALLresidential-typetoken

Permet la recherche sur le type d'habitation.

SHALLtemporality-capacitytoken

Permet la recherche sur la capacité des affectations temporaires. Indique le moment où cette capacité sera effective. Il est ainsi possible de décrire la situation immédiate, ou de fournir des informations prospectives de capacités, prenant notamment en compte les entrées et sorties déjà identifiés de patients.

SHALLtemporary-assignementtoken

Permet la recherche sur les affectations temporaires. L'affectation temporaire permet de réserver tout ou partie des lits d'une zone d'hébergement pour des patients selon qu'ils soient -ou non- concernés par une pathologie (Covid+, Covid-, ...) ou un évènement (catastrophe naturelle, attentat, ...).

 
Profil système de base
RORHealthcareService
Conformité au Profil
SHALL
Politique de référence

Résumé des interactions
  • Supporte search-type
    read

    Seuls les attributs de 'premier niveau' peuvent être mis à jour avec l'interaction patch.

Paramètres de recherche
ConformitéParamètreTypeDocumentation
SHALL_idtoken

Permet la recherche sur l'identifiant logique de la ressource

SHALL_lastUpdateddate

Date de la dernière mise a jour

SHALL_tagtoken

Permet la recherche sur le code de la région de la source de la donnée

SHALL_hasspecial

Permet la sélection des ressources en fonction des propriétés des ressources qui y font référence (reverse chaining)

SHALL_filterspecial

Fournit une syntaxe pour filtrer de manière plus complexe

SHALLidentifiertoken

Permet la recherche sur l'identifiant métier de l’offre

SHALLnamestring

Permet la recherche sur la dénomination sous laquelle l'offre est identifiée

SHALLservice-categorytoken

Permet la recherche sur le type d'offre

SHALLservice-typetoken

Permet la recherche sur le domaine dans lequel s'inscrit l'offre

SHALLcharacteristictoken

Permet la recherche sur les caractéristiques de l'offre

SHALLspecialtytoken

Ensemble cohérent d’actions et de pratiques mises en œuvre pour répondre aux besoins en Santé de la personne

SHALLage-range-highquantity

Permet la recherche sur l'age maximum de la patientèle

SHALLage-range-lowquantity

Permet la recherche sur l'age minimum de la patientèle

SHALLintervention-zonetoken

Permet la recherche sur la zone d'intervention

SHALLpatient-typetoken

Permet la recherche sur le type de public pris en charge

SHALLpsychiatric-sectorstring

Permet la recherche sur le secteur psychiatrique de l'offre opérationnelle

SHALLnotavailable-closing-reopeningdatedate

Permet la recherche de date dans la période de fermeture (during.start) et de réouverture prévisionnelle (during.end)

 
Profil système de base
ROROrganization
Conformité au Profil
SHALL
Politique de référence

Résumé des interactions
  • Supporte search-type, read.

Paramètres de recherche
ConformitéParamètreTypeDocumentation
SHALL_idtoken

Permet la recherche sur l'identifiant logique de la ressource

SHALL_lastUpdateddate

Permet la recherche sur la date de la dernière mise a jour

SHALL_tagtoken

Permet la recherche sur le code de la région de la source de la donnée

SHALL_contentstring

Recherche dans le contenu textuel de la ressource

SHALLidentifiertoken

Permet la recherche sur l'identification nationale de l'Entité Géographique définie dans le CI-SIS

SHALLnamestring

Permet la recherche sur le nom de l'organisation interne

SHALLtypetoken

Permet la recherche sur le cadre réglementaire dans lequel s'exerce l'activité de l'entité géographique

SHALLclosing-typetoken

Permet la recherche sur le type de fermeture de l'entité géographique, au sens des règles de gestion du SI FINESS

SHALLdrop-zonetoken

Indique s'il y a une zone poser sur le site concerné

SHALLperiod-enddate

Permet la recherche sur la date de fermeture de l'entité géographique

SHALLprice-amount-valuenumber

Permet la recherche sur la valeur du tarif des prestations et services

SHALLprice-dependency-leveltoken

Permet la recherche sur le niveau de dépendance de la personne âgée accueillie

SHALLprice-residential-typetoken

Permet la recherche sur les caractéristiques tarifaires de l'hébergement

SHALLprice-typetoken

Permet la recherche sur le type de tarif

SHALLprice-unittoken

Permet la recherche sur l'unité de référence pour évaluer le prix des prestations et services

SHALLprice-validity-start-datedate

Permet la recherche sur la dernière date de début de validité du tarif indiqué

SHALLprice-welcome-typetoken

Permet la recherche sur le tarif applicable à un hébergement permanent ou à un hébergement temporaire

SHALLspecial-pricetoken

Permet la recherche sur la condition tarifaire

 
Profil système de base
RORPractitioner
Conformité au Profil
SHALL
Politique de référence

Résumé des interactions
  • Supporte search-type, read.

Paramètres de recherche
ConformitéParamètreTypeDocumentation
SHALLidentifiertoken

Permet la recherche sur idNat_PS (Professionnel) : Identification nationale du professionnel définie par le CI-SIS

SHALL_idtoken

Identifiant logique de la ressource

SHALL_lastUpdateddate

Date de la dernière mise a jour

SHALL_tagtoken

Code de la région de la source de la donnée

 
Profil système de base
RORPractitionerRole
Conformité au Profil
SHALL
Politique de référence

Résumé des interactions
  • Supporte search-type, read.

Paramètres de recherche
ConformitéParamètreTypeDocumentation
SHALLidentifiertoken

Permet la recherche sur l'identifiant de la situation opérationnelle, unique et persistant au niveau national

SHALL_idtoken

Identifiant logique de la ressource

SHALL_lastUpdateddate

Date de la dernière mise a jour

SHALL_tagtoken

Code de la région de la source de la donnée

 
Profil système de base
RORTask
Conformité au Profil
SHALL
Politique de référence

Résumé des interactions
  • Supporte search-type, read, create
    patch

    Seuls les attributs de 'premier niveau' peuvent être mis à jour avec l'interaction patch.

Paramètres de recherche
ConformitéParamètreTypeDocumentation
SHALL_idtoken

Identifiant logique de la ressource

SHALL_contentstring

Recherche dans le contenu textuel de la ressource

SHALL_idtoken

Identifiant logique de la ressource