Developer Center
Developer Center
Intégration et transfert structuré des données avec l'API OPAN®.
Avec l'API OPAN® et les interfaces d'intégration, vous pouvez vous connecter à diverses applications, que ce soit en tant qu'institution/organisation de référence ou en tant que prestataire traitant les inscriptions.
Nos options d'implémentation flexibles vous permettent de :
- Intégration native API
- Intégration partielle
- Interface de paramètres URL
Intégration flexible pour une adaptation optimale aux exigences opérationnelles et aux systèmes existants. Augmente l'efficacité et améliore la gestion des données. Une documentation OpenAPI spec toujours à jour, comprenant une collection Postman et des descriptions détaillées des processus, soutient l'implémentation et l'utilisation efficaces des API avec toutes les ressources et instructions nécessaires.
Tirez le meilleur parti de notre plateforme : docs API, tutoriels, astuces de flux de travail, idées d'intégration et mises à jour actuelles - le tout compilé de manière compacte pour vous. Demandez votre compte maintenant et commencez l'intégration !
Vous avez des questions sur l'intégration, les flux de travail et les exigences techniques ? Vous avez un cas d'utilisation spécial ? Planifiez un rendez-vous en ligne sans engagement avec nos développeurs.
Faites partie de notre communauté Slack pour obtenir du support et des informations précieuses pour votre intégration. Réseautez, échangez des connaissances et travaillez ensemble avec des personnes partageant les mêmes idées.
OPAN® API V3 pour les référents (expéditeurs)
L'API OPAN® V3 est conçue pour les institutions de référence telles que les hôpitaux, les cliniques, les cabinets médicaux et autres services de santé afin d'envoyer des données structurées à la plateforme OPAN®. Elle facilite le processus d'orientation des patients qui passent dans des organisations de suivi.
-
Groupe cible : hôpitaux, cliniques, cabinets médicaux et autres organisations de santé qui adressent des patients à des institutions de suivi.
-
Intégration complète de l'API : l'API entièrement intégrable d'OPAN® permet de relier de manière transparente son propre logiciel spécialisé à la plateforme OPAN®. OPAN® peut être entièrement utilisé via l'API et. Cela demande toutefois un effort d'intégration considérable et convient particulièrement aux fournisseurs d'applications.
- Intégration partielle : dans le cas de l'intégration API partielle, les données de base, les documents et les informations sur les commandes sont transmis automatiquement. Le système génère ensuite un hachage et une URL frontale qui dirige l'utilisateur vers l'interface OPAN®. Là, il peut choisir un fournisseur approprié et terminer l'inscription. Une fois la transmission effectuée, toutes les autres interactions, y compris les ajouts et les demandes de statut, peuvent à nouveau être effectuées via l'API. Cette méthode élimine la nécessité d'implémenter des GUI dans l'application métier. De plus, OPAN® prend en charge une grande partie de la logique métier, ce qui réduit considérablement les efforts d'intégration et offre une solution efficace et conviviale pour les développeurs.
Avantages :
- Efficacité : notre API optimise le processus de transfert en transmettant des données structurées.
- Flexibilité : nous proposons des options d'intégration complète et partielle qui permettent des intégrations techniques flexibles et intersystèmes.
-
Convivialité : OPAN® offre une interface utilisateur intuitive pour les interactions, garantissant la facilité d'utilisation et la précision de la saisie des données.
Trouvez plus de détails et de directives d'implémentation dans notre documentation OpenAPI spec, qui comprend des collections Postman et des descriptions détaillées de l'ensemble du processus.
OPAN® API V3 pour les prestataires (destinataires)
L'API OPAN® pour les fournisseurs est conçue pour les organisations et institutions telles que les services d'aide et de soins à domicile, les foyers, les cliniques de rééducation et les hôpitaux psychiatriques qui reçoivent des inscriptions via OPAN®. L'objectif principal est de faciliter la réception de données structurées depuis la plateforme OPAN®.
-
Réception de données : OPAN® permet aux institutions de soins de suite de télécharger et de traiter efficacement les données structurées des inscriptions et des demandes transmises.
-
Données structurées : L'API fournit des informations détaillées et structurées basées sur les champs d'inscription. Plus les données fournies sont nombreuses, plus le traitement dans le système logiciel primaire des institutions de suivi est robuste.
-
Accès aux documents : permet d'accéder facilement aux documents transmis et aux résumés PDF des détails de l'inscription, y compris les commentaires, les notes internes et toutes les interactions pertinentes.
-
Automatisation : permet la mise à jour automatique des informations et des documents transmis ultérieurement, ce qui minimise la charge administrative.
-
Archivage conforme : favorise le stockage à long terme des données chez le client, conformément à la législation, en fournissant des résumés complets.
Trouvez plus de détails et de directives d'implémentation dans notre documentation OpenAPI spec, qui comprend des collections Postman et des descriptions détaillées de l'ensemble du processus.
OPAN® UPI (URL Parameter Interface)
L'interface OPAN® UPI (URL Parameter Interface) offre une méthode simplifiée pour envoyer des données structurées à la plateforme OPAN® à l'aide de paramètres URL. Cette méthode d'intégration est idéale pour une transmission rapide et simple des données avec certaines restrictions.
-
Transmission de données simplifiée : utilise des paramètres URL pour envoyer des données, ce qui facilite la mise en œuvre. La limite de caractères est toutefois fixée à 2048 caractères.
-
Mécanisme Fire-and-Forget : développé pour une transmission unique des données sans besoin de mise à jour de l'état et de référence à l'inscription (backlink).
- Broker UPI : axé sur les fabricants de logiciels pour cabinets médicaux. Dans cette version, la clé API est liée au logiciel de cabinet médical et non au destinataire final. Les utilisateurs doivent sélectionner leur propre cabinet ou organisation lors de la transmission d'une inscription, ce qui permet un transfert de données flexible. Un logiciel de cabinet médical peut ainsi intégrer l'OPAN® UPI de manière générique une fois pour toutes afin de permettre l'accès à tous ses utilisateurs. Ceci est particulièrement performant avec le login HIN, une fonctionnalité prise en charge par la plateforme OPAN®.
Restrictions :
- Principe du "fire and forget" : une fois les données envoyées, il n'y a plus d'interaction automatique avec OPAN®. Cela correspond au déroulement du formulaire web classique. Les mises à jour de statut ou les retours automatiques ne sont pas disponibles dans ce mode. Il n'existe pas de lien retour direct vers l'application d'origine.
-
Téléchargement limité de documents : L'interface de paramétrage ne prend pas en charge le téléchargement direct de documents. Pour soumettre des documents, il faut utiliser le formulaire de téléchargement régulier du navigateur. Cela nécessite une étape séparée pour les téléchargements de documents.
Pour accéder à la documentation UPI et utiliser l'OPAN® UPI, vous devez vous inscrire pour un compte développeur.
Questions Fréquemment Posées (FAQ)
Developer Center
-
Wie erhalte ich einen API-Key?
Registrieren Sie sich als Entwickler bei OPAN®. Im Entwickler-Account erhalten Sie Zugriff auf eine Test-Organisation und können den Test-API-Key abrufen. Für die Produktivschaltung, z.B. bei einem Kunden (wenn Sie Softwareanbieter sind), kann der Kunde Ihnen den produktiven API-Key zur Verfügung stellen.
-
Welche Testumgebungen bietet OPAN®?
OPAN® bietet drei relevante System-Instanzen:
- PRODUCTION: Das Livesystem für den produktiven Einsatz.
- TESTING: Testumgebung für Integratoren zur API-Erprobung und für automatisierte Tests. Sie entspricht dem aktuellen Produktivstand.
- STAGING: Abnahmesystem für neue Funktionen vor dem Production-Release. Hier werden Updates getestet und freigegeben.
-
Welche Daten können übermittelt und abgerufen werden?
Über die API können Sie alle Daten und Felder, die im Anmeldeformular enthalten sind, übermitteln oder abrufen.
-
Wie erstelle ich eine Support-Anfrage oder einen Change-Request?
Melden Sie sich mit Ihrem Entwickler-Account an und klicken Sie anschliessend auf das Fragezeichen-Symbol unten rechts im Bildschirm. Darüber können Sie Ihr Anliegen direkt an den OPAN® Service Desk über das integrierte Ticketing-System übermitteln. Der OPAN® Support bearbeitet Ihre Anfrage werktags während den Bürozeiten nach Priorität und Dringlichkeit.