Annuaire Santé
1.1.0 - final-text
Annuaire Santé
1.1.0 - final-text
Annuaire Santé - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/CapabilityStatement/AsServerDPCapabilityStatement | Version: 1.1.0 | |||
| Active as of 2025-08-11 | Computable Name: | |||
CapabilityStatement décrivant les attendus de l’API de l’annuaire santé.
Raw OpenAPI-Swagger Definition file | Download
jsonNote 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 dimplémentation pour souligner leur pertinence potentielle pour le cas dusage.
serverLe tableau récapitulatif liste les ressources faisant partie de cette configuration, et pour chaque ressource, il liste :
_include_revinclude| Type de Ressource | Profil | R | S | U | C | Recherches | _include | _revinclude | Opérations |
|---|---|---|---|---|---|---|---|---|---|
| Organization | https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-dp-organization | y | y | _id, _lastUpdated, active, address, address-city, address-line, address-postalcode, data-information-system, data-registration-authority, identifier, identifier-type, mailbox-mss, name, partof, pharmacy-licence, type | *, Organization:partof | Device:organization, HealthcareService:organization, PractitionerRole:organization | |||
| Device | https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-dp-device | y | y | _id, _lastUpdated, data-information-system, data-registration-authority, identifier, manufacturer, model, organization, status, type | *, Device:organization | ||||
| Practitioner | https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-dp-practitioner | y | y | _id, _lastUpdated, active, data-information-system, data-registration-authority, family, given, identifier, identifier-type, mailbox-mss, name, number-smartcard, qualification-code, type-smartcard | PractitionerRole:practitioner | ||||
| PractitionerRole | https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-dp-practitionerrole | y | y | _id, _lastUpdated, active, data-information-system, data-registration-authority, identifier, mailbox-mss, organization, practitioner, role | *, PractitionerRole:organization, PractitionerRole:practitioner | ||||
| HealthcareService | https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-dp-healthcareservice-healthcare-activity | y | y | _id, _lastUpdated, _profile, active, characteristic, data-information-system, data-registration-authority, identifier, organization, service-category, service-type | *, HealthcareService:organization |
search-type, read.| Conformité | Paramètre | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Recherche sur l'ID de la ressource Organization. |
| SHALL | _lastUpdated | date | Renvoie uniquement les ressources dont la dernière mise à jour correspond à la période spécifiée. Les préfixes supportés par ce paramètre de recherche sont gt, ge et eq. |
| SHALL | active | token | Recherche que les ressources Organizations actives. |
| SHALL | address | string | Recherche sur l'adresse de la structure. |
| SHALL | address-city | string | Recherche sur la commune de la structure. |
| SHALL | address-line | string | Recherche sur l'adresse. |
| SHALL | address-postalcode | string | Recherche sur le code postal de la structure. |
| SHALL | data-information-system | token | Recherche sur le système d'information. |
| SHALL | data-registration-authority | token | Recherche sur l'autorité d'enregistrement. |
| SHALL | identifier | token | Recherche sur tous les identifiants de structures. |
| SHALL | identifier-type | token | Recherche sur le type d'identifiant. Ce paramètre de recherche est voué à être remplacé par le modifier :of-type du paramètre de recherche identifier. |
| SHALL | mailbox-mss | string | Recherche sur les Messageries Sécurisées de Santé (MSS) rattachées aux structures. |
| SHALL | name | string | Recherche sur la raison sociale des structures. Les modifiers supportés par ce paramètre de recherche sont contains, exact et text. |
| SHALL | partof | reference | Recherche sur tous les établissements géographiques rattachés à une même entité juridique. |
| SHALL | pharmacy-licence | string | Recherche sur le numéro de licence des pharmacies officines. |
| SHALL | type | token | Recherche sur le type de structure (entité juridique, entité géographique), le secteur d'activité, la catégorie d'établissement, le code APE/NAF, le statut juridique de la structure, les modalités de participation au service hospitalier et le type d'établissement (principal ou secondaire). |
search-type, read.| Conformité | Paramètre | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Recherche sur l'ID de la ressource Device. |
| SHALL | _lastUpdated | date | Renvoie uniquement les ressources dont la dernière mise à jour correspond à la période spécifiée. Les préfixes supportés par ce paramètre de recherche sont gt, ge et eq. |
| SHALL | data-information-system | token | Recherche sur le système d'information. |
| SHALL | data-registration-authority | token | Recherche sur l'autorité d'enregistrement. |
| SHALL | identifier | token | Recherche sur l'ID de la ressource Device. |
| SHALL | manufacturer | string | Recherche sur la marque des équipements matériels lourds. |
| SHALL | model | string | Recherche sur le modèle des équipements matériels lourds. |
| SHALL | organization | reference | Recherche sur tous les Devices liés à l'Organization indiquée. |
| SHALL | status | token | active | inactive | entered-in-error | unknown. |
| SHALL | type | token | Recherche sur le type de l'équipement matériel lourd. |
search-type, read.| Conformité | Paramètre | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Recherche sur l'ID de la ressource Practitioner. |
| SHALL | _lastUpdated | date | Renvoie uniquement les ressources dont la dernière mise à jour correspond à la période spécifiée. Les préfixes supportés par ce paramètre de recherche sont gt, ge et eq. |
| SHALL | active | token | Recherche que les ressources Practitioners actives. |
| SHALL | data-information-system | token | Recherche sur le système d'information. |
| SHALL | data-registration-authority | token | Recherche sur l'autorité d'enregistrement. |
| SHALL | family | string | Recherche sur le nom d'exercice des Professionnels intervenant dans le système de Santé. Les modifiers supportés par ce paramètre de recherche sont contains, exact et text. |
| SHALL | given | string | Recherche sur le prénom d'exercice des Professionnels intervenant dans le système de Santé. Les modifiers supportés par ce paramètre de recherche sont contains, exact et text. |
| SHALL | identifier | token | Recherche sur tous les identifiants des activités intervenant dans le système de Santé. |
| SHALL | identifier-type | token | Recherche sur le type d'identifiant (Identifiant National des Professionnels intervenant dans le système de Santé (INPS), RPPS, ADELI, etc.). Ce paramètre de recherche est voué à être remplacé par le modifier :of-type du paramètre de recherche identifier. |
| SHALL | mailbox-mss | string | Recherche sur les Messageries Sécurisées de Santé (MSS) rattachées aux Professionnels. Les modifiers supportés par ce paramètre de recherche sont contains et exact. |
| SHALL | name | string | Une recherche définie par le serveur qui peut correspondre à n'importe quel champ de HumanName. Ici, le préfixe correspond à la civilité des professionnels intervenant dans le système de santé. Les modifiers supportés par ce paramètre de recherche sont contains, exact et text. |
| SHALL | number-smartcard | string | Recherche sur le numéro de carte des Professionnels. |
| SHALL | qualification-code | token | Recherche sur le diplôme, l'exercice professionnel et le savoir-faire. |
| SHALL | type-smartcard | token | Recherche sur le type de carte des Professionnels. |
search-type, read.| Conformité | Paramètre | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Recherche sur l'ID de la ressource PractitionerRole. |
| SHALL | _lastUpdated | date | Renvoie uniquement les ressources dont la dernière mise à jour correspond à la période spécifiée. Les préfixes supportés par ce paramètre de recherche sont gt, ge et eq. |
| SHALL | active | token | Recherche que les ressources PractitionerRole actives. |
| SHALL | data-information-system | token | Recherche sur le système d'information. |
| SHALL | data-registration-authority | token | Recherche sur l'autorité d'enregistrement. |
| SHALL | identifier | token | Recherche sur tous les identifiants des activités intervenant dans le système de Santé. |
| SHALL | mailbox-mss | string | Recherche sur les Messageries Sécurisées de Santé (MSS) rattachées aux Practitioners. |
| SHALL | organization | reference | Recherche sur toutes les PractitionerRoles liées aux Organizations. |
| SHALL | practitioner | reference | Recherche sur toutes les PractitionerRoles liées aux Practitioners spécifiés. |
| SHALL | role | token | Recherche sur la fonction, le genre d'activité, le mode d'exercice ou la section Tableau des Pharmaciens. |
search-type, read.| Conformité | Paramètre | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Recherche sur l'ID de la ressource HealthcareService. |
| SHALL | _lastUpdated | date | Renvoie uniquement les ressources dont la dernière mise à jour correspond à la période spécifiée. Les préfixes supportés par ce paramètre de recherche sont gt, ge et eq. |
| SHALL | _profile | uri | Sélectionner le profil de la ressource HealthcareService. |
| SHALL | active | token | Recherche sur les ressources HealthcareService actives. |
| SHALL | characteristic | token | Recherche sur le type d'activité des équipements sociaux ou sur la forme d'activité des activités de soins. |
| SHALL | data-information-system | token | Recherche sur le système d'information. |
| SHALL | data-registration-authority | token | Recherche sur l'autorité d'enregistrement. |
| SHALL | identifier | token | Recherche sur l'identifiant des équipements sociaux ou des activités de soins. |
| SHALL | organization | reference | Recherche sur tous les équipements sociaux ou activités de soins rattachés à une Organization. |
| SHALL | service-category | token | Recherche sur la modalité des activités de soins. |
| SHALL | service-type | token | Recherche sur la discipline des équipements sociaux ou sur l'activité sanitaire régulée des activités de soins. |