Saltar al contenido principal

Guía de patrones de conectores

Utilice este patrón de ingeniería al agregar o revisar un nodo de conector de terceros. La guía completa, con el esqueleto de Go y la lista de verificación de PR, es tietai-hydra-platform/docs/CONNECTOR_PATTERN_GUIDE.md.

Dos patrones​

PatrónDóndeUtilizar cuando
A: node handlerpkg/node/handlers/<vendor>_node.goEl proveedor dispone de una API REST, FHIR o GraphQL multioperación. El nodo tiene su propia configuración operation Casi todos los conectores de EHR utilizan esta configuración.
B: driverpkg/connector/<type>/ implementando connector.Driver (Connect, Disconnect, Test, Metadata, Read, Write)La fuente es un conjunto uniforme de registros (S3, GCS, exportación masiva FHIR). El nodo de la canalización se genera automáticamente y se denomina <driver-type>-connector.

Qué patrón proporciona un conector​

Cada conector es un nodo, por lo que su contrato es el esquema del nodo (Schema()), que devuelve la API del catálogo:

Campo de esquemaRequisito
ID, Name, DescriptionEl ID es el tipo de nodo: en minúsculas, separado por guiones (por ejemplo webdoc-carasent).
Categoryehr para cada conector específico del proveedor, incluidos los nodos SAP. Los nodos de estándares genéricos (cliente FHIR, consulta FHIR, CRUD FHIR) son healthcare.
Inputs, OutputsPuertos tipados. Las salidas normalmente utilizan la envolvente compartida result / metadata / success.
ConfigCada configuración, con etiqueta, descripción, grupo (basic, auth o advanced), valores predeterminados y permitidos.
Compliance, Capabilities, UseCases, ConfigHighlights, PerformanceTierMetadatos descriptivos que se muestran en el catálogo y que utiliza el Copilot.
ErrorCodesCondiciones de error conocidas. La guía solicita al menos <VENDOR>_AUTH_FAILED y <VENDOR>_REQUEST_FAILED.

El conector también debe estar registrado en pkg/node/handlers/registry.go y listado en inferCategory() en internal/api/rest/nodecatalog_handlers.go.

Reglas de autenticación​

  • Declara cada token, clave o contraseña como un campo de configuración de tipo secret El formulario de configuración muestra los campos secret como entradas secretas, y las instantáneas de configuración de ejecución los almacenan enmascarados.
  • Estilos de autenticación en uso actualmente: HTTP Básico (Acuity, Cliniko), token Bearer (Dentally, EasyPractice, Kaddio, WebDoc, Avon), encabezado de proveedor (Semble x-token, Sensei X-Sensei-Api-Key, EXACT X-API-Key, Muntra Bearer plus X-API-Key) y credenciales de cliente OAuth2 (Epic, Cerner, athenahealth, athenaPractice, DIPS, Nextech, Allscripts, Dedalus, EMIS, MAXIMS). Consulte el Directorio de conectores para obtener información detallada sobre cada conector.

Forma de salida​

Un conector REST genérico devuelve:

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

success es verdadero solo para una respuesta 2xx. Los nodos posteriores dependen de esta forma, así que créela con el auxiliar compartido wrapJSONResponse en lugar de inventar uno nuevo.

Lista de verificación de la documentación​

Cuando se agrega o se modifica un conector, actualice:

  1. Directorio de conectores
  2. Índice de nodos del conector EHR
  3. Los documentos por nodo bajo tietai-hydra-platform/docs/nodes/ehr/<id>/ (design.md, technical.md, usage.md)
  4. La tabla de índices de conectores en tietai-hydra-platform/docs/CONNECTOR_PATTERN_GUIDE.md

¿Algo no está claro? Envíe sus comentarios sobre la documentación por correo electrónico..