13 operaciones · base https://api.bestdoctorsrd.com
GET/v1/hl7/endpoints
List Endpoints
Parámetros
Nombre
En
Tipo
Obl.
tenant_id
query
string o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
lista de object
422
Error de validación
HTTPValidationError
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
Nombre
En
Tipo
Obl.
tenant_id
query
string o nulo
No
Cuerpo obligatorioHl7EndpointIn
Campo
Tipo
Obl.
name
string
Sí
host
string
Sí
sendingApplication
string
Sí
sendingFacility
string
Sí
receivingApplication
string
Sí
receivingFacility
string
Sí
localAssigningAuthority
string
Sí
description
string o nulo
No
direction
string
No
port
integer
No
sendingFacilityOid
string o nulo
No
receivingFacilityOid
string o nulo
No
platformAssigningAuthority
string
No
nationalAssigningAuthority
string
No
passportAssigningAuthority
string
No
counterpartAssigningAuthority
string o nulo
No
hl7Version
string
No
charset
string
No
countryCode
string
No
processingMode
string
No
timezoneOffsetMinutes
integer
No
acceptAcknowledgementType
string
No
applicationAcknowledgementType
string
No
outboundMessageTypes
lista de string
No
inboundMessageTypes
lista de string
No
allowedSourceCidrs
lista de string
No
sensitiveCompartmentAllowed
boolean
No
tlsEnabled
boolean
No
tlsVerify
boolean
No
tlsCaFile
string o nulo
No
tlsCaPath
string o nulo
No
tlsCertFile
string o nulo
No
tlsKeyFile
string o nulo
No
tlsServerHostname
string o nulo
No
connectTimeoutSeconds
number
No
sendTimeoutSeconds
number
No
ackTimeoutSeconds
number
No
maxMessageBytes
integer
No
Respuestas
Código
Descripción
Devuelve
201
Respuesta correcta
object
422
Error de validación
HTTPValidationError
GET/v1/hl7/endpoints/{endpoint_id}
Get Endpoint
Parámetros
Nombre
En
Tipo
Obl.
endpoint_id
path
string
Sí
tenant_id
query
string o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
object
422
Error de validación
HTTPValidationError
PATCH/v1/hl7/endpoints/{endpoint_id}
Update Endpoint
Parámetros
Nombre
En
Tipo
Obl.
endpoint_id
path
string
Sí
tenant_id
query
string o nulo
No
Cuerpo obligatorioHl7EndpointPatch
Campo
Tipo
Obl.
name
string o nulo
No
description
string o nulo
No
status
string o nulo
No
direction
string o nulo
No
host
string o nulo
No
port
integer o nulo
No
sendingApplication
string o nulo
No
sendingFacility
string o nulo
No
receivingApplication
string o nulo
No
receivingFacility
string o nulo
No
sendingFacilityOid
string o nulo
No
receivingFacilityOid
string o nulo
No
localAssigningAuthority
string o nulo
No
platformAssigningAuthority
string o nulo
No
nationalAssigningAuthority
string o nulo
No
passportAssigningAuthority
string o nulo
No
counterpartAssigningAuthority
string o nulo
No
hl7Version
string o nulo
No
charset
string o nulo
No
countryCode
string o nulo
No
processingMode
string o nulo
No
timezoneOffsetMinutes
integer o nulo
No
acceptAcknowledgementType
string o nulo
No
applicationAcknowledgementType
string o nulo
No
outboundMessageTypes
lista de string o nulo
No
inboundMessageTypes
lista de string o nulo
No
allowedSourceCidrs
lista de string o nulo
No
sensitiveCompartmentAllowed
boolean o nulo
No
tlsEnabled
boolean o nulo
No
tlsVerify
boolean o nulo
No
tlsCaFile
string o nulo
No
tlsCaPath
string o nulo
No
tlsCertFile
string o nulo
No
tlsKeyFile
string o nulo
No
tlsServerHostname
string o nulo
No
connectTimeoutSeconds
number o nulo
No
sendTimeoutSeconds
number o nulo
No
ackTimeoutSeconds
number o nulo
No
maxMessageBytes
integer o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
object
422
Error de validación
HTTPValidationError
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.
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
Nombre
En
Tipo
Obl.
endpoint_id
path
string
Sí
tenant_id
query
string o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
object
422
Error de validación
HTTPValidationError
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
Nombre
En
Tipo
Obl.
endpoint_id
path
string
Sí
tenant_id
query
string o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
object
422
Error de validación
HTTPValidationError
GET/v1/hl7/messages
List Messages
El listado. Sin contenido crudo: para eso está el detalle, que sí se audita.
Parámetros
Nombre
En
Tipo
Obl.
endpointId
query
string o nulo
No
direction
query
string o nulo
No
messageType
query
string o nulo
No
status
query
string o nulo
No
controlId
query
string o nulo
No
desde
query
string (date-time) o nulo
No
hasta
query
string (date-time) o nulo
No
page
query
integer
No
pageSize
query
integer
No
tenant_id
query
string o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
object
422
Error de validación
HTTPValidationError
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
Nombre
En
Tipo
Obl.
tenant_id
query
string o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
lista de object
422
Error de validación
HTTPValidationError
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
Nombre
En
Tipo
Obl.
message_id
path
string
Sí
tenant_id
query
string o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
object
422
Error de validación
HTTPValidationError
POST/v1/hl7/messages/{message_id}/discard
Discard Message
Cierra una incidencia de la cola muerta, dejando quién y cuándo.
Parámetros
Nombre
En
Tipo
Obl.
message_id
path
string
Sí
tenant_id
query
string o nulo
No
Cuerpo opcionalDescarteIn o nulo
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
object
422
Error de validación
HTTPValidationError
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
Nombre
En
Tipo
Obl.
message_id
path
string
Sí
tenant_id
query
string o nulo
No
Respuestas
Código
Descripción
Devuelve
200
Respuesta correcta
object
422
Error de validación
HTTPValidationError
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.