Worklist API v1

ProcedureController API Documentation

Este módulo permite consultar la lista y el detalle de procedimientos médicos (estudios) registrados en la plataforma RIS/PACS.

Endpoints

Base Path

Todos los endpoints están prefijados con /api/v1/procedures.

Global Standards

Consulte Common.md para detalles sobre:

Attributes (Procedure)

  • code: string, código identificador del procedimiento (ej: RX-TOR-001, CT-ABD-002)
  • name: string, nombre o descripción corta del procedimiento médico (ej: Radiografía de Tórax AP y Lateral)
  • modality: string, modalidad médica asociada (ej: RX, CT, MRI, US, MG)
  • body_part: string, código de la parte del cuerpo asociada (obtenido de la relación con bodyParts, ej: CHEST, ABDOMEN, HEAD)
  • created_at: string datetime, fecha y hora de creación del registro
  • updated_at: string datetime, fecha y hora de última actualización

Filtros Disponibles

  • filter[code]: Código del procedimiento (exacto)
  • filter[name]: Nombre del procedimiento (búsqueda parcial / LIKE)
  • filter[modality]: Modalidad asociada por etiqueta/tag (exacto)
  • filter[created_at]: Fecha de creación (rango o fecha exacta)
  • filter[updated_at]: Fecha de actualización

Endpoints Detail

GET /api/v1/procedures

Obtiene una lista paginada de procedimientos médicos disponibles.

Response 200 OK 
{
  "data": [
    {
      "code": "RX-TOR-001",
      "name": "Radiografía de Tórax AP y Lateral",
      "modality": "RX",
      "body_part": "CHEST",
      "created_at": "2026-01-15 10:00:00",
      "updated_at": "2026-01-15 10:00:00"
    },
    {
      "code": "CT-ABD-002",
      "name": "Tomografía Computarizada de Abdomen con Contraste",
      "modality": "CT",
      "body_part": "ABDOMEN",
      "created_at": "2026-01-16 11:30:00",
      "updated_at": "2026-01-16 11:30:00"
    }
  ],
  "_links": {
    "self": { "href": "http://worklist.dicomline.com/api/v1/procedures?page=1" },
    "first": { "href": "http://worklist.dicomline.com/api/v1/procedures?page=1" },
    "last": { "href": "http://worklist.dicomline.com/api/v1/procedures?page=1" }
  },
  "_meta": {
    "totalCount": 2,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}
GET /api/v1/procedures/{id}

Obtiene la información detallada de un procedimiento médico específico por su ID.

Response 200 OK 
{
  "code": "RX-TOR-001",
  "name": "Radiografía de Tórax AP y Lateral",
  "modality": "RX",
  "body_part": "CHEST",
  "created_at": "2026-01-15 10:00:00",
  "updated_at": "2026-01-15 10:00:00"
}

Respuestas adicionales:

  • 404 Not Found: Si no existe un procedimiento con el ID especificado.

Notas Finales

  • Consulte Common.md para los códigos de estado y la estructura de errores globales.
  • Los resultados están limitados a los datos autorizados para la clave API utilizada.