L'interface de programmation d'applications (API) d'entreprise du Dossier Collaboratif Santé (DCS) de TELUS vous permet de créer vos propres intégrations pour les outils que vous construisez ou achetez auprès d'autres fournisseurs. Par exemple, vous utilisez peut-être une tierce solution de prise de rendez-vous ou vous avez peut-être développé votre propre outil d'inscription de patients.

Grâce à l'API, vous pouvez accéder aux données de la plateforme DCS de manière pratique et sécurisée via un point de terminaison GraphQL. Vos données du DCS sont exposées sous forme d'un graphique de données que vous pouvez interroger. La structure GraphQL vous permet, en tant que consommateur de l'API, de définir les données que vous pouvez interroger, créer ou mettre à jour en fonction des données disponibles dans votre DCS. Seules les données que vous avez demandées sont fournies dans la réponse.

Pour plus de renseignements sur le schéma de l'API du DCS, consultez la rubrique Documentation de référence de l'API.

GraphQL est une norme moderne d'API. Pour plus de renseignements sur cette norme et ses outils et ses librairies, accédez au lien https://graphql.org.

Avec chaque version du DCS, nous améliorons et corrigeons l'API. Pour plus de renseignements, consultez la rubrique Quoi de neuf dans l'API.

Toutes les demandes de l'API exigent des identifiants d'API valides sous forme de JSON Web Token (JWT). Le compte Soutien du DCS de TELUS peut consulter et gérer les consommateurs de l'API et leurs identifiants dans les paramètres du DCS.

Ces identifiants d'API fournissent à un consommateur de l'API un accès sans restriction à toutes les données du DCS de votre organisation. Vous pouvez créer plusieurs consommateurs de l'API, par exemple, un pour prendre en charge l'intégration avec une solution de prise de rendez-vous auprès d'un fournisseur, et un autre pour l'intégration que vous construisez avec votre propre solution d'inscription de clients. Au besoin, vous pouvez révoquer l'accès d'un consommateur de l'API à tout moment en le désactivant. Vous pouvez également rétablir leur accès en les réactivant. Pour plus de renseignements, consultez la rubrique Créer des consommateurs de l'API.

Pour qu'un JWT soit valide, il doit respecter les exigences suivantes :

Chaque action effectuée par l'API est enregistrée dans un journal d'audit du DCS. Le consommateur de l'API qui a lancé l'action est enregistré à l'aide de ses identifiants d'API. De plus, toutes les demandes et les réponses de l'API sont également saisies par consommateur de l'API, ce qui rend transparentes toutes les demandes soumises et données renvoyées à chaque consommateur de l'API. Pour plus de renseignements, consultez la rubrique Consulter les journaux de l'API.

L'API Entreprise DCS est une fonctionnalité qu'il faut payer et n'est actuellement offerte qu'à quelques clients.

Pour utiliser l'API Entreprise DCS, vous devez :

Pour un aperçu du processus de mise en service de l'API Entreprise DCS, consultez la rubrique Aperçu de la mise en service de l'API Entreprise.

Une fois ces éléments en place, vous pouvez créer les consommateurs de l'API de votre DCS et commencer à envoyer des demandes relatives à vos données du DCS. Pour plus de renseignements, consultez la rubrique Envoyer des demandes à votre API Entreprise DCS.

Mis à jour le 22 février 2024