| Índice |
|---|
Objetivo
...
| 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 |
|---|---|---|---|---|
| status | M | Boolean | Indica que a requisição foi bem sucedida | True |
| data | M | Array de objetos | Retornar um array de objetos | Caso nenhum profissional seja encontrado, ou os horários estejam vazios, este array deve estar vazio. |
Objeto profissional
O objeto profissional é obrigatório e deve ser único.
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| nome | M | String | Nome que identifica o profissional. | Texto livre |
| integracao | M | Array de objetos "integracao" | Retorna um array de objetos do tipo "integracao" com o atributo "idSistema" do profissional no sistema da Operadora | Caso nenhum profissional seja encontrado, este array deve estar vazio |
Objeto integração - Profissional
Este objeto é obrigatório e destina-se a estabelecer uma correlação entre o profissional listado e suas agendas.
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| idSistema | M | String | id do profissional no sistema do cliente | Alfanumérico |
Objeto agenda
Quando o profissional possuir agenda para a data requisitada, este objeto é obrigatório. O objeto agenda, quando preenchido, necessita obrigatoriamente de objeto "horarios".
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| horarios | M | Array de objetos "horarios" | Retorna um array de objetos do tipo "horarios" | Caso nenhum profissional seja encontrado, este array deve estar vazio |
Objeto horarios
Destina-se a estratificar cada horário agendado para o profissional. Para prestadores com horários agendados em teleatendimentos, deve existir no mínimo um objeto horário válido.
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| integração | M | Array de objetos "integracao" | Retorna um array de objetos do tipo "integracao". | Caso nenhum profissional seja encontrado, este array deve estar vazio |
| paciente | M | Array de objetos "paciente" | Retorna um array de objetos do tipo "paciente" com informações referentes ao paciente/beneficiário. | Caso nenhum profissional seja encontrado, este array deve estar vazio |
| data | M | Date | Data do profissional | Formato: yyyy-mm-dd |
| hora | M | Time | Horário do profissional. | Formato: hh:mm |
| especialidade | M | String | Especialidade do profissional | Alfanumérico |
| status | M | String | Informa o status do agendamento | Status: "Agendado";"Preparado";"Recepcionado";"Atendido";"Falta";"Finalizando";"Livre";Não utilizado";"Cancelado";"Bloqueio". |
Objeto integração - horarios
Este item serve como elo entre o horário agendado e o profissional que solicitou a relação de agendas do dia.
| Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
| idAgenda | M | String | id da agenda no sistema do cliente. | Alfanumérico |
Objeto paciente - horarios
Dados do paciente que agendou o teleatendimento.
| Atributo | Critério | Tipo | Descrição | Regras de preenchimento |
|---|---|---|---|---|
| localizadorMensageria | M | String | Login do paciente/beneficiário nas soluções da Mobile Saúde(apps ou web) | Alfanumérico |
| nome | M | String | Nome do paciente. | Alfanumérico |
| M | String | Email do paciente. | Alfanumérico | |
| telefone | M | Int | Telefone do paciente | Não utilizar mascaras.
|
| matricula | M | Int | Matricula do paciente | Não utilizar pontos ou traços
|
| cpf | M | Int | Cpf do paciente | Não utilizar mascaras
|
...