| Índice |
|---|
Objetivo
Este documento tem como objetivo orientar a construção dos webservices para que o sistema Mosia Telecare consiga exibir a agenda do profissional de saúde que está logado na plataforma.
...
| Abreviação | Nome | Descrição |
|---|---|---|
| M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
| C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
| OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
...
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
exemplo.com/listarAgenda | GET | application/json | Este método irá retornar a lista de agendas do profissional de saúde. |
...
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| idSistema | M | String | id ID do profissional no sistema do cliente. | Alfanumérico |
Objeto agenda
...
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| idAgenda | M | String | id ID da agenda no sistema do cliente. É utilizado internamente para distinguir agendas diferentes, e caso o cliente deseje, integrar o Mosia Telecare com seu sistema de agendamento, mudando status dos atendimentos - utiliza-se callback para essa integração. | Alfanumérico |
Objeto paciente - horarios
...
| Atributo | Critério | Tipo | Descrição | Regras de preenchimento |
|---|---|---|---|---|
| localizadorMensageria | M | StringLogin do paciente/beneficiário nas soluções da Mobile Saúde(apps ou web) | É o identificador principal do beneficiário. Informe neste atributo o identificador único, que permite localizar o paciente e notifica-lo sobre sua consulta, através de mensagens diretas para o aplicativo. | Obrigatório. Alfanumérico |
| nome | M | String | Nome do paciente. | Alfanumérico |
| MOP | String | Email do paciente. | Alfanumérico | |
| telefone | M | Int | Telefone celular do paciente. Este número de telefone será utilizado para realizar envio de mensagens para lembrar o paciente de sua consulta, portanto deve ser informado um TELEFONE CELULAR. | Não informe o telefone FIXO. Não utilizar mascaras.
|
| matricula | MC | Int | Matricula do paciente | Obrigatório o envio da MATRICULA caso o CPF não exista no cadastro. Não utilizar pontos ou traços
|
| cpf | MC | Int | Cpf CPF do paciente | Obrigatório o envio do CPF caso a matrícula não exista no cadastro. Não utilizar mascaras
|
...