Obtener Plantillas por Usuario o Proveedor

Este endpoint permite obtener las plantillas de reporte médico (reportExamples) asociadas a:

• Un proveedor de salud (providerId), lo que devuelve todas las plantillas del proveedor, sin necesidad de especificar un usuario.
• Un usuario específico (userId) junto con su proveedor de salud (providerId), con la opción de excluir las plantillas generales del proveedor si así se desea.

🔒 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ámetro	Tipo	Obligatorio	Descripción
providerId	number	Sí	Identificador único del Health Provider.
userId	string	No	Identificador único del usuario. Si se incluye, se filtrarán también sus plantillas personalizadas.
excludeProvider	boolean	No	Si se establece en true, se excluirán las plantillas generales del Health Provider. Solo se devolverán las del usuario.
limit	number	No	Número máximo de resultados por página. Por defecto es 10. Máximo permitido: 100.
offset	number	No	Posició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.

---

Casos de uso

✅ Obtener todas las plantillas del Health Provider

GET /reportExample?providerId=123

Ejemplo de Respuesta Exitosa (200 OK):

{
  "success": true,
  "code": 200,
  "response": {
    "data": [
      {
        "id": 501,
        "name": "Consulta Pediátrica Inicial",
        "description": "Plantilla para primera consulta en pacientes pediátricos.",
        "type": 0,
        "specialityId": 2,
        "isValidated": true,
        "ownerType": "HEALTH_PROVIDER",
        "providerId": "123"
      },
      {
        "id": 498,
        "name": "Preoperatorio Cirugía General",
        "description": "Evaluación prequirúrgica estándar para cirugías generales.",
        "type": 1,
        "specialityId": 4,
        "isValidated": true,
        "ownerType": "HEALTH_PROVIDER",
        "providerId": "123"
      },
      {
        "id": 493,
        "name": "Consulta Cardiología",
        "description": "Plantilla estructurada para consultas de cardiología.",
        "type": 0,
        "specialityId": 3,
        "isValidated": true,
        "ownerType": "HEALTH_PROVIDER",
        "providerId": "123"
      }
    ],
    "meta": {
      "total": 3,
      "offset": 0,
      "limit": 10
    }
  }
}

✅ Obtener todas las plantillas del usuario y del Health Provider

GET /reportExample?providerId=123&userId=1051

Ejemplo de Respuesta Exitosa (200 OK):

{
  "success": true,
  "code": 200,
  "response": {
    "data": [
      {
        "id": 601,
        "name": "Consulta Nutricional Inicial",
        "description": "Plantilla utilizada para la primera evaluación nutricional del paciente.",
        "type": 0,
        "specialityId": 5,
        "isValidated": true,
        "ownerType": "USER",
        "providerId": "123",
        "userId": "1051"
      },
      {
        "id": 602,
        "name": "Seguimiento Endocrino",
        "description": "Template para controles de rutina en pacientes con trastornos hormonales.",
        "type": 0,
        "specialityId": 6,
        "isValidated": true,
        "ownerType": "USER",
        "providerId": "123",
        "userId": "1051"
      },
      {
        "id": 603,
        "name": "Preoperatorio Cirugía Ortopédica",
        "description": "Evaluación prequirúrgica para pacientes con indicación ortopédica.",
        "type": 1,
        "specialityId": 7,
        "isValidated": true,
        "ownerType": "HEALTH_PROVIDER",
        "providerId": "123"
      },
      {
        "id": 604,
        "name": "Consulta Dermatología",
        "description": "Plantilla para diagnóstico y tratamiento de afecciones dermatológicas.",
        "type": 0,
        "specialityId": 8,
        "isValidated": true,
        "ownerType": "HEALTH_PROVIDER",
        "providerId": "123"
      }
    ],
    "meta": {
      "total": 4,
      "offset": 0,
      "limit": 10
    }
  }
}

✅ Obtener solo las plantillas del usuario (excluyendo las del Health Provider)

GET /reportExample?providerId=123&userId=1051&excludeProvider=true

Ejemplo de Respuesta Exitosa (200 OK):

{
  "success": true,
  "code": 200,
  "response": {
    "data": [
      {
        "id": 1947,
        "name": "Plantilla Resumida de Control",
        "description": "Template resumido para controles médicos generales.",
        "type": 0,
        "specialityId": 0,
        "isValidated": true,
        "ownerType": "USER",
        "providerId": "123",
        "userId": "1051"
      },
      {
        "id": 101,
        "name": "Plantilla Speaknosis: Consulta Editada",
        "description": "Plantilla para consulta médica con secciones completas para informes clínicos.",
        "type": 0,
        "specialityId": 0,
        "isValidated": true,
        "ownerType": "USER",
        "providerId": "123",
        "userId": "1051"
      }
    ],
    "meta": {
      "total": 2,
      "offset": 0,
      "limit": 10
    }
  }
}

Notas Adicionales

En las respuestas para el endpoint GET /reportExample que incluyen el parámetro userId, el campo ownerType le permitirá identificar si la plantilla pertenece a un usuario (USER) o al proveedor de salud (HEALTH_PROVIDER).