Configuration des paramètres et des autorisations pour les intégrations API

Prérequis

Ocean offre une grande flexibilité pour effectuer des mises à jour à l’orientation et recevoir des notifications tout au long du cycle de vie de l’orientation. Cela peut introduire de la complexité dans une intégration API d’eOrientation entre Ocean et un système en aval. Cet article décrit ces notifications, paramètres et permissions afin que les intégrateurs puissent évaluer ceux qui peuvent être pris en charge par leur intégration.

  • Les notifications, paramètres et permissions se trouvent sur la page Admin > Intégrations > eOrientation.
  • Après avoir sélectionné « eOrientation », la fenêtre de configuration complète apparaîtra.

Nom de l’intégration

  • Le nom de l’intégration est utilisé pour identifier l’intégration lors de son association à une ou plusieurs listes d’annuaire.
  • Il est également utilisé pour identifier l’intégration si le site a plusieurs intégrations configurées.
  • Note : La liste des intégrations inclut également des icônes d’état de l’intégration. Un hexagone jaune ou rouge apparaissant à droite du nom de l’intégration indique qu’Ocean ne peut pas communiquer avec succès avec le point de terminaison.

    Survoler l’icône avec votre curseur fournit des détails supplémentaires sur le code de réponse d’erreur reçu par Ocean.

Point de terminaison Webhook

  • Utilisé pour préciser où Ocean enverra les notifications webhook d’eOrientation à mesure que l’orientation est mise à jour dans le Portail Ocean.
  • Si le type de charge utile est défini sur Open API, Ocean vérifiera automatiquement si l’URL saisie dans ce champ est valide. Si elle est non valide, un hexagone jaune apparaîtra.

Type de charge utile

Ocean propose deux ensembles d’API pour l’intégration eOrientation : les Open API et les HL7 FHIR API. Ce paramètre permet de sélectionner quel ensemble d’API Ocean utilisera pour communiquer avec votre système.  

Note : Les deux ensembles d’API ne sont pas équivalents en termes d’événements pris en charge, de structures de données ou de mécanismes de sécurité. Comme les API FHIR sont basées sur des normes et plus largement adoptées, il est conseillé aux intégrateurs de les utiliser, sauf raison spécifique d’utiliser les Open API, comme le lancement contextuel d’un système.

Lancement contextuel du système

  • Certains destinataires d’orientation exigent qu’un autre système soit lancé pendant ou après la création d’une orientation.
  • L’onglet « Lancement du système d’orientation » dans l’article « Activer les intégrations Ocean » décrit comment configurer un lancement de système d’orientation.

    Note : Cette fonctionnalité est disponible uniquement pour certains acheminements. Veuillez soumettre un billet de soutien pour vérifier si elle s’applique à votre intégration.

Notifications par courriel

  • Lorsque des mises à jour d’eOrientation sont effectuées dans le Portail Ocean, Ocean envoie des notifications par courriel. Celles-ci sont décrites dans l’article de soutien « Où sont envoyés les courriels de notification d’eConsultation et/ou d’eOrientation ? ».
  • Par défaut, les mises à jour effectuées via les API ne déclencheront pas de notifications par courriel aux participants à l’orientation. Si elles sont activées, Ocean enverra une notification par courriel aux participants appropriés.

Paramètres de soumission

  • Par défaut, tous les formulaires d’orientation incluent un bouton « Ajouter la pièce jointe » pour téléverser des fichiers.
  • L’activation de la case « Empêcher les expéditeurs d’orientation d’inclure des pièces jointes » masque le bouton sur toute orientation initiée vers des listes configurées avec cette intégration. Ceci est utile si le système en aval ne souhaite pas stocker ou gérer des pièces jointes.

Permissions

Développez chaque paramètre ci-dessous pour obtenir de l’information supplémentaire concernant la fonctionnalité.

Effectuer les mises à jour d'état suivantes dans Ocean : Accepter, Diviser, Compléter, Marquer comme incomplet, Accepter la réponse, Annuler
  • Par défaut, un site avec une intégration API aura les boutons d'action liés à ces mises à jour d'état cachés dans la page de l'eOrientation.
  • Ces mises à jour d'état sont similaires à celles prises en charge par les API, donc le site doit déterminer s'il souhaite les activer afin que les utilisateurs Ocean puissent également gérer l'eOrientation dans le Portail Ocean.
Envoyer des messages à partir de la page du record d'eOrientation
  • La messagerie dans l'eOrientation permet à l'expéditeur et au spécialiste de communiquer au sujet de l'eOrientation. Par exemple, le spécialiste peut demander de l'information supplémentaire avant d'accepter l'eOrientation ou l'expéditeur peut s'informer du traitement auprès du spécialiste.
  • Par défaut, Ocean désactive le panneau de messagerie pour les expéditeurs et les destinataires, de sorte qu'ils n'ont pas accès à la saisie ou à l'envoi de messages sur les eOrientations envoyées à une liste d'annuaire configurée avec une intégration API.
  • Cette permission doit être activée si l'intégration prend en charge la messagerie ou si la messagerie n'a pas besoin d'être stockée dans le système en aval dans le cadre de l'eOrientation. Qu'elle soit activée ou non, les messages peuvent toujours être envoyés via l'intégration API.
