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

Ocean offre une grande flexibilité pour effectuer des mises à jour de la référence et recevoir des notifications tout au long du cycle de vie de la référence. Cela peut introduire de la complexité dans une intégration d'API eRéférence entre Ocean et un système en aval. Cet article décrit ces notifications, paramètres et autorisations afin que les implémenteurs puissent évaluer celles qui peuvent être prises en charge par leur intégration.

  • Les notifications, paramètres et autorisations se trouvent sur la page Admin > Intégrations > eRéférence.
  • Après avoir sélectionné "eRéférence", 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 sa liaison à une ou plusieurs fiches de répertoire.
  • 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 d'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.

    En survolant l'icône avec votre curseur, des détails supplémentaires sur le code d'erreur de réponse qu'Ocean reçoit sont fournis.

Point de Terminaison Webhook

  • Utilisé pour spécifier où Ocean enverra les notifications webhook eRéférence lorsque la référence est mise à jour dans le Portail Ocean.
  • Si le Type de Payload est défini sur Open API, Ocean vérifiera automatiquement si l'URL saisie dans ce champ est valide. Si elle est invalide, un hexagone jaune apparaîtra.

Type de Payload

Ocean propose deux ensembles d'API pour l'intégration eRéférence - les API Open et les API HL7 FHIR. Ce paramètre est utilisé pour 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é. Étant donné que les API FHIR sont basées sur des normes et plus largement adoptées, il est conseillé aux implémentateurs de les utiliser sauf s'il existe une raison spécifique d'utiliser les API ouvertes, comme le lancement de système contextuel.

Lancement de système contextuel

  • Certains cibles de recommandation nécessitent le lancement d'un autre système pendant ou après la création d'une recommandation.
  • L'onglet "Lancement de système de recommandation" dans l'article "Activation des intégrations Ocean" décrit comment configurer un lancement de système de recommandation.

    Note: Cette fonctionnalité n'est disponible que pour des workflows spécifiques. Veuillez soumettre un ticket de support pour vérifier si elle s'applique à votre intégration.

Notifications par courriel

  • Lorsque des mises à jour eRéférence sont effectuées dans le Portail Ocean, Ocean envoie des notifications par courriel. Celles-ci sont décrites dans l'article de support "Où sont envoyés les courriels de notification eConseil et/ou eRéférence?".
  • Par défaut, les mises à jour effectuées via les API ne déclencheront pas de notifications par courriel aux participants de la recommandation. S'ils sont activés, Ocean enverra une notification par courriel aux participants appropriés.

Paramètres de soumission

  • Par défaut, tous les formulaires de recommandation incluent un bouton "Ajouter la pièce jointe" pour télécharger des fichiers.
  • Activer la case à cocher "Empêcher les expéditeurs de recommandation d'inclure des pièces jointes" masque le bouton sur toutes les recommandations initiées vers les listes configurées avec cette intégration. C'est utile si le système en aval ne souhaite pas stocker ou gérer les pièces jointes.

Permissions

Étendez chaque paramètre ci-dessous pour des informations supplémentaires 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 référence.
  • Ces mises à jour d'état sont similaires à celles prises en charge par les API, donc le site doit déterminer s'ils veulent les activer afin que les utilisateurs d'Ocean puissent également gérer la référence dans le Portail Ocean.
Envoyer des messages depuis la page d'enregistrement de l'eRéférence
  • La messagerie au sein de l'eRéférence permet à l'expéditeur et au destinataire de communiquer au sujet de la référence. Par exemple, le destinataire peut demander des informations supplémentaires avant d'accepter la référence ou l'expéditeur pourrait s'informer sur le traitement auprès du destinataire.
  • Par défaut, Ocean désactive le volet de messagerie pour les expéditeurs et les destinataires, afin qu'ils n'aient pas accès pour taper ou envoyer des messages sur les références envoyées à une liste configurée avec une intégration API.
  • Cette autorisation 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 comme partie de la référence dans le système en aval. Que ce soit activé ou non, les messages peuvent toujours être envoyés via l'intégration API.
Ajouter des pièces jointes aux messages dans la page d'enregistrement de l'eRéférence
  • 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 d'enregistrement de l'eRéférence
  • Les utilisateurs d'Ocean peuvent ajouter des notes à la référence qui aident les autres utilisateurs à comprendre comment la référence 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 des mises à jour liées aux notes.
Mettre à jour la démographie du patient dans la page d'enregistrement eRéférence
  • Les données démographiques du patient peuvent être mises à jour dans le Portail Ocean après l'envoi initial de la référence. Cela peut ajouter de la complexité pour un système intégré en aval à prendre en charge en termes de gestion des enregistrements (scénarios de fusion/séparation de patients).
  • Par défaut, la fonction de mise à jour est masquée pour les références associées à une fiche répertoriée dans un annuaire qui a une intégration API, ce qui masque le bouton de modification à côté des données démographiques du patient pour les expéditeurs et les destinataires, de sorte qu'ils n'ont pas accès à la modification des données démographiques sur les références envoyées à une fiche configurée avec cette intégration.
Annuler la référence
  • Les expéditeurs de références peuvent annuler la référence dans le Portail Ocean (par exemple, si 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 des références dans le système intégré en aval.
  • Si activée, Ocean enverra une notification webhook lorsque la référence a été annulée dans le Portail.
Transférer la référence vers un autre site dans le Portail Ocean
  • Les références peuvent être transférées d'un site Ocean à un autre. Par exemple, un site d'admission central transférera une référence à un fournisseur de services.
  • Cette fonctionnalité est désactivée par défaut (l'option "Transférer" est masquée dans le Menu d'action pour les destinataires) pour les sites avec une intégration API, car elle ajoute de la complexité à la gestion des références dans le système intégré en aval.
  • Lorsqu'elle est activée, les destinataires peuvent transférer manuellement la référence 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 références.)
Mettre à jour le résumé du formulaire de recommandation
  • La section du résumé du formulaire de recommandation contient le contenu du formulaire de recommandation 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 recommandation pour les expéditeurs, afin qu'ils n'aient pas accès à la modification du formulaire sur les recommandations envoyées à une liste configurée avec cette intégration.
  • Lorsqu'elle est activée, Ocean enverra des mises à jour de la charge utile de la recommandation via l'API chaque fois que le résumé du formulaire de recommandation aura été mis à jour.

Comportement de l'API

Autoriser l'envoi d'une copie de la référence à ce point de terminaison lorsqu'une nouvelle référence est envoyée à partir de ce site

Lorsqu'une référence est envoyée à partir d'un site qui a une intégration API et que le paramètre "Poster une copie de la référence (toutes les intégrations) et toutes les mises à jour d'état ultérieures (FHIR v0.11 uniquement) à ce point de terminaison lorsqu'une nouvelle référence est envoyée à partir de ce site" est activé, Ocean enverra une copie de la référence au système expéditeur (Il s'agit de l'événement de message de demande de service d'ajout de notification FHIR et de l'événement de message de demande de service en amont de l'API ouverte).

Cela élimine le besoin pour l'expéditeur de copier et coller manuellement ou télécharger un PDF du résumé de la référence dans leur 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 référence est envoyée à partir de ce site.

Utiliser cette intégration pour les listes de répertoires créées par l'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