Recurso

Órdenes derivadas

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

GET/v1/downstream-orders

List Downstream Orders

Parámetros

NombreEnTipoObl.
sourceTypequerystring o nuloNo
sourceIdquerystring o nuloNo
routeTypequerystring o nuloNo
statusquerystring o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de DownstreamOrderOut
422Error de validaciónHTTPValidationError
POST/v1/downstream-orders

Create Downstream Order

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio DownstreamOrderCreateIn

CampoTipoObl.
sourceTypestring
sourceIdstring
routeTypestring
downstreamProviderIdstring o nuloNo
downstreamProviderNamestring
downstreamProviderTypestring o nuloNo
linkedLabOrderIdstring o nuloNo
linkedImagingOrderIdstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaDownstreamOrderOut
422Error de validaciónHTTPValidationError
PATCH/v1/downstream-orders/{route_id}/status

Update Downstream Order Status

Parámetros

NombreEnTipoObl.
route_idpathstring
tenantIdquerystring o nuloNo

Cuerpo obligatorio DownstreamOrderStatusIn

CampoTipoObl.
downstreamStatusstring
statusNotestring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaDownstreamOrderOut
422Error de validaciónHTTPValidationError
GET/v1/orders-routing/destinations

List Order Destinations

CR-27.2 apoyo — destinos asignables para un routeType: usuarios proveedores del tenant (farmacia/lab/imágenes) + sitios de red de centros alcanzables que soporten el servicio. Alimenta el selector de asignación del hub.

Parámetros

NombreEnTipoObl.
routeTypequerystring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de OrderDestinationOut
422Error de validaciónHTTPValidationError
POST/v1/orders-routing/events

Receive Order Status Event

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio OrderStatusEventIn

CampoTipoObl.
orderIdstring
eventTypestring
externalIdstring o nuloNo
idempotencyKeystring
nextStatusstring o nuloNo
externalStatusstring o nuloNo
notestring o nuloNo
sourcestringNo
payloadobjectNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaOrderStatusEventOut
422Error de validaciónHTTPValidationError
POST/v1/orders-routing/events/{event_id}/retry

Retry Order Status Event

Parámetros

NombreEnTipoObl.
event_idpathstring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaOrderStatusEventOut
422Error de validaciónHTTPValidationError
PATCH/v1/orders-routing/exceptions/{exception_id}/resolve

Resolve Order Exception

Parámetros

NombreEnTipoObl.
exception_idpathstring
tenantIdquerystring o nuloNo

Cuerpo opcional ExceptionResolveIn o nulo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaOrderMonitoringOut
422Error de validaciónHTTPValidationError
GET/v1/orders-routing/monitoring

List Order Monitoring

Parámetros

NombreEnTipoObl.
slaStatusquerystring o nuloNo
statusquerystring o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de OrderMonitoringOut
422Error de validaciónHTTPValidationError
GET/v1/orders-routing/orders

List Unified Orders

Parámetros

NombreEnTipoObl.
patientIdquerystring o nuloNo
sourceTypequerystring o nuloNo
routeTypequerystring o nuloNo
statusquerystring o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de UnifiedOrderOut
422Error de validaciónHTTPValidationError
POST/v1/orders-routing/orders

Create Unified Order

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio UnifiedOrderCreateIn

CampoTipoObl.
sourceTypestring
sourceIdstring
patientIdstring o nuloNo
doctorIdstring o nuloNo
routeTypestring
destinationIdstring o nuloNo
statusstringNo
prioritystringNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaUnifiedOrderOut
422Error de validaciónHTTPValidationError
GET/v1/orders-routing/orders/{order_id}

Get Unified Order

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaUnifiedOrderOut
422Error de validaciónHTTPValidationError
PATCH/v1/orders-routing/orders/{order_id}/accept

Accept Provider Queue Order

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Cuerpo opcional ProviderQueueActionIn o nulo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaProviderQueueOrderOut
422Error de validaciónHTTPValidationError
PATCH/v1/orders-routing/orders/{order_id}/assign

Assign Unified Order

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Cuerpo obligatorio AssignOrderIn

CampoTipoObl.
destinationIdstring
assignmentReasonstring
routeTypestring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaOrderRoutingOut
422Error de validaciónHTTPValidationError
PATCH/v1/orders-routing/orders/{order_id}/cancel

Cancel Provider Queue Order

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Cuerpo opcional ProviderQueueActionIn o nulo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaProviderQueueOrderOut
422Error de validaciónHTTPValidationError
PATCH/v1/orders-routing/orders/{order_id}/complete

Complete Provider Queue Order

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Cuerpo opcional ProviderQueueActionIn o nulo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaProviderQueueOrderOut
422Error de validaciónHTTPValidationError
POST/v1/orders-routing/orders/{order_id}/notify

Notify Order Participants

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Cuerpo opcional OrderNotifyIn o nulo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaOrderNotifyOut
422Error de validaciónHTTPValidationError
POST/v1/orders-routing/orders/{order_id}/route

Route Unified Order

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Cuerpo opcional RouteOrderIn o nulo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaOrderRoutingOut
422Error de validaciónHTTPValidationError
PATCH/v1/orders-routing/orders/{order_id}/start

Start Provider Queue Order

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Cuerpo opcional ProviderQueueActionIn o nulo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaProviderQueueOrderOut
422Error de validaciónHTTPValidationError
PATCH/v1/orders-routing/orders/{order_id}/status

Update Unified Order Status

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Cuerpo obligatorio UnifiedOrderStatusIn

CampoTipoObl.
statusstring
statusNotestring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaUnifiedOrderOut
422Error de validaciónHTTPValidationError
GET/v1/orders-routing/orders/{order_id}/timeline

Get Order Timeline

Parámetros

NombreEnTipoObl.
order_idpathstring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de OrderStatusEventOut
422Error de validaciónHTTPValidationError
GET/v1/orders-routing/provider-queue

List Provider Queue

Parámetros

NombreEnTipoObl.
statusquerystring o nuloNo
priorityquerystring o nuloNo
olderThanquerystring (date-time) o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de ProviderQueueOrderOut
422Error de validaciónHTTPValidationError
GET/v1/orders-routing/rules

List Order Routing Rules

Parámetros

NombreEnTipoObl.
routeTypequerystring o nuloNo
activeOnlyquerybooleanNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de RoutingRuleOut
422Error de validaciónHTTPValidationError