...
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
exemplo.com / aps/gravarConsulta | POST | application/json |
Parâmetros de entrada
...
Parâmetro | Obrigatório | Tipo | Descrição |
|
|---|---|---|---|---|
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
|
integracao | OP | Objeto | Nó integração retornado no login do usuário |
|
beneficiario | M | Objeto | Beneficiario selecionado para agendamento da consulta |
|
idAtividade | M | Number | ID da atividade cadastrada pelo PREVIVA | |
idAtendimento | M | Number | ID do atendimento cadastrada pelo PREVIVA | |
idLocal | OP | String | Id do local da consulta | Obrigatório quando agendamento presencial |
IdTipoAtividade | OP | Number | ID do tipo de atividade cadastrado pela PREVIVA | ID do tipo de atividade selecionado na etapa de seleção de tipo de consulta. Identifica o tipo de consulta:
|
IdTipoAtendimento | OP | Number | ID do tipo de atendimento selecionado na tela de seleção de tipo de atendimento | |
idProfissional | OPM | String | Quando enviado deve retornar dados do detalhe da agenda do profissional. O array de profissionais deve conter somente um ID do profissional |
|
idAgenda | M | String | id da agenda |
|
dataHora | M | String | Data e hora disponível | Deve conter dia e hora. Formato: YYYY-MM-DD hh:mm:ss |
dadosContato | OP | Objeto | Objeto com dados do contato referente ao formulário de contato |
|
idMeeting | C | String | idMeeting fornecido pela Mobile Saúde para agendamentos do tipo teleconsulta. | Este parâmetro será enviado em casos de agendamento do tipo teleconsulta. |
...
Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
paciente | M | Objeto | Objeto com dados do paciente |
|
profissional | M | Objeto profissional | Objeto com dados do profissional |
|
agenda | M | Objeto agenda | Objeto com dados da agenda |
|
numeroProtocolo | M | String | Numero do protocolo gerado pelo agendamento |
|
| Bloco de código |
|---|
{
"numeroProtocolo":"String",
"paciente":{ Objeto },
"profissional":{ Objeto }
},
"agenda":{ Objeto }
} |
Objeto paciente
Atributo | Critério | Tipo | Descrição |
|---|---|---|---|
nome | M | String | Nome do paciente |
chaveUnica | M | String | Chave unica do paciente |
telefone | OP | String | Telefone do paciente |
| Bloco de código |
|---|
{
"paciente":{
"chaveUnica":"String",
"nome":"String",
"telefone":"String"
}
} |
Objeto profissional
Atributo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
id | M | String | Id do profissional |
nome | M | String | Telefone do paciente |
conselho | OP | String | Texto de informação do conselho do profissional |
especialidade | OP | Objeto especialidade | Objeto com dados da especialidade do profissional |
| Bloco de código |
|---|
{
"profissional":{
"id":"String",
"nome":"String",
"conselho":"String",
"especialidade":{ Objeto }
}
} |
Objeto especialidade
Atributo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
id | M | String | Id da especialidade |
descricao | M | String | Texto de descrição da especialidade |
| Bloco de código |
|---|
{
"profissional":{
"especialidade":{
"id":"String",
"descricao":"String"
}
}
} |
Objeto agenda
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
idAgenda | M | String | id da agenda |
|
dataHora | M | String | Data e hora disponível | Deve conter dia e hora. Formato: YYYY-MM-DD hh:mm:ss |
| Bloco de código |
|---|
{
"agenda":{
"idAgenda":"String",
"dataHora":"YYYY-MM-DD hh:mm:ss"
}
} |
...