Vous pouvez consulter et explorer dans un format GraphQL Voyager le schéma d'API Entreprise du Dossier Collaboratif Santé (DCS) de TELUS. Ce format est utile pour apprendre à connaître notre API avant d'y avoir accès à partir de votre compte DCS.
GraphQL prend en charge l'autodécouverte via une requête d'introspection. Les outils Insomnia et Postman prennent en charge les schémas GraphQL de diverses manières. Consultez la documentation de l'outil choisi pour obtenir des renseignements sur la meilleure manière d'importer/d'utiliser le schéma GraphQL.
L'API Entreprise du DCS en format API GraphQL est composé de Requêtes et de Mutations. Les Requêtes prennent en charge l'extraction de données et les Mutations prennent en charge la création/la mise à jour de données.
Les requêtes sources sont nommées d'après les données qu'ils rendent disponibles, comme « appointment » (pour récupérer un seul rendez-vous) et « appointments » (pour récupérer une liste de rendez-vous).
Les mutations sont nommées en fonction des données sur lesquelles elles opèrent, par exemple « createAppointment » (pour ajouter un nouveau rendez-vous).
L'API Entreprise du DCS est conçue pour prendre en charge l'extraction et la mise à jour en temps réel des données au besoin et n'est pas optimisée pour la synchronisation régulière des données entre les systèmes.
Ordre des requêtes
L'API met les réponses dans l'ordre suivant en fonction de l'objet interrogé :
Patients : par ID
Rendez-vous : par date
Filtrage des requêtes
L'API prend en charge le filtrage des résultats en fonction d'un ou plusieurs champs. Les filtres ne sont requis que lorsque le schéma l'indique. Si vous utilisez plusieurs filtres, ils sont appliqués ensemble pour affiner les résultats.
Pagination des requêtes
L'API adhère à la spécification « GraphQL Cursor Connections » (https://relay.dev/graphql/connections.htm) pour les éléments qui exigent une pagination (comme les rendez-vous et les patients). Les objets simples (tels que les emplacements et les serviceTypes) sont renvoyés sous forme d'ensemble de dossiers. La taille des pages est de 50 par défaut, et la taille maximum est de 100.
Mutations
L'API prend en charge la création d'objets via des mutations. Ceux-ci suivent des patrons d'arguments, et fournissent l'un ou les deux éléments suivants :
Argument de saisie : comprend les données qui doivent suivre le modèle de la base de données
Argument d'options : comprend des données indiquant comment le DCS doit traiter cet objet (par exemple, indiquer qu'un rendez-vous doit être confirmé)
La logique d'affaires définie dans votre compte DCS est appliquée via l'API. Par exemple, les heures de réservation minimales ou maximales définies pour un type de rendez-vous ou les heures de travail et l'emplacement définis pour un professionnel sont appliquées.
Mis à jour le 1 février 2022