Annuaire Santé
1.0.0-ballot-3 - trial-use France flag

This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-3: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

CapabilityStatement: AsClientCapabilityStatement

Official URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/CapabilityStatement/AsClientCapabilityStatement Version: 1.0.0-ballot-3
Active as of 2023-03-23 Computable Name: AsRestServer

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 1.0.0-ballot-3
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, xml, application/fhir+json, json
  • Supported Patch Formats:
  • Published on: Thu Mar 23 13:49:59 UTC 2023
  • 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.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions
  • Supports the transaction interaction.

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 TypeProfileRSUCSearches_include_revincludeOperations
Devicehttp://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-deviceyyyy_id, _lastUpdated, _since, _total, device-name, identifier, location, manufacturer, model, number-authorization-arhgos, organization, status, type*, Device:organizationDevice:location, Device:organization, HealthcareService:organization, Organization:endpoint, Organization:partof, PractitionerRole:organization, PractitionerRole:practitioner
HealthcareServicehttp://hl7.org/fhir/StructureDefinition/HealthcareServiceyyyy_id, _lastUpdated, _profile, _since, _total, active, characteristic, identifier, organization, service-category, service-type*, HealthcareService:organizationDevice:location, Device:organization, HealthcareService:organization, Organization:endpoint, Organization:partof, PractitionerRole:organization, PractitionerRole:practitioner
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*Device:location, Device:organization, HealthcareService:organization, Organization:endpoint, Organization:partof, PractitionerRole:organization, PractitionerRole:practitioner
Organizationhttp://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organizationyyyy_id, _lastUpdated, _since, _total, active, address, address-city, address-country, address-postalcode, address-state, address-use, endpoint, identifier, mailbox-mss, name, partof, pharmacy-licence, type*, Organization:partofDevice:location, Device:organization, HealthcareService:organization, Organization:endpoint, Organization:partof, PractitionerRole:organization, PractitionerRole:practitioner
Practitionerhttp://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitioneryyyy_id, _lastUpdated, _since, _total, active, identifier, mailbox-mss, name*Device:location, Device:organization, HealthcareService:organization, Organization:endpoint, Organization:partof, PractitionerRole:organization, PractitionerRole:practitioner
PractitionerRolehttp://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitionerroleyyyy_id, _lastUpdated, _since, _total, active, family, given, identifier, mailbox-mss, name, number-smartcard, organization, practitioner, role, specialty, type-smartcard*, PractitionerRole:organization, PractitionerRole:partof, PractitionerRole:practitionerDevice:location, Device:organization, HealthcareService:organization, Organization:endpoint, Organization:partof, PractitionerRole:organization, PractitionerRole:practitioner
Subscriptionhttp://hl7.org/fhir/StructureDefinition/Subscriptionyyy_id, criteria, payload, status, type, url*Device:location, Device:organization, HealthcareService:organization, Organization:endpoint, Organization:partof, PractitionerRole:organization, PractitionerRole:practitioner

Resource Conformance: supportedDevice

Base System Profile
http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-device
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Recherche sur l'id de la ressource Device

SHALL_lastUpdateddate

Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la periode donnée

SHALL_sincedate
SHALL_totalstring
SHALLdevice-namestring

The device name

SHALLidentifiertoken

Recherche sur l'identifiant de l'équipement matériel lourd

SHALLlocationreference

The location of the device

SHALLmanufacturerstring

Recherche sur la marque des équipements matériels lourds

SHALLmodelstring

The model of the device

SHALLnumber-authorization-arhgosstring

Recherche sur le numéro d'autorisation ARHGOS

SHALLorganizationreference

Recherche les équipements matériels lourds rattachés à la structure sélectionnée

SHALLstatustoken

active | inactive | entered-in-error | unknown

SHALLtypetoken

Recherche sur le type de l'équipement matériel lourd

 

Resource Conformance: supportedHealthcareService

Base System Profile
http://hl7.org/fhir/StructureDefinition/HealthcareService
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Any id for the healthcare service

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Sélectionner le profil de la ressource Healthcare Service. Pour les activités de soins http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-healthcareservice-healthcare-activity / ; Pour les équipements sociaux http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-healthcareservice-social-equipment

SHALL_sincedate
SHALL_totalstring
SHALLactivetoken

Recherche que les ressources Healthcare Service actives

SHALLcharacteristictoken

Recherche sur le type d'activité des équipements sociaux ou sur la forme d'activité des activités de soins

SHALLidentifiertoken

Recherche sur l'identifiant des équipements sociaux ou des activités de soins

