Skip to main content

Crear Nueva Plantilla de Informe

Este endpoint permite crear una nueva plantilla de informe médico. La plantilla puede asociarse directamente a un usuario específico mediante su userId, en cuyo caso solo estará disponible para ese usuario. Alternativamente, puede asociarse al proveedor de salud mediante el providerId, lo que hará que esté disponible para todos los usuarios vinculados a ese 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.

Cuerpo de la Solicitud (application/json)​

Caso 1: Crear plantilla asociada directamente al providerId​

{
  "providerId": 123,   // ID del hospital, proporcionado previamente por el equipo de Speaknosis.
  "name": "Consulta General Adulto",   // Nombre del template.
  "body": "### Consulta\nDolor abdominal.",   // Contenido del template en formato Markdown.
  "type": 0,   // Tipo de template: 0 para consulta médica, 1 para cirugía.
  "description": "Template básico para consulta médica general en adultos.",   // Descripción del template.
  "specialityId": 1   // ID de la especialidad médica asociada al template.
}

Caso 2: Crear plantilla asociada a un userId​

{
  "providerId": 123,   // ID del hospital, proporcionado previamente por el equipo de Speaknosis.
  "userId": "1052",   // ID del usuario.
  "name": "Consulta General Adulto",   // Nombre del template.
  "body": "### Consulta\nDolor abdominal.",   // Contenido del template en formato Markdown.
  "type": 0,   // Tipo de template: 0 para consulta médica, 1 para cirugía.
  "description": "Template básico para consulta médica general en adultos.",   // Descripción del template.
  "specialityId": 1   // ID de la especialidad médica asociada al template.
}

Notas sobre los Campos​

Para asignar el specialityId correspondiente, utilice el método Obtener todas las especialidades para consultar las especialidades disponibles junto con sus identificadores.

Campo type​

El campo type indica el tipo de plantilla que se está creando. Los valores permitidos son:

  • 0: Plantilla para informes de consulta médica. Usada para reportes clínicos generales basados en consultas.
  • 1: Plantilla para dictados de cirugía. Usada para informes específicos relacionados con procedimientos quirúrgicos o de dictado.

Ejemplos de Respuesta Exitosa (201 Created)​

Para una plantilla asociada directamente al providerId:

{
  "success": true,
  "code": 201,
  "response": {
    "message": "Success Response",
    "id": 374,
    "name": "Consulta General Adulto",
    "description": "Template básico para consulta médica general en adultos.",
    "type": 0,
    "body": "### Consulta\nDolor abdominal.",
    "specialityId": 1,
    "isValidated": true,
    "ownerType": "HEALTH_PROVIDER",
    "providerId": "123"
  }
}

Para una plantilla asociada a un userId:

{
  "success": true,
  "code": 201,
  "response": {
    "message": "Success Response",
    "id": 375,
    "name": "Consulta General Adulto",
    "description": "Template básico para consulta médica general en adultos.",
    "type": 0,
    "body": "### Consulta\nDolor abdominal.",
    "specialityId": 1,
    "isValidated": true,
    "ownerType": "USER",
    "providerId": "123",
    "userId": "1052"
  }
}