Ajouter des pièces jointes aux messages dans la page du record d'eOrientation
  • Certains sites avec une intégration API qui prennent en charge la messagerie ne prennent pas en charge le stockage et la gestion des pièces jointes.
  • Par défaut, la fonctionnalité « Ajouter la pièce jointe » est cachée à moins qu'elle ne soit activée, ce qui empêche les utilisateurs du Portail d'ajouter des pièces jointes à un message.
Ajouter des notes sur la page du record d'eOrientation
  • Les utilisateurs Ocean peuvent ajouter des notes à l'eOrientation afin d'aider les autres utilisateurs à comprendre comment l'eOrientation est traitée.
  • Lorsqu'une intégration API est en place, cette fonctionnalité est désactivée par défaut. Le système en aval peut prendre en charge une fonctionnalité de notes en interne ou ne souhaite pas recevoir de mises à jour liées aux notes.
Mettre à jour la démographie du patient dans la page du record d'eOrientation
  • La démographie du patient peut être mise à jour dans le Portail Ocean après l'envoi initial de l'eOrientation. Cela peut ajouter de la complexité pour un système en aval intégré en ce qui concerne la gestion des records (scénarios de fusion/séparation de patients).
  • Par défaut, la fonctionnalité de mise à jour est cachée pour les eOrientations associées à une liste d'annuaire ayant une intégration API, ce qui masque le bouton de modification à côté de la démographie du patient pour les expéditeurs et les destinataires, de sorte qu'ils n'ont pas accès à la modification de la démographie sur les eOrientations envoyées à une liste configurée avec cette intégration.
Annuler l'eOrientation
  • Les expéditeurs d'eOrientation peuvent annuler l'eOrientation dans le Portail Ocean (par exemple, le patient n'a plus besoin du service). Cette fonctionnalité est désactivée pour les sites avec une intégration API car elle ajoute de la complexité à la gestion de l'eOrientation dans le système en aval intégré.
  • Si activée, Ocean enverra une notification webhook lorsque l'eOrientation aura été annulée dans le Portail.
Transférer l'eOrientation à un autre site dans le Portail Ocean
  • Les eOrientations peuvent être transférées d'un site Ocean à un autre. Par exemple, un site de réception centralisée transférera une eOrientation à un fournisseur de services.
  • Cette fonctionnalité est désactivée par défaut (l'option « Transférer » est cachée dans le Menu d'action pour les spécialistes) pour les sites avec une intégration API, car elle ajoute de la complexité à la gestion de l'eOrientation dans le système en aval intégré.
  • Lorsqu'elle est activée, les spécialistes peuvent transférer manuellement l'eOrientation dans le Portail Ocean; il n'y a actuellement aucun support API pour le transfert. (Note : Les expéditeurs ne peuvent pas transférer les eOrientations.)
Mettre à jour le résumé du formulaire de référence
  • La section Résumé du formulaire de référence contient le contenu du formulaire de référence qui a été soumis par l'expéditeur.
  • Par défaut, lorsqu'une intégration API est présente, Ocean masque le bouton de modification à côté du Résumé du formulaire de référence pour les expéditeurs, de sorte qu'ils n'ont pas accès à la modification du formulaire sur les eOrientations envoyées à une liste configurée avec cette intégration.
  • Lorsqu'elle est activée, Ocean enverra des mises à jour du contenu de l'eOrientation via l'API chaque fois que le résumé du formulaire de référence aura été mis à jour.

Comportement de l'API

Permettre l'envoi d'une copie de l'eOrientation à ce point de terminaison lorsqu'une nouvelle eOrientation est envoyée à partir de ce site

Lorsqu'une eOrientation est envoyée à partir d'un site ayant une intégration API et que le paramètre « Publier une copie de l'eOrientation (toutes les intégrations) et toutes les mises à jour d'état ultérieures (FHIR v0.11 seulement) à ce point de terminaison lorsqu'une nouvelle eOrientation est envoyée à partir de ce site » est activé, Ocean enverra une copie de l'eOrientation au système de l'expéditeur (il s'agit de l'événement de message FHIR notify-add-service-request et de l'événement de message Open API notify-upstream-service-request).

Cela élimine le besoin pour l'expéditeur de copier-coller manuellement ou de télécharger un PDF du résumé de l'eOrientation dans son système.

Les intégrations utilisant FHIR v11 recevront toutes les mises à jour d'état en amont ultérieures (y compris les rendez-vous et les communications) à ce point de terminaison lorsqu'une nouvelle eOrientation est envoyée à partir de ce site.

Utiliser cette intégration pour les listes d'annuaires créées par API

Cette option applique l'intégration sélectionnée comme point de terminaison par défaut pour les listes créées à l'aide de l'API HealthcareService. Elle ne s'applique pas aux listes créées manuellement.

Vous avez d’autres questions ? Envoyer une demande