Le service de notification d'événement de l'API Entreprise est une fonctionnalité permettant à un consommateur d'API de recevoir des avis chaque fois qu'un ou plusieurs événements donnés se produisent dans son compte, par l'intermédiaire d'un mécanisme de lien de rappel HTTP.
Par exemple, lorsqu'un rendez-vous est créé dans votre compte, un avis contenant des détails sur ce rendez-vous est immédiatement envoyé à une URL de rappel que vous avez définie lorsque vous avez créé un abonnement.
Sécurité
L'écoute d'un lien de rappel HTTP implique d'exposer une URL (le point de terminaison du lien de rappel HTTP) au web. Étant donné que n'importe qui peut appeler le point de terminaison du lien de rappel HTTP, il n'est pas conseillé d'agir aveuglément sur toutes les demandes reçues à ce point de terminaison. Pour vous aider à déterminer les demandes de votre compte, le DCS signe chaque avis avec un « secret ». La signature résultante est comprise dans l'en-tête de la demande. Avant de procéder à l'exécution de tout programme, vous pouvez utiliser cette signature pour vérifier que l'avis provient de votre compte DCS. Pour plus de détails sur la configuration de votre secret, allez à Créer un nouvel abonnement.
📌 Remarque : Pour une sécurité accrue, la charge utile de l'avis ne contient pas de renseignements personnels ou de renseignements de santé personnels. Seul un ensemble de champs est fourni pour vous permettre de récupérer les données complètes liées à l'événement par le biais d'une demande de l'API.
Tentatives de livraison
Le destinataire des avis doit renvoyer un code d'état de réponse HTTP « 2XX » pour informer le service de notification d'événements que l'avis a été reçu. Si un avis échoue pour une raison quelconque, le service de notification d'événements utilise un mécanisme de temporisation de retransmission pour réessayer d'envoyer la demande à votre point de terminaison à 5 reprises : après 5, 10, 20, 60 et 120 minutes. Il n'y a pas de nouvelles tentatives pour l'envoi d'avis si le serveur répond avec l'état HTTP « 410 Gone ».
Créer un nouvel abonnement
Pour recevoir des avis, vous devez créer un abonnement et sélectionner les événements pour lesquels vous voulez recevoir un avis.
Étapes
Rassemblez les renseignements requis pour configurer votre abonnement :
URL de l'abonnement : URL qui reçoit les demandes HTTP Post.
Secret : Chaîne de texte utilisée pour créer la signature de chaque avis.
Connectez-vous au DCS en tant qu'utilisateur avec autorisations pour accéder aux paramètres de l'API Entreprise.
Dans le menu principal, cliquez sur Paramètres > API Entreprise. La liste de consommateurs existants s'affiche.
Cliquez sur l'icône du crayon à côté du Consommateur de l'API approprié. La fenêtre Modifier le consommateur de l'API s’ouvre.
Cliquez sur l'onglet Abonnements. Les abonnements existants s'affichent.
Cliquez sur + Nouvel abonnement. La fenêtre Ajouter un abonnement s'affiche.
Dans le champ Nom de l'abonnement, saisissez un nom pour décrire l'abonnement.
Dans le champ URL de l'abonnement, saisissez l'URL vers laquelle les avis seront dirigés.
Dans le champ Secret, saisissez la chaîne de texte qui sera utilisée pour créer la signature (consultez la section Sécurité).
Sélectionnez un ou plusieurs événements dans la section Types d'événements en fonction des événements pour lesquels vous souhaitez recevoir des avis.
Cliquez sur Accepter.
📌 Remarque : Les abonnements sont activés dès la création. Vous pouvez désactiver un abonnement en cliquant sur l'icône de désactivation pour l'abonnement souhaité.
Charge utile de l'avis
Chaque avis émet sa charge utile au format JSON. La charge utile de l'avis ne contient que des identifiants et d'autres champs, aucun renseignement personnel ou aucun renseignement de santé personnel. Vous pouvez utiliser ces identifiants dans une demande pour récupérer les renseignements requis pour votre consommateur de l'API. Certains champs sont uniques tandis que d'autres sont partagés entre tous les types d'événement.
Chaque charge utile de notification comprend les champs suivants :
événement
subscriptionId
accountDomain
Vous trouverez ci-dessous une liste de types d'événements et des champs supplémentaires renvoyés :
Type d'événement | Champs |
appointment.canceled appointment.created appointment.deactivated appointment.updated | appointmentId patientId providerId locationId serviceId visitType startAt changedFields |
patient_demographics.archived patient_demographics.created patient_demographics.updated | patientId primaryPractitionerId primaryLocationId changedFields |
qnaire.completed | questionnaireResponseId patientId providerId questionnaireId |
Mis à jour le 9 juin 2023