Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social
0.5.0-snapshot-1 - ci-build

Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social - Local Development build (v0.5.0-snapshot-1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## CapabilityStatement: ROR-Consommateur (Experimental)

Official URL: https://interop.esante.gouv.fr/ig/fhir/ror/CapabilityStatement/ror-consommateur | Version: 0.5.0-snapshot-1
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

Generated Narrative: CapabilityStatement ror-consommateur

## ROR-Consommateur

- Implementation Guide Version: 0.5.0-snapshot-1
- FHIR Version: 4.0.1
- Supported Formats: `application/fhir+json`, `application/fhir+ndjson`
- Supported Patch Formats: `application/fhir+json`
- Published on: 2024-03-12 11:35:00+0100
- Published by: ANS

> Note to Implementers: FHIR Capabilities

> Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

This CapabilityStatement instantiates the CapabilityStatement FHIR Bulk Data Access Implementation Guide

### SHALL Support the Following Implementation Guides

- https://interop.esante.gouv.fr/ig/fhir/ror/ImplementationGuide/ans.fhir.fr.ror
- http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata

## FHIR RESTful Capabilities

### Mode: `client`

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

Security
Enable CORS: no
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)

Summary of System-wide Interactions

### Capabilities by Resource/Profile

#### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | S | U | P | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Location | https://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-location | y | y |  | y |  | _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-assignement |  | `HealthcareService:location` |
HealthcareService | https://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-healthcareservice | y | y |  |  |  | _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-reopeningdate | `HealthcareService:organization, HealthcareService:location, Organization:partof, PractitionerRole:practitioner` | `PractitionerRole:service, Task:focus` |
Organization | https://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-organization | y | y |  |  |  | _id, _lastUpdated, _tag, _content, identifier, name, 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 |  |  |
Practitioner | https://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-practitioner | y | y |  |  |  | _id, _lastUpdated, _tag |  |  |
PractitionerRole | https://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-practitionerrole | y | y |  |  |  | _id, _lastUpdated, _tag |  |  |
Task | https://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-task | y | y |  | y | y | _id, _content |  |  |
Questionnaire | https://interop.esante.gouv.fr/ig/fhir/ror/StructureDefinition/ror-questionnaire | y | y |  |  |  | _id |  |  |

#### Resource Conformance: supported Location

Base System Profile
RORLocation
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `search-type`, `read`
  `patch`

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _filter | `special` | 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 | _has | `special` | Permet la sélection des ressources en fonction des propriétés des ressources qui y font référence (reverse chaining)
SHALL | _id | `token` | Identifiant logique de la ressource
SHALL | _lastUpdated | `date` | Permet la recherche sur la date de la dernière mise a jour de la ressource
SHALL | _tag | `token` | Permet la recherche sur le code de la région de la source de la donnée
SHALL | type | `token` | Permet la recherche sur sur la destination d'usage du lieu
SHALL | identifier | `token` | 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.
SHALL | near | `special` | Permet la recherche positionnelle (coordonnées géographique): lieux proches du lieu de réalisation de l'offre
SHALL | status | `token` | Permet la recherche sur le statut de la ressource
SHALL | operational-status | `token` | Permet la recherche sur le statut opérationnel du lieu, fermé temporairement ou fermé définitivement.
SHALL | address-postalcode | `string` | Permet la recherche sur le code Postal ou code postal spécifique CEDEX
SHALL | address-city | `string` | Permet la recherche sur la localité ou Libellé du bureau distributeur CEDEX
SHALL | capacity-status | `token` | Permet la recherche sur le statut de la capacité
SHALL | nb-capacity | `number` | Permet la recherche sur la quantité de lits ou places de la capacité exprimée
SHALL | additional-bed-type | `token` | Permet la recherche sur le type des lits disponibles
SHALL | capacity-closing-type | `token` | Permet la recherche sur le type de la fermeture de la capacité
SHALL | capacity-type | `token` | Permet la recherche sur la nature de la capacité
SHALL | capacity-update-date | `date` | Permet la recherche sur la date à laquelle la capacité d'accueil a été mise à jour dans la source.
SHALL | crisis-type | `token` | Permet la recherche sur le type de la crise qui permet de mobiliser le nombre de lits supplémentaires décrits.
SHALL | equipment-type | `token` | 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.
SHALL | equipment-feature | `token` | Permet la recherche sur l'élément qui indique la caractéristique de l'équipement pour laquelle une valeur limite est précisée.
SHALL | gender-capacity-available | `token` | Permet la recherche sur le genre disponible de la capacité
SHALL | limit-value | `quantity` | Permet la recherche sur la valeur limite : correspond à la valeur extrême associée à une caractéristique de l'équipement.
SHALL | commune-cog | `token` | Permet la recherche sur le code officiel géographique (cog) de la commune dans laquelle le lieu est situé
SHALL | near-insee-code | `special` | Permet la recherche positionnelle (code INSEE commune) : lieux proches du lieu de réalisation de l'offre via le code COG INSEE
SHALL | residential-number | `number` | Permet la recherche sur le nombre d'habitation du même type.
SHALL | residential-type | `token` | Permet la recherche sur le type d'habitation.
SHALL | temporality-capacity | `token` | 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.
SHALL | temporary-assignement | `token` | 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, ...).

