Aller au contenu principal

Guide des modèles de connecteurs

Utilisez ce modèle d'ingénierie lors de l'ajout ou de la révision d'un nœud de connecteur tiers. Le guide complet, avec le squelette Go et la liste de contrôle des demandes de fusion, est tietai-hydra-platform/docs/CONNECTOR_PATTERN_GUIDE.md.

Deux modèles​

ModèleOùÀ utiliser lorsque
A: node handlerpkg/node/handlers/<vendor>_node.goLe fournisseur propose une API REST, FHIR ou GraphQL multi-opérations. Le nœud possède son propre paramètre operation Presque tous les connecteurs de dossiers médicaux électroniques (DME) utilisent cette méthode.
B: driverpkg/connector/<type>/ implémentant connector.Driver (Connect, Disconnect, Test, Metadata, Read, Write)La source est un ensemble uniforme d'enregistrements (S3, GCS, FHIR Bulk Export). Le nœud du pipeline est généré automatiquement et nommé <driver-type>-connector.

Quel modèle fournit un connecteur ?​

Chaque connecteur est un nœud, son contrat est donc le schéma du nœud (Schema()), que l'API du catalogue renvoie :

Champ de schémaExigence
ID, Name, DescriptionL'identifiant correspond au type de nœud : en minuscules, séparés par des tirets (par exemple webdoc-carasent).
Categoryehr pour chaque connecteur spécifique au fournisseur, y compris les nœuds SAP. Les nœuds standards génériques (client FHIR, requête FHIR, CRUD FHIR) sont healthcare.
Inputs, OutputsPorts typés. Les sorties utilisent normalement l' success metadata result
ConfigChaque paramètre, avec étiquette, description, groupe (basic, auth ou advanced), valeurs par défaut et valeurs autorisées.
Compliance, Capabilities, UseCases, ConfigHighlights, PerformanceTierMétadonnées descriptives affichées dans le catalogue et utilisées par le copilote.
ErrorCodesConditions d'erreur connues. Le guide demande au moins <VENDOR>_AUTH_FAILED et <VENDOR>_REQUEST_FAILED.

Le connecteur doit également être enregistré dans pkg/node/handlers/registry.go et répertorié dans inferCategory() dans internal/api/rest/nodecatalog_handlers.go.

Règles d'authentification​

  • Déclarez chaque jeton, clé ou mot de passe comme un champ de configuration de type secret Le formulaire de configuration affiche les champs secret comme des entrées secrètes, et les instantanés de configuration les stockent masqués.
  • Méthodes d'authentification actuellement utilisées : HTTP Basic (Acuity, Cliniko), jeton Bearer (Dentally, EasyPractice, Kaddio, WebDoc, Avon), en-tête fournisseur (Semble x-token, Sensei X-Sensei-Api-Key, EXACT X-API-Key, Muntra Bearer plus X-API-Key) et identifiants client OAuth2 (Epic, Cerner, athenahealth, athenaPractice, DIPS, Nextech, Allscripts, Dedalus, EMIS, MAXIMS). Consultez le répertoire des connecteurs pour plus de détails.

Forme de sortie​

Un connecteur REST générique renvoie :

{
"result": "parsed JSON body, or {\"raw\": \"...\"}",
"metadata": { "operation": "...", "status_code": 200, "content_length": 123 },
"success": true
}

La valeur success n'est vraie que pour une réponse 2xx. Les nœuds en aval dépendent de cette structure ; il est donc préférable de la construire avec l'utilitaire partagé wrapJSONResponse plutôt que d'en créer une nouvelle.

Liste de contrôle de la documentation​

Lorsqu'un connecteur est ajouté ou modifié, mettez à jour :

  1. Répertoire des connecteurs
  2. Index des nœuds du connecteur EHR
  3. La documentation par nœud sous tietai-hydra-platform/docs/nodes/ehr/<id>/ (design.md, technical.md, usage.md)
  4. Le tableau d'index des connecteurs dans tietai-hydra-platform/docs/CONNECTOR_PATTERN_GUIDE.md

Quelque chose n'est pas clair ? Envoyez vos commentaires sur la documentation par courriel.