Skip to main content

Obtener Plantillas por Usuario o Proveedor

# 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ámetroTipoObligatorioDescripción
providerIdnumberSíIdentificador único del Health Provider.
userIdnumberNoIdentificador único del usuario. Si se incluye, se filtrarán también sus plantillas personalizadas.
excludeProviderbooleanNoSi se establece en true, se excluirán las plantillas generales del Health Provider. Solo se devolverán las del usuario.
includeDeletedbooleanNoPor defecto las plantillas eliminadas (soft delete) no se incluyen. Si se establece en true, se incluirán también.
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.

Casos de uso​

✅ Obtener todas las plantillas del Health Provider​


GET /reportExample?providerId=123

✅ Obtener todas las plantillas del usuario y del Health Provider​


GET /reportExample?providerId=123&userId=456

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


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

✅ Incluir plantillas eliminadas (soft delete)​


GET /reportExample?providerId=123&includeDeleted=true

Ejemplo de Respuesta Exitosa (200 OK)​

{
 {
    "success": true,
    "code": 200,
    "response": {
        "data": [
            {
                "id": 1512,
                "name": "Consulta",
                "description": "Consulta Psiquiátrica",
                "specialityId": "1",
                "type": 0,
                "body": "# **Motivo de Consultaaaa**\n\nDescribe en detalle el motivo de la consulta según lo provisto por el paciente, sus familiares o derivación médica.\n\nHistoria Psiquiátrica: describe antecedentes de diagnósticos, hospitalizaciones, tratamientos psiquiátricos previos y evolución de síntomas.\n\nGenograma:"
            },
            {
                "id": 1494,
                "name": "Consulta",
                "description": " Consulta Psiquiátrica",
                "specialityId": "1534",
                "type": 0,
                "body": "# **Motivo de Consultaaaa**\n\nDescribe en detalle el motivo de la consulta según lo provisto por el paciente, sus familiares o derivación médica.\n\nHistoria Psiquiátrica: describe antecedentes de diagnósticos, hospitalizaciones, tratamientos psiquiátricos previos y evolución de síntomas.\n\nGenograma:"
            }
        ],
        "meta": {
            "total": 44,
            "offset": 0,
            "limit": 10
        }
    }
}
}