Skip to main content

Obtener Informes por Usuario y Proveedor

Este endpoint permite a un proveedor de salud (Health Provider) recuperar una lista de citas médicas. Si en los parámetros de consulta (query params) se incluye únicamente el providerId, se obtendrán todas las citas asociadas al centro médico. En cambio, si también se incluye un userId, se filtrarán las citas correspondientes únicamente a ese usuario dentro del mismo proveedor.

🔒 Este endpoint requiere autenticación. Consulte la sección de Autenticación para obtener su token y cómo utilizarlo en la cabecera Authorization.

Endpoint​

💡 Importante: Para conocer en detalle los métodos, parámetros requeridos, el formato del body y posibles respuestas, puede consultar la documentación específica en el Portal de desarrolladores o revisar el request configurado en el archivo de Postman previamente compartido.

🔐 Nota: Para obtener el catálogo de HealthAPI, debe autenticarse en ese mismo portal utilizando las credenciales otorgadas.

A continuación se detallan los parámetros necesarios.

Parámetros de Consulta (Query)​

ParámetroTipoObligatorioDescripción
userIdnumberSíIdentificador único del usuario dentro del Health Provider.
providerIdnumberSíIdentificador único del Health Provider.
includeApprovedbooleanNoSi no se incluye, se devuelven todos los informes. Si es true, solo los aprobados. Si es false, solo los no aprobados.
limitnumberNoNúmero máximo de resultados por página. Por defecto es 10. Máximo permitido: 100.
offsetnumberNoPosición desde la cual comenzar a mostrar resultados (basado en índice cero). Por defecto: 0.

📘 Para más detalles, consulte la sección de Paginación.

Ejemplo de Respuesta Exitosa (200 OK)​

{
  "success": true,
  "code": 200,
  "response": [
    {
      "id": 1,
      "doctorId": "123",
      "datetime": "2025-07-01T10:00:00Z",
      "externalAppointmentId": "A100",
      "healthProviderId": "10",
      "medicalReport": "Paciente estable.",
      "appointmentAudio": "audio1.mp3",
      "appointmentDuration": "30",
      "audioTranscriptJson": [
        "Transcripción de audio de la cita 1."
      ],
      "reportExampleId": 101,
      "JSONReport": {
        "summary": "Informe corto"
      }
    },
    {
      "id": 2,
      "doctorId": "124",
      "datetime": "2025-07-01T11:00:00Z",
      "externalAppointmentId": "A101",
      "healthProviderId": "11",
      "medicalReport": "Revisión normal.",
      "appointmentAudio": "audio2.mp3",
      "appointmentDuration": "45",
      "audioTranscriptJson": [
        "Transcripción de audio de la cita 2."
      ],
      "reportExampleId": 102,
      "JSONReport": {
        "summary": "Informe breve"
      }
    }
  ]
}