Skip to main content

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ámetroTipoObligatorioDescripción
idnumberIdentificador único de la plantilla a actualizar

Cuerpo de la Solicitud (application/json)

{
"name": "Consulta General Adulto", // Nombre de la plantilla.
"body": "### Consulta\nDolor abdominal.", // Contenido de la plantilla en formato Markdown.
"type": 0, // Tipo de plantilla: 0 para consulta médica, 1 para cirugía.
"description": "Plantilla básica para consulta médica general en adultos.", // Descripción de la plantilla.
"specialityId": 1 // ID de la especialidad médica asociada a la plantilla.
}

Parámetros del Cuerpo

ParámetroTipoRequeridoDescripción
namestringNombre identificativo de la plantilla.
typenumberTipo de plantilla: 0 (Consulta) o 1 (Cirugía).
descriptionstringNoBreve descripción del propósito de la plantilla.
specialityIdnumberID de la especialidad médica asociada. Consulte las especialidades disponibles haciendo click aqui.
bodystringCondicionalEstructura de la plantilla en formato Markdown o HTML.
responseFormatstringCondicionalEstructura de la plantilla en formato JSON.

⚠️ Importante: responseFormat vs body

  • responseFormat: Utilice este campo únicamente cuando la configuración del centro médico requiera que la respuesta final sea un objeto JSON estructurado. Para ver detalle de la estructura y soporte de inputs (select, radio, checkbox), consulte la documentación de Creación de Plantilla. En este caso, NO debe enviar el campo body.
  • body: Utilice este campo cuando la configuración del centro médico espere recibir un informe en formato MARKDOWN o HTML. En este caso, NO debe enviar el campo responseFormat.

Ejemplo de Respuesta Exitosa (200 OK)

{
"success": true,
"code": 200,
"response": {
"id": 374,
"name": "Consulta General Adulto",
"description": "Plantilla básica para consulta médica general en adultos.",
"type": 0,
"body": "### Consulta\nDolor abdominal.",
"specialityId": 1,
"isValidated": true,
"ownerType": "HEALTH_PROVIDER",
"providerId": "123",
"responseFormat": null
}
}