Gestion d'Agendas Partagés (GAP)
3.0.0 - trial-use France flag

This page is part of the Guide d'implémentation FHIR - Gestion d'Agendas Partagés (v3.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: CI-SIS Gestion-d-Agendas-Partages - GestionnaireAgendaGAP - XML Representation

Active as of 2023-08-02

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="GAP-GestionnaireAgenda"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">CI-SIS Gestion-d-Agendas-Partages - GestionnaireAgendaGAP</h2><ul><li>Implementation Guide Version: 3.0.0</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-08-02</li><li>Published by: ANS</li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as &quot;SHALL NOT&quot;. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li>https://interop.esante.gouv.fr/ig/fhir/gap</li></ul><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div><p>Déclaration, modification et suppression des disponibilités d'une ressource</p>
</div><div class="lead"><em>Security</em></div><blockquote><div><p>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)</p>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="PATCH a new resource version (patch interaction)">P</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th class="text-center"><b title="DELETE a resource (delete interaction)">D</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Schedule1-1">Schedule</a></td><td><a href="https://hl7.fr/ig/fhir/core/2.0.1/StructureDefinition-fr-core-schedule.html">https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule</a></td><td></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Slot1-2">Slot</a></td><td><a href="https://hl7.fr/ig/fhir/core/2.0.1/StructureDefinition-fr-core-slot.html">https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-slot</a></td><td>y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td>GAP_Slot_earliestStart, GAP_Slot_latestStart, GAP_Schedule_Actor, Schedule-actor, identifier, status</td><td/><td/><td/></tr><tr><td><a href="#Appointment1-3">Appointment</a></td><td><a href="https://hl7.fr/ig/fhir/core/2.0.1/StructureDefinition-fr-core-appointment.html">https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment</a></td><td>y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center"></td><td>GAP_Appointment_priority, GAP_Appointment_description, GAP_Appointment_created, GAP_Appointment_Actor, GAP_Appointment_earliestStart, GAP_Appointment_latestStart, date, identifier, service-type, status, supporting-info</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Schedule1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Schedule</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="https://hl7.fr/ig/fhir/core/2.0.1/StructureDefinition-fr-core-schedule.html">https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>update</code>, <code>delete</code>, <code>patch</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Slot1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Slot</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="https://hl7.fr/ig/fhir/core/2.0.1/StructureDefinition-fr-core-slot.html">https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-slot</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-GAP-Slot-earliestStart.html">GAP_Slot_earliestStart</a></td><td><code>date</code></td><td><div><p>Recherche d'une disponibilité sur la date et l'heure de la disponibilité souhaité, date au plus tôt</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-GAP-Slot-latestStart.html">GAP_Slot_latestStart</a></td><td><code>date</code></td><td><div><p>Recherche d'une disponibilité sur la date et l'heure de disponibilité souhaité, date au plus tard</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/slot.html#search">GAP_Schedule_Actor</a></td><td><code>reference</code></td><td><div><p>Recherche d'une disponibilité sur les caractéristiques de la ressource Device qui est l'acteur d'agenda (identifiant, nom, modèle, type)</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/slot.html#search">Schedule-actor</a></td><td><code>reference</code></td><td><div><p>Recherche d'un acteur de l'agenda</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/slot.html#search">identifier</a></td><td><code>token</code></td><td><div><p>A Slot Identifier</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/slot.html#search">status</a></td><td><code>token</code></td><td><div><p>The free/busy status of the appointment</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Appointment1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Appointment</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="https://hl7.fr/ig/fhir/core/2.0.1/StructureDefinition-fr-core-appointment.html">https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>update</code>, <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-GAP-Appointment-priority.html">GAP_Appointment_priority</a></td><td><code>token</code></td><td><div><p>Priority of the appointment</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-GAP-Appointment-description.html">GAP_Appointment_description</a></td><td><code>string</code></td><td><div><p>Comment or title of the appointment</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-GAP-Appointment-created.html">GAP_Appointment_created</a></td><td><code>date</code></td><td><div><p>Date that this appointment was initially created</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/appointment.html#search">GAP_Appointment_Actor</a></td><td><code>reference</code></td><td><div><p>Recherche d'un rendez-vous sur l'identifiant de l'acteur, la ressource pouvant être Patient, Practitioner, PractitionerRole, RelatedPerson, Location, Device ou HealthcareService</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-GAP-Appointment-earliestStart.html">GAP_Appointment_earliestStart</a></td><td><code>date</code></td><td><div><p>Recherche d'un rendez-vous sur la date et heure de rendez-vous, date au plus tôt</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-GAP-Appointment-latestStart.html">GAP_Appointment_latestStart</a></td><td><code>date</code></td><td><div><p>Recherche d'un rendez-vous sur la date et heure de rendez-vous, date au plus tard</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/appointment.html#search">date</a></td><td><code>date</code></td><td><div><p>date et heure du rendez-vous</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/appointment.html#search">identifier</a></td><td><code>token</code></td><td><div><p>identifiant du rendez-vous</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/appointment.html#search">service-type</a></td><td><code>token</code></td><td><div><p>serivce spécifique qui doit être réslisé pandant le rendez-vous</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/appointment.html#search">status</a></td><td><code>token</code></td><td><div><p>The overall status of the appointment</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/appointment.html#search">supporting-info</a></td><td><code>reference</code></td><td><div><p>Additional information to support the appointment</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
  </text>
  <url
       value="https://interop.esante.gouv.fr/ig/fhir/gap/CapabilityStatement/GAP-GestionnaireAgenda"/>
  <version value="3.0.0"/>
  <name value="GAP_GestionnaireAgenda"/>
  <title value="CI-SIS Gestion-d-Agendas-Partages - GestionnaireAgendaGAP"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2023-08-02"/>
  <publisher value="ANS"/>
  <contact>
    <name value="ANS"/>
    <telecom>
      <system value="url"/>
      <value value="https://esante.gouv.fr"/>
    </telecom>
  </contact>
  <description
               value="Le gestionnaire d’agenda gère les demandes de déclaration, de modification ou de   suppression de rendez-vous."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="FR"/>
      <display value="FRANCE"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="application/fhir+json"/>
  <implementationGuide value="https://interop.esante.gouv.fr/ig/fhir/gap"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="Déclaration, modification et suppression des disponibilités d'une ressource"/>
    <security>
      <cors value="false"/>
      <description
                   value="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)"/>
    </security>
    <resource>
      <type value="Schedule"/>
      <profile
               value="https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-schedule"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="patch"/>
      </interaction>
    </resource>
    <resource>
      <type value="Slot"/>
      <profile
               value="https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-slot"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="GAP_Slot_earliestStart"/>
        <definition
                    value="https://interop.esante.gouv.fr/ig/fhir/gap/SearchParameter/GAP-Slot-earliestStart"/>
        <type value="date"/>
        <documentation
                       value="Recherche d'une disponibilité sur la date et l'heure de la disponibilité souhaité, date au plus tôt"/>
      </searchParam>
      <searchParam>
        <name value="GAP_Slot_latestStart"/>
        <definition
                    value="https://interop.esante.gouv.fr/ig/fhir/gap/SearchParameter/GAP-Slot-latestStart"/>
        <type value="date"/>
        <documentation
                       value="Recherche d'une disponibilité sur la date et l'heure de disponibilité souhaité, date au plus tard"/>
      </searchParam>
      <searchParam>
        <name value="GAP_Schedule_Actor"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Schedule-actor"/>
        <type value="reference"/>
        <documentation
                       value="Recherche d'une disponibilité sur les caractéristiques de la ressource Device qui est l'acteur d'agenda (identifiant, nom, modèle, type)"/>
      </searchParam>
      <searchParam>
        <name value="Schedule-actor"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Schedule-actor"/>
        <type value="reference"/>
        <documentation value="Recherche d'un acteur de l'agenda"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Slot-identifier"/>
        <type value="token"/>
        <documentation value="A Slot Identifier"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Slot-status"/>
        <type value="token"/>
        <documentation value="The free/busy status of the appointment"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Appointment"/>
      <profile
               value="https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <conditionalUpdate value="true"/>
      <searchParam>
        <name value="GAP_Appointment_priority"/>
        <definition
                    value="https://interop.esante.gouv.fr/ig/fhir/gap/SearchParameter/GAP-Appointment-priority"/>
        <type value="token"/>
        <documentation value="Priority of the appointment"/>
      </searchParam>
      <searchParam>
        <name value="GAP_Appointment_description"/>
        <definition
                    value="https://interop.esante.gouv.fr/ig/fhir/gap/SearchParameter/GAP-Appointment-description"/>
        <type value="string"/>
        <documentation value="Comment or title of the appointment"/>
      </searchParam>
      <searchParam>
        <name value="GAP_Appointment_created"/>
        <definition
                    value="https://interop.esante.gouv.fr/ig/fhir/gap/SearchParameter/GAP-Appointment-created"/>
        <type value="date"/>
        <documentation
                       value="Date that this appointment was initially created"/>
      </searchParam>
      <searchParam>
        <name value="GAP_Appointment_Actor"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Appointment-actor"/>
        <type value="reference"/>
        <documentation
                       value="Recherche d'un rendez-vous sur l'identifiant de l'acteur, la ressource pouvant être Patient, Practitioner, PractitionerRole, RelatedPerson, Location, Device ou HealthcareService"/>
      </searchParam>
      <searchParam>
        <name value="GAP_Appointment_earliestStart"/>
        <definition
                    value="https://interop.esante.gouv.fr/ig/fhir/gap/SearchParameter/GAP-Appointment-earliestStart"/>
        <type value="date"/>
        <documentation
                       value="Recherche d'un rendez-vous sur la date et heure de rendez-vous, date au plus tôt"/>
      </searchParam>
      <searchParam>
        <name value="GAP_Appointment_latestStart"/>
        <definition
                    value="https://interop.esante.gouv.fr/ig/fhir/gap/SearchParameter/GAP-Appointment-latestStart"/>
        <type value="date"/>
        <documentation
                       value="Recherche d'un rendez-vous sur la date et heure de rendez-vous, date au plus tard"/>
      </searchParam>
      <searchParam>
        <name value="date"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Appointment-date"/>
        <type value="date"/>
        <documentation value="date et heure du rendez-vous"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Appointment-identifier"/>
        <type value="token"/>
        <documentation value="identifiant du rendez-vous"/>
      </searchParam>
      <searchParam>
        <name value="service-type"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Appointment-service-type"/>
        <type value="token"/>
        <documentation
                       value="serivce spécifique qui doit être réslisé pandant le rendez-vous"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Appointment-status"/>
        <type value="token"/>
        <documentation value="The overall status of the appointment"/>
      </searchParam>
      <searchParam>
        <name value="supporting-info"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Appointment-supporting-info"/>
        <type value="reference"/>
        <documentation
                       value="Additional information to support the appointment"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>