SHALLorganizationreference

Recherche tous les équipements sociaux ou activités de soins rattachés à une structure

SHALLservice-categorytoken

Recherche sur la modalité des activités de soins

SHALLservice-typetoken

Recherche sur la discipline des équipements sociaux ou sur l'activité sanitaire régulée des activité de soins

 

Resource Conformance: supportedOperationDefinition

Base System Profile
http://hl7.org/fhir/StructureDefinition/OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supportedOrganization

Base System Profile
http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Recherche sur l'id de la ressource Organization

SHALL_lastUpdateddate

Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée

SHALL_sincedate
SHALL_totalstring
SHALLactivetoken

Recherche que les ressources Organizations actives

SHALLaddressstring

Recherche sur (une partie) de l'adresse de la structure.

SHALLaddress-citystring

Recherche sur la commune spécifiée dans une adresse

SHALLaddress-countrystring

Recherche sur le pays spécifié dans une adresse

SHALLaddress-postalcodestring

Recherche sur le code postal spécifié dans une adresse

SHALLaddress-statestring

A state specified in an address

SHALLaddress-usetoken

Recherche sur un code use spécifié dans adresse

SHALLendpointreference

Technical endpoints providing access to services operated for the organization

SHALLidentifiertoken

Recherche sur tous les identifiants des structures

SHALLmailbox-mssstring

Recherche sur les messageries sécurisées de santé rattachées aux Organization

SHALLnamestring

Recherche sur la raison sociale des structures

SHALLpartofreference

Recherche tous les établissements géographiques rattachés à une même entité juridique

SHALLpharmacy-licencestring

Recherche sur le numéro de licence des officines

SHALLtypetoken

Recherche sur le type de structure/ code APE/ catégorie juridique/ secteur d'activité/ catégorie d'établissement ou le code SPH de la structure

 

Resource Conformance: supportedPractitioner

Base System Profile
http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

The ID of the resource

SHALL_lastUpdateddate

Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée

SHALL_sincedate
SHALL_totalstring
SHALLactivetoken

Recherche les ressources Practitioner actives

SHALLidentifiertoken

Recherche sur tous les identifiants des professionnels de santé

SHALLmailbox-mssstring
SHALLnamestring

Une recherche définie par le serveur qui peut correspondre à n'importe quel champ de HumanName, ici sur le préfix correspondant à la civilité des professionnels de santé

 

Resource Conformance: supportedPractitionerRole

Base System Profile
http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitionerrole
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

l'id de la ressource

SHALL_lastUpdateddate

Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée

SHALL_sincedate
SHALL_totalstring
SHALLactivetoken

Recherche les ressources PractitionerRole actives

SHALLfamilystring

Recherche sur le nom d'exercice des professionnels de santé

SHALLgivenstring

Recherche sur le prénom d'exercice des professionnels de santé

SHALLidentifiertoken

Any identifier for the practitioner role

SHALLmailbox-mssstring

Recherche sur les messageries sécurisées de santé rattachées à la situation d'exercice des Professionnel de santé

SHALLnamestring

Une recherche définie par le serveur qui peut correspondre à n'importe quel champ de l'élément name : Code civilité d’exercice, le nom ou prénom d'exercice des professionnel de santé.

SHALLnumber-smartcardstring

Recherche sur le numéro de carte des professionnels de santé

SHALLorganizationreference

Recherche les exercices professionnels et les situation d'exercice rattachés à la structure sélectionnée

SHALLpractitionerreference

Recherche les exercices professionnels et les situation d'exercice rattachés aux professionnels de santé sélectionnés

SHALLroletoken

Recherche sur la profession/ la catégorie professionnelle/ la fonction/ le genre d'activité/ le mode d'exercice ou la section tableau des pharmaciens

SHALLspecialtytoken

Recherche sur le savoir-faire ou le Type de savoir-faire

SHALLtype-smartcardtoken

Recherche sur le type de carte du professionnels de santé

 

Resource Conformance: supportedSubscription

Base System Profile
http://hl7.org/fhir/StructureDefinition/Subscription
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Recherche sur l'id de la ressource Subscription

SHALLcriteriastring

Recherche sur le critère de la subscription

SHALLpayloadtoken

Recherche sur le type de payload de la subscription

SHALLstatustoken

Recherche sur le status de la subscription

SHALLtypetoken

Recherche sur le type de la subscription

SHALLurlstring

Recherche sur le url (payload) de la subscription

 
Extended Operations
ConformanceOperationDocumentation
SHALL$deactivate-all
SHALL$activate-all