Ocean eRéférence Dépréciation de l'API ouverte
À partir du 3 novembre 2022, l'API ouverte de l'eRéférence Ocean est dépréciée. Les systèmes tiers qui développent de nouvelles intégrations avec les eDemandes Ocean (eRéférence et eConseils) doivent utiliser les API FHIR d'Ocean.
Les API ouvertes d'Ocean permettent aux systèmes tiers de s'intégrer avec Ocean afin que les fournisseurs puissent traiter les références dans leur système ou application préférés. En plus de la documentation de l'API ouverte, nous avons rassemblé les conseils d'implémentation suivants pour accélérer votre intégration.
Séquence d'intégration de l'eRéférence
Le diagramme de séquence ci-dessous illustre la séquence d'interaction entre Ocean et un système tiers après qu'une référence a été créée dans Ocean.
Validation du webhook
- Le webhook nécessite que l'URL réponde à un défi pour fonctionner correctement. Un test avec un webhook qui n'est pas prêt à fournir le jeton de défi dans la réponse échouera à la validation. Cela est indiqué par un symbole d'exclamation jaune à côté de l'URL.
- La vérification de la validation ne nécessite pas les en-têtes spécifiques à Ocean (sitenum, sitekey) dans la réponse, bien qu'ils ne causent aucune erreur s'ils sont inclus. Pour plus d'informations, consultez notre documentation API
Chiffrement de la charge utile
- Le code de chiffrement dans la documentation de l'API Ocean est un exemple qui illustre le flux de chiffrement correct et met en évidence la bibliothèque de chiffrement (CryptoJS) que nous utilisons et recommandons lors du travail en Javascript. Mais le schéma de chiffrement est simplement un chiffrement AES standard, vous pourrez donc absolument chiffrer/déchiffrer ces données dans d'autres langages. Par exemple, pour Ruby, vous pouvez utiliser le module OpenSSL de la bibliothèque standard pour exécuter les chiffrements AES afin de chiffrer et déchiffrer les données. Il existe également probablement d'autres gemmes AES/cryptographiques externes que vous pouvez utiliser si vous avez une préférence.
- ***Lors de la récupération d'une référence, il est recommandé d'utiliser le champ oneTimeKeyEncryptedWithSitePublicKey": (plutôt que le champ oneTimeKeyEncryptedWithTargetPublicKey") afin que votre système puisse également déchiffrer les références qui sont envoyées par les sites Ocean de vos clients (et pas seulement celles qui sont reçues par celui-ci). Consultez la section "Comportement de l'API" de cet article pour plus d'informations sur la réception d'une copie des références envoyées.
Mapping des données
- Le fichier en bas de cet article répertorie les éléments de données disponibles dans les charges utiles de l'API ouverte.
- Si le site permet plusieurs dates de rendez-vous pour une seule référence, la liste des références doit avoir plusieurs étiquettes configurées. Par défaut, Ocean ne permet qu'une seule étiquette pour chaque liste nommée "Rendez-vous". Chaque liste de références (Administrateur du site > Répertoire des listes > Section Détails du service) peut être configurée par l'administrateur du site pour accepter des étiquettes supplémentaires parmi les valeurs suivantes : rendez-vous 1 - 5, date de consultation, date de suivi, date de la première visite, date de la procédure, date de la chirurgie.
- Si un appel API est envoyé avec des données de rendez-vous sans étiquette, alors Ocean attribuera la première étiquette de rendez-vous qui n'a pas été utilisée dans cette référence pour ce rendez-vous. Si un deuxième rendez-vous est envoyé sans étiquette et que toutes les étiquettes de rendez-vous ont déjà été attribuées pour cette référence, l'API renverra une erreur. Alternativement, les données de rendez-vous peuvent être envoyées avec une étiquette de rendez-vous, mais elle doit correspondre à l'une des étiquettes configurées pour ce site.
- Le POST Mettre à jour une référence API accepte les valeurs d'état de référence suivantes dans le champ d'état : Accepté, Refusé, Confirmé, Annulé, Terminé, Imprimé, Incomplet, Envoyé. Le champ est facultatif et ne doit être renseigné que par le système tiers lorsque la valeur d'état de référence est différente de la mise à jour précédente envoyée à Ocean. Ocean renverra une erreur de "La référence est déjà dans l'état demandé" si deux mises à jour sont envoyées avec la même valeur d'état. Par conséquent, si l'ensemble interne de statuts de référence du système tiers est plus détaillé que celui d'Ocean, les mises à jour de référence doivent contenir les informations mises à jour pertinentes sans valeur d'état à moins que cela ne modifie l'état de la référence Ocean.
- La référence est mise à jour à un état "Réservé" en interne par Ocean une fois qu'elle reçoit les données de rendez-vous du système tiers.
- Une fois qu'une référence est dans l'état de référence "Terminé" ou "Annulé", elle ne peut pas revenir à un autre état de référence via l'API.
- Ocean placera une référence dans le dossier "Besoin de révision" lorsqu'un destinataire reçoit un nouveau message (par exemple, le destinataire de la référence envoie un message à l'expéditeur avec des instructions de soins aux patients). Lorsqu'un message est envoyé en utilisant le 'Ajouter un message' endpoint (URL ci-dessous), le NuméroSiteCible doit être renseigné avec le numéro de site du fournisseur qui doit examiner le message afin qu'il soit 'signalé' pour inclusion dans le dossier Besoin de révision.