Zum Hauptinhalt springen

Anschlussmuster-Leitfaden

Verwenden Sie dieses Entwicklungsmuster beim Hinzufügen oder Überprüfen eines Drittanbieter-Connector-Knotens. Die vollständige Anleitung mit Go-Grundgerüst und PR-Checkliste ist tietai-hydra-platform/docs/CONNECTOR_PATTERN_GUIDE.md.

Zwei Muster​

MusterWoVerwenden Sie es, wenn
A: node handlerpkg/node/handlers/<vendor>_node.goDer Anbieter stellt eine REST-, FHIR- oder GraphQL-API mit mehreren Operationen bereit. Der Knoten verfügt über eine eigene operation Einstellung. Nahezu jeder EHR-Konnektor nutzt diese.
B: driverpkg/connector/<type>/ implementiert connector.Driver (Connect, Disconnect, Test, Metadata, Read, Write)Die Quelle ist ein einheitlicher Datensatz (S3, GCS, FHIR Bulk Export). Der Pipeline-Knoten wird automatisch generiert und mit <driver-type>-connector benannt.

Welches Muster ein Verbinder bietet​

Jeder Konnektor ist ein Knoten, daher ist sein Vertrag das Knotenschema (Schema()), das die Katalog-API zurückgibt:

SchemafeldErfordernis
ID, Name, DescriptionDie ID ist der Knotentyp: Kleinbuchstaben, durch Bindestriche getrennt (zum Beispiel webdoc-carasent).
Categoryehr für jeden herstellerspezifischen Konnektor, einschließlich der SAP-Knoten. Generische Standardknoten (FHIR-Client, FHIR-Abfrage, FHIR CRUD) sind healthcare.
Inputs, OutputsTypisierte Ports. Ausgänge verwenden normalerweise den gemeinsamen result / metadata / success -Bereich.
ConfigJede Einstellung mit Bezeichnung, Beschreibung, Gruppe (basic, auth oder advanced), Standard- und zulässigen Werten.
Compliance, Capabilities, UseCases, ConfigHighlights, PerformanceTierBeschreibende Metadaten, die im Katalog angezeigt und vom Copiloten verwendet werden.
ErrorCodesBekannte Fehlerzustände. Die Anleitung verlangt mindestens <VENDOR>_AUTH_FAILED und <VENDOR>_REQUEST_FAILED.

Der Konnektor muss auch in pkg/node/handlers/registry.go registriert und in inferCategory() in internal/api/rest/nodecatalog_handlers.go aufgeführt sein.

Authentifizierungsregeln​

  • Deklarieren Sie jedes Token, jeden Schlüssel oder jedes Passwort als Konfigurationsfeld vom Typ secret Das Konfigurationsformular interpretiert secret Felder als geheime Eingaben, und Konfigurations-Snapshots speichern diese maskiert.
  • Gängige Authentifizierungsmethoden: HTTP Basic (Acuity, Cliniko), Bearer-Token (Dentally, EasyPractice, Kaddio, WebDoc, Avon), Vendor-Header (Semble x-token, Sensei X-Sensei-Api-Key, EXACT X-API-Key, Muntra Bearer plus X-API-Key) und OAuth2-Client-Anmeldeinformationen (Epic, Cerner, athenahealth, athenaPractice, DIPS, Nextech, Allscripts, Dedalus, EMIS, MAXIMS). Detaillierte Informationen zu den einzelnen Konnektoren finden Sie im Konnektorverzeichnis.

Ausgabeform​

Ein generischer REST-Connector gibt Folgendes zurück:

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

success trifft nur für eine 2xx-Antwort zu. Nachgelagerte Knoten sind von dieser Struktur abhängig; verwenden Sie daher den gemeinsam genutzten Helfer wrapJSONResponse anstatt einen neuen zu erstellen.

Checkliste für die Dokumentation​

Wenn ein Konnektor hinzugefügt oder geändert wird, aktualisieren Sie ihn:

  1. Konnektorverzeichnis
  2. EHR-Connector-Knotenindex
  3. Die Dokumente pro Knoten unter tietai-hydra-platform/docs/nodes/ehr/<id>/ (design.md, technical.md, usage.md)
  4. Die Konnektorenindextabelle in tietai-hydra-platform/docs/CONNECTOR_PATTERN_GUIDE.md

Etwas unklar? Senden Sie Feedback zur Dokumentation per E-Mail..