Consultorio Live icon

Consultorio Live

Interagir com a API do Consultorio Live para gestão de clínicas e consultórios

Actions20

Overview

The node "Consultorio Live" integrates with the Consultorio Live API to manage clinical and medical office operations. Specifically, for the Agendamento (Appointment) resource and the Atualizar (Update) operation, it updates existing appointment records in the system.

This node is useful in scenarios where appointment details need to be modified after creation, such as changing the date/time, updating patient or professional information, adjusting the status, or adding notes. For example, a clinic receptionist could use this node to reschedule an appointment or mark it as confirmed or cancelled.

Properties

Name Meaning
ID Do Agendamento The unique identifier of the appointment to update.
Dados Do Agendamento A collection of fields representing the appointment data to update:
- Data Da Consulta The date of the appointment (required).
- Duração (Minutos) Duration of the appointment in minutes (default 30).
- Horário Time of the appointment in HH:MM format (required).
- ID Do Paciente Identifier of the patient associated with the appointment (required).
- ID Do Profissional Identifier of the professional associated with the appointment (required).
- Observações Additional notes or observations about the appointment.
- Status Status of the appointment; options are: Agendado (scheduled), Confirmado (confirmed), Cancelado (cancelled), Concluído (completed). Default is Agendado.
- Tipo Type of the appointment or consultation.

Output

The node outputs JSON data representing the updated appointment object returned by the Consultorio Live API. This typically includes all the appointment details after the update has been applied.

If the API supports binary data related to appointments (e.g., attachments), the node would handle that accordingly, but based on the provided code and properties, the output focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the Consultorio Live API.
  • The base URL for the API must be configured in the node credentials.
  • The node sends HTTP requests with JSON payloads to the Consultorio Live API endpoints.

Troubleshooting

  • Missing Required Fields: Errors may occur if required fields like "ID Do Agendamento", "Data Da Consulta", "Horário", "ID Do Paciente", or "ID Do Profissional" are not provided. Ensure these are filled correctly.
  • Invalid Date/Time Format: The appointment date and time must be valid and follow expected formats (ISO date for date, HH:MM for time).
  • Authentication Errors: If the API key or base URL is incorrect or missing, authentication will fail. Verify credentials configuration.
  • API Response Errors: The API might return errors if the appointment ID does not exist or if the update violates business rules (e.g., overlapping appointments). Review error messages and adjust input accordingly.

Links and References

Discussion