Consulta com preparo
Este tipo de notificação envia uma mensagem a um paciente para que ele confirme ou não o comparecimento a uma consulta previamente agendada. Além de confirmar ou cancelar o agendamento o paciente também pode solicitar o reagendamento da consulta.
Para as consultas que forem confirmadas o paciente vai ser informado dos procedimentos de peparação que ele tem de observar antes de ir para a consulta. As instruções para o paciente são repassadas a ele de acordo com o canal de comunciação usado na confirmação.
Exemplos de conversas com o paciente
Confirmar
Ficha técnica
Endpoint da API
Notifications (POST) /notifications
Parametros de URL
Nenhum
Exige autenticação
Sim
Categoria (category)
medical
Plugin (target)
appointmentwithprepare
Dados a serem enviados
{
"entity_id": "cjth5ux7n000001l1zmd7tk99",
"external_id": "76458",
"category": "medical",
"target": "appointmentwithprepare",
"scheduler_type": "auto",
"when": "2019-07-09T20:15:00Z",
"timezone": "America/Sao_Paulo",
"webhook": "https://webhook.site/4bcb79b9-aabe-4f90-ac34-647a6b833f96",
"contact": {
"external_id": "3946",
"language": "pt_BR",
"country": "BR",
"birth_date": "1953-03-30",
"citizen_id": "12345678901",
"gender": "M",
"name": "José da Silva",
"channels": [
{
"type": "phone",
"uid": "027-30709999"
},
{
"type": "phone",
"uid": "+5527999999999"
},
{
"type": "email",
"uid": "jose.silva@dominio.com.br"
}
]
},
"params": {
"doctor": "Davi Lucca Pereira",
"doctor_external_id": "138",
"event_date": "2019-07-12T16:27:00Z",
"doctor_expertise": "Cardiologista",
"prepare_id": "cjx2jzrti000001gl4k45xxpc"
}
}
| Campo | Finalidade |
|---|---|
| entity_id | Código da clínica, consultório, ou hospital cadastrado na API que é o gerador da notificação. |
| external_id | ID único do agendamento no sistema da clínica, hospital ou consultório - coloque aqui, preferencialmente, a chave primária da tabela de agendamentos do seu banco de dados. |
| category | Categoria da notificação. |
| target | Objetivo da notificação. |
| contact | Dados da pessoa que receberá a notificação. |
| params | Dados específicos para o tipo da notificação (mais detalhes). |
| … | Todos os demais campos são explicados na documentação da API Notifications (POST) /notifications. |
Os campos category e target definem o tipo da notificação que será enviada.
Parametros (params) específicos da notificação
"params": {
"doctor": "Davi Lucca Pereira",
"doctor_external_id": "138",
"doctor_expertise": "Cardiologista",
"event_date": "2019-07-12T16:27:00Z",
"prepare_id": "cjx2jzrti000001gl4k45rtgc"
}
| Campo | Finalidade |
|---|---|
| doctor | Nome do médico. |
| doctor_external_id | ID do médico no sistema da clínica, hospital ou consultório. |
| doctor_expertise | Especialidade do médico. |
| event_date | Data e hora da consulta. |
| prepare_id | Código do arquivo com instruções de preparo previamente cadastradco na API. |
Informação
Para saber quais os prepare_id estão cadastrados para uma entidade use está API Files (GET) /files/{entity_id}.
Existem vários recursos na API para criar, alterar, excluir e listar os arquivos que podem ser usados nas notificações. Veja a documentação sobre a API de arquivos para maiores informações.
Ações principais