Annuaire Santé
1.0.0-ballot-2 - STU1

This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-2: 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

: AsClientCapabilityStatement - XML Representation

Active as of 2023-03-23

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="AsClientCapabilityStatement"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>AsRestServer</h2><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr><tr><td>Device</td><td><a href="http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-device">http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-device</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>HealthcareService</td><td><a href="http://hl7.org/fhir/StructureDefinition/HealthcareService">http://hl7.org/fhir/StructureDefinition/HealthcareService</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OperationDefinition</td><td><a href="http://hl7.org/fhir/StructureDefinition/OperationDefinition">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td>y</td><td></td><td></td><td></td></tr><tr><td>Organization</td><td><a href="http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organization">http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organization</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Practitioner</td><td><a href="http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitioner">http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitioner</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>PractitionerRole</td><td><a href="http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitionerrole">http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitionerrole</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Subscription</td><td><a href="http://hl7.org/fhir/StructureDefinition/Subscription">http://hl7.org/fhir/StructureDefinition/Subscription</a></td><td>y</td><td>y</td><td>y</td><td></td></tr></table></div>
  </text>
  <url
       value="https://interop.esante.gouv.fr/ig/fhir/annuaire/CapabilityStatement/AsClientCapabilityStatement"/>
  <version value="1.0.0-ballot-2"/>
  <name value="AsRestServer"/>
  <status value="active"/>
  <date value="2023-03-23T13:49:59.485+00:00"/>
  <publisher value="ANS"/>
  <contact>
    <name value="ANS"/>
    <telecom>
      <system value="url"/>
      <value value="https://esante.gouv.fr"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="monserviceclient.annuaire@esante.gouv.fr"/>
    </telecom>
  </contact>
  <kind value="instance"/>
  <software>
    <name value="Afas Fhir server"/>
    <version value="V1-R4"/>
  </software>
  <implementation>
    <description value="Afas data"/>
    <url value="https://gateway.api.esante.gouv.fr/fhir/v1"/>
  </implementation>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="xml"/>
  <format value="application/fhir+json"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="Device"/>
      <profile
               value="http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-device"/>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <searchInclude value="*"/>
      <searchInclude value="Device:organization"/>
      <searchRevInclude value="Device:location"/>
      <searchRevInclude value="Device:organization"/>
      <searchRevInclude value="HealthcareService:organization"/>
      <searchRevInclude value="Organization:endpoint"/>
      <searchRevInclude value="Organization:partof"/>
      <searchRevInclude value="PractitionerRole:organization"/>
      <searchRevInclude value="PractitionerRole:practitioner"/>
      <searchParam>
        <name value="_id"/>
        <type value="token"/>
        <documentation value="Recherche sur l'id de la ressource Device"/>
      </searchParam>
      <searchParam>
        <name value="_lastUpdated"/>
        <type value="date"/>
        <documentation
                       value="Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la periode donnée"/>
      </searchParam>
      <searchParam>
        <name value="_since"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <name value="_total"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="device-name"/>
        <type value="string"/>
        <documentation value="The device name"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur l'identifiant de l'équipement matériel lourd"/>
      </searchParam>
      <searchParam>
        <name value="location"/>
        <type value="reference"/>
        <documentation value="The location of the device"/>
      </searchParam>
      <searchParam>
        <name value="manufacturer"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur la marque des équipements matériels lourds"/>
      </searchParam>
      <searchParam>
        <name value="model"/>
        <type value="string"/>
        <documentation value="The model of the device"/>
      </searchParam>
      <searchParam>
        <name value="number-authorization-arhgos"/>
        <type value="string"/>
        <documentation value="Recherche sur le numéro d'autorisation ARHGOS"/>
      </searchParam>
      <searchParam>
        <name value="organization"/>
        <type value="reference"/>
        <documentation
                       value="Recherche les équipements matériels lourds rattachés à la structure sélectionnée"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <type value="token"/>
        <documentation
                       value="active | inactive | entered-in-error | unknown"/>
      </searchParam>
      <searchParam>
        <name value="type"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur le type de l'équipement matériel lourd"/>
      </searchParam>
    </resource>
    <resource>
      <type value="HealthcareService"/>
      <profile
               value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <searchInclude value="*"/>
      <searchInclude value="HealthcareService:organization"/>
      <searchRevInclude value="Device:location"/>
      <searchRevInclude value="Device:organization"/>
      <searchRevInclude value="HealthcareService:organization"/>
      <searchRevInclude value="Organization:endpoint"/>
      <searchRevInclude value="Organization:partof"/>
      <searchRevInclude value="PractitionerRole:organization"/>
      <searchRevInclude value="PractitionerRole:practitioner"/>
      <searchParam>
        <name value="_id"/>
        <type value="token"/>
        <documentation value="Any id for the healthcare service"/>
      </searchParam>
      <searchParam>
        <name value="_lastUpdated"/>
        <type value="date"/>
        <documentation
                       value="Only return resources which were last updated as specified by the given range"/>
      </searchParam>
      <searchParam>
        <name value="_profile"/>
        <type value="uri"/>
        <documentation
                       value="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"/>
      </searchParam>
      <searchParam>
        <name value="_since"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <name value="_total"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="active"/>
        <type value="token"/>
        <documentation
                       value="Recherche que les ressources Healthcare Service actives"/>
      </searchParam>
      <searchParam>
        <name value="characteristic"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur le type d'activité des équipements sociaux ou sur la forme d'activité des activités de soins"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur l'identifiant des équipements sociaux ou des activités de soins"/>
      </searchParam>
      <searchParam>
        <name value="organization"/>
        <type value="reference"/>
        <documentation
                       value="Recherche tous les équipements sociaux ou activités de soins rattachés à une structure"/>
      </searchParam>
      <searchParam>
        <name value="service-category"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur la modalité des activités de soins"/>
      </searchParam>
      <searchParam>
        <name value="service-type"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur la discipline des équipements sociaux ou sur l'activité sanitaire régulée des activité de soins"/>
      </searchParam>
    </resource>
    <resource>
      <type value="OperationDefinition"/>
      <profile
               value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <searchInclude value="*"/>
      <searchRevInclude value="Device:location"/>
      <searchRevInclude value="Device:organization"/>
      <searchRevInclude value="HealthcareService:organization"/>
      <searchRevInclude value="Organization:endpoint"/>
      <searchRevInclude value="Organization:partof"/>
      <searchRevInclude value="PractitionerRole:organization"/>
      <searchRevInclude value="PractitionerRole:practitioner"/>
    </resource>
    <resource>
      <type value="Organization"/>
      <profile
               value="http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organization"/>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <searchInclude value="*"/>
      <searchInclude value="Organization:partof"/>
      <searchRevInclude value="Device:location"/>
      <searchRevInclude value="Device:organization"/>
      <searchRevInclude value="HealthcareService:organization"/>
      <searchRevInclude value="Organization:endpoint"/>
      <searchRevInclude value="Organization:partof"/>
      <searchRevInclude value="PractitionerRole:organization"/>
      <searchRevInclude value="PractitionerRole:practitioner"/>
      <searchParam>
        <name value="_id"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur l'id de la ressource Organization"/>
      </searchParam>
      <searchParam>
        <name value="_lastUpdated"/>
        <type value="date"/>
        <documentation
                       value="Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée"/>
      </searchParam>
      <searchParam>
        <name value="_since"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <name value="_total"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="active"/>
        <type value="token"/>
        <documentation
                       value="Recherche que les ressources Organizations actives"/>
      </searchParam>
      <searchParam>
        <name value="address"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur (une partie) de l'adresse de la structure."/>
      </searchParam>
      <searchParam>
        <name value="address-city"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur la commune spécifiée dans une adresse"/>
      </searchParam>
      <searchParam>
        <name value="address-country"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur le pays spécifié dans une adresse"/>
      </searchParam>
      <searchParam>
        <name value="address-postalcode"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur le code postal spécifié dans une adresse"/>
      </searchParam>
      <searchParam>
        <name value="address-state"/>
        <type value="string"/>
        <documentation value="A state specified in an address"/>
      </searchParam>
      <searchParam>
        <name value="address-use"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur un code use spécifié dans adresse"/>
      </searchParam>
      <searchParam>
        <name value="endpoint"/>
        <type value="reference"/>
        <documentation
                       value="Technical endpoints providing access to services operated for the organization"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur tous les identifiants des structures"/>
      </searchParam>
      <searchParam>
        <name value="mailbox-mss"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur les messageries sécurisées de santé rattachées aux Organization"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur la raison sociale des structures"/>
      </searchParam>
      <searchParam>
        <name value="partof"/>
        <type value="reference"/>
        <documentation
                       value="Recherche tous les établissements géographiques rattachés à une même entité juridique"/>
      </searchParam>
      <searchParam>
        <name value="pharmacy-licence"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur le numéro de licence des officines"/>
      </searchParam>
      <searchParam>
        <name value="type"/>
        <type value="token"/>
        <documentation
                       value="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"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Practitioner"/>
      <profile
               value="http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitioner"/>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <searchInclude value="*"/>
      <searchRevInclude value="Device:location"/>
      <searchRevInclude value="Device:organization"/>
      <searchRevInclude value="HealthcareService:organization"/>
      <searchRevInclude value="Organization:endpoint"/>
      <searchRevInclude value="Organization:partof"/>
      <searchRevInclude value="PractitionerRole:organization"/>
      <searchRevInclude value="PractitionerRole:practitioner"/>
      <searchParam>
        <name value="_id"/>
        <type value="token"/>
        <documentation value="The ID of the resource"/>
      </searchParam>
      <searchParam>
        <name value="_lastUpdated"/>
        <type value="date"/>
        <documentation
                       value="Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée"/>
      </searchParam>
      <searchParam>
        <name value="_since"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <name value="_total"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="active"/>
        <type value="token"/>
        <documentation value="Recherche les ressources Practitioner actives"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur tous les identifiants des professionnels de santé"/>
      </searchParam>
      <searchParam>
        <name value="mailbox-mss"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation
                       value="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é"/>
      </searchParam>
    </resource>
    <resource>
      <type value="PractitionerRole"/>
      <profile
               value="http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitionerrole"/>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <searchInclude value="*"/>
      <searchInclude value="PractitionerRole:organization"/>
      <searchInclude value="PractitionerRole:partof"/>
      <searchInclude value="PractitionerRole:practitioner"/>
      <searchRevInclude value="Device:location"/>
      <searchRevInclude value="Device:organization"/>
      <searchRevInclude value="HealthcareService:organization"/>
      <searchRevInclude value="Organization:endpoint"/>
      <searchRevInclude value="Organization:partof"/>
      <searchRevInclude value="PractitionerRole:organization"/>
      <searchRevInclude value="PractitionerRole:practitioner"/>
      <searchParam>
        <name value="_id"/>
        <type value="token"/>
        <documentation value="l'id de la ressource"/>
      </searchParam>
      <searchParam>
        <name value="_lastUpdated"/>
        <type value="date"/>
        <documentation
                       value="Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée"/>
      </searchParam>
      <searchParam>
        <name value="_since"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <name value="_total"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="active"/>
        <type value="token"/>
        <documentation
                       value="Recherche les ressources PractitionerRole actives"/>
      </searchParam>
      <searchParam>
        <name value="family"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur le nom d'exercice des professionnels de santé"/>
      </searchParam>
      <searchParam>
        <name value="given"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur le prénom d'exercice des professionnels de santé"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="Any identifier for the practitioner role"/>
      </searchParam>
      <searchParam>
        <name value="mailbox-mss"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur les messageries sécurisées de santé rattachées à la situation d'exercice des Professionnel de santé"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation
                       value="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é."/>
      </searchParam>
      <searchParam>
        <name value="number-smartcard"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur le numéro de carte des professionnels de santé"/>
      </searchParam>
      <searchParam>
        <name value="organization"/>
        <type value="reference"/>
        <documentation
                       value="Recherche les exercices professionnels et les situation d'exercice rattachés à la structure sélectionnée"/>
      </searchParam>
      <searchParam>
        <name value="practitioner"/>
        <type value="reference"/>
        <documentation
                       value="Recherche les exercices professionnels et les situation d'exercice rattachés aux professionnels de santé sélectionnés"/>
      </searchParam>
      <searchParam>
        <name value="role"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur la profession/ la catégorie professionnelle/ la fonction/ le genre d'activité/ le mode d'exercice ou la section tableau des pharmaciens"/>
      </searchParam>
      <searchParam>
        <name value="specialty"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur le savoir-faire ou le Type de savoir-faire"/>
      </searchParam>
      <searchParam>
        <name value="type-smartcard"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur le type de carte du professionnels de santé"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Subscription"/>
      <profile value="http://hl7.org/fhir/StructureDefinition/Subscription"/>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <searchInclude value="*"/>
      <searchRevInclude value="Device:location"/>
      <searchRevInclude value="Device:organization"/>
      <searchRevInclude value="HealthcareService:organization"/>
      <searchRevInclude value="Organization:endpoint"/>
      <searchRevInclude value="Organization:partof"/>
      <searchRevInclude value="PractitionerRole:organization"/>
      <searchRevInclude value="PractitionerRole:practitioner"/>
      <searchParam>
        <name value="_id"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur l'id de la ressource Subscription"/>
      </searchParam>
      <searchParam>
        <name value="criteria"/>
        <type value="string"/>
        <documentation value="Recherche sur le critère de la subscription"/>
      </searchParam>
      <searchParam>
        <name value="payload"/>
        <type value="token"/>
        <documentation
                       value="Recherche sur le type de payload de la subscription"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <type value="token"/>
        <documentation value="Recherche sur le status de la subscription"/>
      </searchParam>
      <searchParam>
        <name value="type"/>
        <type value="token"/>
        <documentation value="Recherche sur le type de la subscription"/>
      </searchParam>
      <searchParam>
        <name value="url"/>
        <type value="string"/>
        <documentation
                       value="Recherche sur le url (payload) de la subscription"/>
      </searchParam>
      <operation>
        <name value="deactivate-all"/>
        <definition
                    value="https://gateway.api.esante.gouv.fr/fhir/v1/OperationDefinition/Subscription-t-deactivate-all"/>
      </operation>
      <operation>
        <name value="activate-all"/>
        <definition
                    value="https://gateway.api.esante.gouv.fr/fhir/v1/OperationDefinition/Subscription-t-activate-all"/>
      </operation>
    </resource>
    <interaction>
      <code value="transaction"/>
    </interaction>
  </rest>
</CapabilityStatement>