Recurso

HL7

13 operaciones · base https://api.bestdoctorsrd.com

GET/v1/hl7/endpoints

List Endpoints

Parámetros

NombreEnTipoObl.
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de object
422Error de validaciónHTTPValidationError
POST/v1/hl7/endpoints

Create Endpoint

Da de alta una conexión. La institución la fija el contexto, no el cuerpo. Que ``tenantId`` no sea un campo del contrato es deliberado: si viniera en el cuerpo habría que comprobarlo contra el contexto en cada ruta, y el día que alguien olvidara la comprobación el alta sería un endpoint plantado en la institución de otro.

Parámetros

NombreEnTipoObl.
tenant_idquerystring o nuloNo

Cuerpo obligatorio Hl7EndpointIn

CampoTipoObl.
namestring
hoststring
sendingApplicationstring
sendingFacilitystring
receivingApplicationstring
receivingFacilitystring
localAssigningAuthoritystring
descriptionstring o nuloNo
directionstringNo
portintegerNo
sendingFacilityOidstring o nuloNo
receivingFacilityOidstring o nuloNo
platformAssigningAuthoritystringNo
nationalAssigningAuthoritystringNo
passportAssigningAuthoritystringNo
counterpartAssigningAuthoritystring o nuloNo
hl7VersionstringNo
charsetstringNo
countryCodestringNo
processingModestringNo
timezoneOffsetMinutesintegerNo
acceptAcknowledgementTypestringNo
applicationAcknowledgementTypestringNo
outboundMessageTypeslista de stringNo
inboundMessageTypeslista de stringNo
allowedSourceCidrslista de stringNo
sensitiveCompartmentAllowedbooleanNo
tlsEnabledbooleanNo
tlsVerifybooleanNo
tlsCaFilestring o nuloNo
tlsCaPathstring o nuloNo
tlsCertFilestring o nuloNo
tlsKeyFilestring o nuloNo
tlsServerHostnamestring o nuloNo
connectTimeoutSecondsnumberNo
sendTimeoutSecondsnumberNo
ackTimeoutSecondsnumberNo
maxMessageBytesintegerNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaobject
422Error de validaciónHTTPValidationError
GET/v1/hl7/endpoints/{endpoint_id}

Get Endpoint

Parámetros

NombreEnTipoObl.
endpoint_idpathstring
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
PATCH/v1/hl7/endpoints/{endpoint_id}

Update Endpoint

Parámetros

NombreEnTipoObl.
endpoint_idpathstring
tenant_idquerystring o nuloNo

Cuerpo obligatorio Hl7EndpointPatch

CampoTipoObl.
namestring o nuloNo
descriptionstring o nuloNo
statusstring o nuloNo
directionstring o nuloNo
hoststring o nuloNo
portinteger o nuloNo
sendingApplicationstring o nuloNo
sendingFacilitystring o nuloNo
receivingApplicationstring o nuloNo
receivingFacilitystring o nuloNo
sendingFacilityOidstring o nuloNo
receivingFacilityOidstring o nuloNo
localAssigningAuthoritystring o nuloNo
platformAssigningAuthoritystring o nuloNo
nationalAssigningAuthoritystring o nuloNo
passportAssigningAuthoritystring o nuloNo
counterpartAssigningAuthoritystring o nuloNo
hl7Versionstring o nuloNo
charsetstring o nuloNo
countryCodestring o nuloNo
processingModestring o nuloNo
timezoneOffsetMinutesinteger o nuloNo
acceptAcknowledgementTypestring o nuloNo
applicationAcknowledgementTypestring o nuloNo
outboundMessageTypeslista de string o nuloNo
inboundMessageTypeslista de string o nuloNo
allowedSourceCidrslista de string o nuloNo
sensitiveCompartmentAllowedboolean o nuloNo
tlsEnabledboolean o nuloNo
tlsVerifyboolean o nuloNo
tlsCaFilestring o nuloNo
tlsCaPathstring o nuloNo
tlsCertFilestring o nuloNo
tlsKeyFilestring o nuloNo
tlsServerHostnamestring o nuloNo
connectTimeoutSecondsnumber o nuloNo
sendTimeoutSecondsnumber o nuloNo
ackTimeoutSecondsnumber o nuloNo
maxMessageBytesinteger o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
POST/v1/hl7/endpoints/{endpoint_id}/status

