Worklist API v1

WorklistController API Documentation

Este módulo permite gestionar worklists en el sistema.

Endpoints

Base Path

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

Global Standards

Consulte Common.md para detalles sobre:

  • Autenticación
  • Paginación y Ordenamiento
  • Estructura global de errores

Attributes (Worklist)

  • id: integer, identificador único (solo lectura)
  • order_id: integer (requerido, exacto)
  • accession_number: string (requerido, exacto)
  • referring_physician: string (búsqueda parcial)
  • performing_physician: string (búsqueda parcial)
  • modality: string (requerido, exacto)
  • exam_date_and_time: string (ISO 8601 datetime)
  • exam_room: string (parcial)
  • exam_description: string (parcial)
  • study_instance_uid: string (requerido)
  • procedure_step_id: string
  • scheduled_aet: string
  • status: string (ORDERED, SCHEDULED, IN_PROGRESS, COMPLETED, CANCELED)
  • created_at: string datetime (solo lectura)
  • updated_at: string datetime (solo lectura)

Filtros Adicionales

  • filter[id]: ID del elemento (exacto)
  • filter[order_id]: ID de la orden (exacto)
  • filter[accession_number]: Accession number (exacto)
  • filter[referring_physician]: Médico remitente (parcial)
  • filter[performing_physician]: Médico ejecutante (parcial)
  • filter[modality]: Modalidad (exacto)
  • filter[exam_date_and_time]: Fecha y hora del examen (exacto)
  • filter[exam_room]: Sala/ubicación (parcial)
  • filter[exam_description]: Descripción del examen (parcial)
  • filter[study_instance_uid]: Identificador de estudio (exacto)
  • filter[procedure_step_id]: Código de paso de procedimiento (exacto)
  • filter[scheduled_aet]: AET programado (exacto)
  • filter[date]: Fecha del examen YYYY-MM-DD (exacto)
  • filter[patient_id]: Número de identificación del paciente (exacto)
  • filter[status]: Estado de la orden (exacto)

Endpoints Detail

GET /api/v1/worklists

Obtiene una lista paginada de worklists.

Response 200 OK 
{
  "data": [
    {
      "id": 1,
      "order_id": 10,
      "accession_number": "2024001",
      "referring_physician": "Dr. House",
      "performing_physician": "Dr. Strange",
      "modality": "CT",
      "exam_date_and_time": "2024-01-01T10:00:00-05:00",
      "exam_room": "Sala A",
      "exam_description": "TAC de abdomen",
      "study_instance_uid": "1.2.3.4.5.6",
      "status": "SCHEDULED",
      "created_at": "2024-01-01 08:00:00"
    }
  ],
  "_links": {
    "self": { "href": "http://worklist.dicomline.com/api/v1/worklists?page=1" },
    "first": { "href": "http://worklist.dicomline.com/api/v1/worklists?page=1" },
    "last": { "href": "http://worklist.dicomline.com/api/v1/worklists?page=1" }
  },
  "_meta": {
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}
POST /api/v1/worklists

Crea un nuevo elemento en la worklist.

Campos requeridos: order_id, accession_number

Request Body (JSON)
{
  "order_id": 10,
  "accession_number": "2024001",
  "modality": "CT",
  "exam_date_and_time": "2024-01-01T10:00:00-05:00"
}
Response 201 Created 
{
  "id": 1,
  "order_id": 10,
  "accession_number": "2024001",
  "modality": "CT",
  "exam_date_and_time": "2024-01-01T10:00:00-05:00",
  "study_instance_uid": "1.2.3.4.5.6",
  "status": "SCHEDULED",
  "created_at": "2024-01-01 08:00:00"
}

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.