Actualizar una Plantilla por ID
Este endpoint permite modificar una plantilla de informe médico existente (reportExample
) utilizando su identificador único (id
). Se puede actualizar su nombre, contenido (body
), descripción y tipo.
🔒 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 Ruta
Parámetro | Tipo | Obligatorio | Descripción |
---|---|---|---|
id | number | Sí | Identificador único de la plantilla a actualizar |
Cuerpo de la Solicitud (application/json
)
{
"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.
}
Campo | Tipo | Requerido | Descripción |
---|---|---|---|
name | string | Sí | Nombre de la plantilla. |
body | string | Sí | Contenido del cuerpo de la plantilla (formato markdown). |
type | number | Sí | Tipo de plantilla. Usualmente 0 para consulta general. |
description | string | Sí | Breve descripción del propósito de la plantilla. |
specialityId | number | Sí | ID de la especialidad médica asociada al template. |
Ejemplo de Respuesta Exitosa (200 OK
)
{
"success": true,
"code": 200,
"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"
}
}