Set Endpoint Status

Activa o pausa. Existe además del `PATCH` porque cortar el tráfico durante una ventana de mantenimiento es una operación de un clic, y hacerla depender de un cuerpo JSON invita a mandar de paso campos que nadie quería tocar. Pausar CONSERVA la fila y todo lo que se intercambió por ella. No hay borrado en esta API.

Parámetros

NombreEnTipoObl.
endpoint_idpathstring
statusquerystring
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
POST/v1/hl7/endpoints/{endpoint_id}/test-connection

Test Endpoint Connection

Abre el canal y lo cierra, sin enviar nada. Se puede probar un endpoint **pausado o recién creado**: es justo cuando hace falta. Exigir que estuviera activo obligaría a encender la integración para saber si funciona, que es el orden contrario al que este botón existe para permitir.

Parámetros

NombreEnTipoObl.
endpoint_idpathstring
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
POST/v1/hl7/endpoints/{endpoint_id}/test-message

Send Endpoint Test Message

Manda un `ADT^A08` sintético con `MSH-11` en `T` y espera su confirmación. A diferencia de la prueba de conexión, **esto deja rastro en el sistema de la contraparte**. Es una acción aparte por eso mismo: quien sólo quiere saber si el puerto está abierto no debería tener que escribir en la base de datos de un tercero para averiguarlo.

Parámetros

NombreEnTipoObl.
endpoint_idpathstring
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
GET/v1/hl7/messages

List Messages

El listado. Sin contenido crudo: para eso está el detalle, que sí se audita.

Parámetros

NombreEnTipoObl.
endpointIdquerystring o nuloNo
directionquerystring o nuloNo
messageTypequerystring o nuloNo
statusquerystring o nuloNo
controlIdquerystring o nuloNo
desdequerystring (date-time) o nuloNo
hastaquerystring (date-time) o nuloNo
pagequeryintegerNo
pageSizequeryintegerNo
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
GET/v1/hl7/messages/counters

Message Counters

Pendientes, fallidos y muertos por endpoint. Va declarada ANTES de `/messages/{message_id}`: al revés, FastAPI casaría «counters» con el parámetro de ruta y esto respondería un 404.

Parámetros

NombreEnTipoObl.
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de object
422Error de validaciónHTTPValidationError
GET/v1/hl7/messages/{message_id}

Get Message

El detalle CON el contenido crudo, y por eso auditado. El mensaje lleva nombre, documento y diagnóstico del paciente: leerlo es un acceso a expediente y se anota como tal. La bitácora se escribe aunque la consulta no cambie nada — precisamente por eso: es el único rastro de que alguien lo leyó.

Parámetros

NombreEnTipoObl.
message_idpathstring
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
POST/v1/hl7/messages/{message_id}/discard

Discard Message

Cierra una incidencia de la cola muerta, dejando quién y cuándo.

Parámetros

NombreEnTipoObl.
message_idpathstring
tenant_idquerystring o nuloNo

Cuerpo opcional DescarteIn o nulo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
POST/v1/hl7/messages/{message_id}/retry

Retry Message

Devuelve un mensaje fallido a la cola para el próximo ciclo del emisor. No lo envía aquí: encolar y enviar están separados en toda la integración, y hacer una excepción por venir de un botón abriría un socket a un tercero dentro de una petición HTTP. Lo que esto hace es adelantar la espera.

Parámetros

NombreEnTipoObl.
message_idpathstring
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError
GET/v1/hl7/vocabulary

Endpoint Vocabulary

Los conjuntos de valores que acepta el formulario. Sale del código que los valida, no de una lista copiada en el portal: una versión HL7 que aparezca aquí y no en `SUPPORTED_HL7_VERSIONS` sería un desplegable que ofrece algo que el alta rechaza.

Parámetros

NombreEnTipoObl.
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobject
422Error de validaciónHTTPValidationError