#### Resource Conformance: supported HealthcareService

Base System Profile
RORHealthcareService
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `search-type`
  `read`

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Permet la recherche sur l'identifiant logique de la ressource
SHALL | _lastUpdated | `date` | Date de la dernière mise a jour
SHALL | _tag | `token` | Permet la recherche sur le code de la région de la source de la donnée
SHALL | _has | `special` | Permet la sélection des ressources en fonction des propriétés des ressources qui y font référence (reverse chaining)
SHALL | _filter | `special` | Fournit une syntaxe pour filtrer de manière plus complexe
SHALL | identifier | `token` | Permet la recherche sur l'identifiant métier de l’offre
SHALL | name | `string` | Permet la recherche sur la dénomination sous laquelle l'offre est identifiée
SHALL | service-category | `token` | Permet la recherche sur le type d'offre
SHALL | service-type | `token` | Permet la recherche sur le domaine dans lequel s'inscrit l'offre
SHALL | characteristic | `token` | Permet la recherche sur les caractéristiques de l'offre
SHALL | specialty | `token` | Ensemble cohérent d’actions et de pratiques mises en œuvre pour répondre aux besoins en Santé de la personne
SHALL | age-range-high | `quantity` | Permet la recherche sur l'age maximum de la patientèle
SHALL | age-range-low | `quantity` | Permet la recherche sur l'age minimum de la patientèle
SHALL | intervention-zone | `token` | Permet la recherche sur la zone d'intervention
SHALL | patient-type | `token` | Permet la recherche sur le type de public pris en charge
SHALL | psychiatric-sector | `string` | Permet la recherche sur le secteur psychiatrique de l'offre opérationnelle
SHALL | notavailable-closing-reopeningdate | `date` | Permet la recherche de date dans la période de fermeture (during.start) et de réouverture prévisionnelle (during.end)

#### Resource Conformance: supported Organization

Base System Profile
ROROrganization
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `search-type`, `read`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Permet la recherche sur l'identifiant logique de la ressource
SHALL | _lastUpdated | `date` | Permet la recherche sur la date de la dernière mise a jour
SHALL | _tag | `token` | Permet la recherche sur le code de la région de la source de la donnée
SHALL | _content | `string` | Recherche dans le contenu textuel de la ressource
SHALL | identifier | `token` | Permet la recherche sur l'identification nationale de l'Entité Géographique définie dans le CI-SIS
SHALL | name | `string` | Permet la recherche sur le nom de l'organisation interne
SHALL | closing-type | `token` | Permet la recherche sur le type de fermeture de l'entité géographique, au sens des règles de gestion du SI FINESS
SHALL | drop-zone | `token` | Indique s'il y a une zone poser sur le site concerné
SHALL | period-end | `date` | Permet la recherche sur la date de fermeture de l'entité géographique
SHALL | price-amount-value | `number` | Permet la recherche sur la valeur du tarif des prestations et services
SHALL | price-dependency-level | `token` | Permet la recherche sur le niveau de dépendance de la personne âgée accueillie
SHALL | price-residential-type | `token` | Permet la recherche sur les caractéristiques tarifaires de l'hébergement
SHALL | price-type | `token` | Permet la recherche sur le type de tarif
SHALL | price-unit | `token` | Permet la recherche sur l'unité de référence pour évaluer le prix des prestations et services
SHALL | price-validity-start-date | `date` | Permet la recherche sur la dernière date de début de validité du tarif indiqué
SHALL | price-welcome-type | `token` | Permet la recherche sur le tarif applicable à un hébergement permanent ou à un hébergement temporaire
SHALL | special-price | `token` | Permet la recherche sur la condition tarifaire

#### Resource Conformance: supported Practitioner

Base System Profile
RORPractitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `search-type`, `read`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Identifiant logique de la ressource
SHALL | _lastUpdated | `date` | Date de la dernière mise a jour
SHALL | _tag | `token` | Code de la région de la source de la donnée

#### Resource Conformance: supported PractitionerRole

Base System Profile
RORPractitionerRole
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `search-type`, `read`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Identifiant logique de la ressource
SHALL | _lastUpdated | `date` | Date de la dernière mise a jour
SHALL | _tag | `token` | Code de la région de la source de la donnée

#### Resource Conformance: supported Task

Base System Profile
RORTask
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `search-type`, `read`, `create`
  `patch`

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Identifiant logique de la ressource
SHALL | _content | `string` | Recherche dans le contenu textuel de la ressource

#### Resource Conformance: supported Questionnaire

Base System Profile
RORQuestionnaire
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `search-type`, `read`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Identifiant logique de la ressource

### Operations

#### Use