...
Endpoint | Método | Header Content-Type | Descrição | |
|---|---|---|---|---|
Atenção O endpoint obrigatoriamente deve terminar com “/aps/exemplo.com / aps/locaisAtendimento Nota | 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:
| |
idProfissionalIdTipoAtendimento | OP | String | Quando enviado deve retornar dados do detalhe da agenda do profissional. O array de profissionais deve conter somente um Number | ID do tipo de atendimento selecionado na tela de seleção de tipo de atendimento | |
idProfissional | M | String | 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. |
...
| Bloco de código |
|---|
{
"chaveUnica":"String",
"integracao":{ Objeto },
"beneficiario":{ Objeto }
},
"idAtividade:": Number,
"idTipoAtividade": Number,
"idTipoAtendimento": Number,
"idLocal": Number,
"idProfissional": Number,
"idAgenda": Number,
"dataHora":"YYYY-MM-DD hh:mm:ss",
"dadosContato:":{ Objeto },
"idMeeting": "String"
} |
...
O objeto de dados de contato é referente ao formulário de contato no fluxo de agendamento, como se trata de um formulário dinâmico podendo ter campos diversos, abaixo contem apenas um exemplo de um formulário de contato.
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
nome | M | String | Nome do contato |
|
celular | M | String | Celular do contato |
|
M | String | Email do contato |
|
...
| Bloco de código |
|---|
{
"chaveUnica": "101012",
"integracao": {
"cpf": "123456789123",
"numero_cartao": "9288701",
},
"beneficiario": {
"chaveUnica": "101012", //geralmente é o cpf
"numeroContrato": "616161",
"integracao": {
"cpf": "123456789123",
"numero_cartao": "9288701",
},
},
"idAtividade":123,
"idRegiao":123,
"idProfissional",
"idTipoAtendimento": 123,
"idTipoAtividade":123,
} |
Descrição dos objetos e atributos de retorno - Sucesso
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
...
profissionaisAgendas
...
M
...
Array
...
Array de objetos de dataProfissionais
...
| Bloco de código |
|---|
{
"profissionaisAgendas": [ Array-Objetos ]
} |
Objeto dataProfissionais
...
Atributo
...
Critério
...
Tipo
...
Descrição
...
Regra de preenchimento
...
data
...
M
...
String
...
Data da agenda
...
Deve conter o seguinte formato
Formato: YYYY-MM-DD
...
profissionais
...
M
...
Array
...
Array de objeto profissional
...
| Bloco de código |
|---|
{
"profissionaisAgendas": [
{
"data": "YYYY-MM-DD",
"profissionais": [ Array-objetos ]
}
]
} |
Objeto profissional
...
Atributo
...
Critério
...
Tipo
...
Descrição
...
Regra de preenchimento
...
nome
...
M
...
String
...
Nome do profissional
...
Texto livre
...
id
...
M
...
String
...
id do profissional
...
...
urlFoto
...
OP
...
String
...
URL da foto do profissional
...
...
conselho
...
M
...
String
...
Texto de informação do conselho do profissional
...
Texto Livre.
Ex: "CRM ES 123123"
...
localAtendimento
...
M
...
Objeto
...
Objeto com dados sobre o local de atendimento
...
Objeto do tipo localAtendimento
...
especialidade
...
M
...
Objeto
...
Objeto com dados da especialidade do profissional
...
Objeto do tipo especialidade
...
horarios
...
M
...
Array
...
Array de horarios disponíveis para atendimento
...
Array de objetos horario
| Bloco de código |
|---|
{
"profissionaisAgendas": [
{
"profissionais": [
{
"id": "String",
"nome": "String",
"urlFoto": "String",
"conselho": "String",
"localAtendimento": { Objeto },
"especialidade": { Objeto },
"horarios": [ Array-objetos ]
}
]
}
]
} |
Objeto localAtendimento
...
Atributo
...
Critério
...
Tipo
...
Descrição
...
Regra de preenchimento
...
descricao
...
M
...
String
...
Texto de descrição do local de atendimento
...
Texto livre
Ex:”Em atendimento em Local XPTO"
...
id
...
M
...
String
...
id do local de atendimento
...
| Bloco de código |
|---|
{
"profissionaisAgendas": [
{
"profissionais": [
{
"localAtendimento": {
"id": "String",
"descricao": "String"
}
}
]
}
]
} |
Objeto especialidade
...
Atributo
...
Critério
...
Tipo
...
Descrição
...
Regra de preenchimento
...
descricao
...
M
...
String
...
Texto de descrição da especialidade
...
Texto livre
EX:”clinica geral"
...
id
...
M
...
String
...
id da especialidade
...
| Bloco de código |
|---|
{
"profissionaisAgendas": [
{
"profissionais": [
{
"especialidade": {
"descricao": "String",
"id": "String"
}
}
]
}
]
} |
Objeto horario
...
Atributo
...
Critério
...
Tipo
...
Descrição
...
Regra de preenchimento
...
idAgenda
...
M
...
String
...
id da agenda
...
...
dataHora
...
...
...
Data e hora disponível
...
Deve conter dia e hora.
Formato: YYYY-MM-DD hh:mm:ss
| Bloco de código |
|---|
{
"profissionaisAgendas": [
{
"profissionais": [
{
"horarios": [
{
"idAgenda": "String",
"dataHora": "YYYY-MM-DD hh:mm:ss"
}
]
}
]
}
]
} |
...
| Bloco de código |
|---|
{
"profissionaisAgendas": [
{
"data": "2022-03-01",
"profissionais": [
{
"id": "121212",
"nome": "Dr Joaquim Das Neves",
"urlFoto": "https://randomuser.me/api/portraits/men/80.jpg",
"conselho": "CRM-ES 918171",
"localAtendimento": {
"id": "x1817",
"descricao": "Em atendimento em Local Xpxy"
},
"especialidade": {
"descricao": "clinica geral",
"id": "01928"
},
"horarios": [
{
"idAgenda": "121212",
"dataHora": "2022-03-01 11:40:00"
},
{
"idAgenda": "121212",
"dataHora": "2022-03-01 13:40:00"
},
{
"idAgenda": "121212",
"dataHora": "2022-03-01 14:40:00"
}
]
},
{
"id": "2",
"nome": "Dr. Carlos Alberto de Souza",
"conselho": "CRM-ES 31312312",
"localAtendimento": {
"id": "1",
"descricao": "Atendimento em Hospital São José"
},
"especialidade": {
"id": "1",
"descricao": "Clínico Geral"
},
"horarios": [
{
"idAgenda": "1",
"dataHora": "2022-03-01 11:30:00"
},
{
"idAgenda": "2",
"dataHora": "2022-03-01 13:00:00"
},
{
"idAgenda": "5",
"dataHora": "2022-03-01 15:00:00"
},
{
"idAgenda": "6",
"dataHora": "2022-03-01 16:00:00"
}
]
}
]
}
]
}
|
Exemplo de retorno com "sucesso” - Caso o atributo idProfissional no body da requisição for preenchido e o atributo data for preenchido
| Bloco de código |
|---|
{ "profissionaisAgendas":[ { "data":"2022-02-01", "profissionais":[] }, { "data":"2022-02-03", "profissionais":[] }, { "data":"2022-02-04", "profissionais":[] }, { "data":"2022-02-07", "profissionais":[ { "id":"1", "nome":"Dr. Pedro Paulo Pereira", "conselho":"CRM-ES 918171", "urlFoto":"https://randomuser.me/api/portraits/men/80.jpg", "localAtendimento":{ "id":"123", "descricao":"Hospital São José" }, "especialidade":{ "id":"9191919", "descricao":"Clínico Geral" }, "horarios":[ { "idAgenda":"3", "dataHora":"2022-02-07 10:30:00" }, { "idAgenda":"4", "dataHora":"2022-02-07 11:30:00" }, { "idAgenda":"5", "dataHora":"2022-02-07 13:00:00" }, { "idAgenda":"8", "dataHora":"2022-02-07 15:00:00" }, { "idAgenda":"9", "dataHora":"2022-02-07 16:00:00" }, { "idAgenda":"9", "dataHora":"2022-02-07 17:00:00" } ] } ] }, { "data":"2022-02-09", "profissionais":[] }, { "data":"2022-02-10", "profissionais":[] }, { "data":"2022-02-11", "profissionais":[] }, { "data":"2022-02-15", "profissionais":[] }, { "data":"2022-02-17", "profissionais":[] }, { "data":"2022-02-18", "profissionais":[] }, { "data":"2022-02-21", "profissionais":[] }, { "data":"2022-02-23", "profissionais":[] } ] }"idLocal": 1, "idAgenda": 1, "dataHora":"2024-05-16 14:20:00", "dadosContato:":{ "nome":"Nome do contato", "celular":"289999999999", "email":"email@teste.com" }, "idMeeting": "6422f5253333f63b0e9e183f" } |
Descrição dos objetos e atributos de retorno - Sucesso
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"
}
} |
Retorno da API - Sucesso
| Bloco de código |
|---|
{
"numeroProtocolo":"001002003004005",
"paciente":{
"chaveUnica":"123123",
"nome":"Nome paciente",
"telefone":"27 99999-9999"
},
"profissional":{
"id":"1231231",
"nome":"Dr João Silva",
"conselho":"CRM-ES 123123",
"especialidade":{
"id":"123123",
"descricao":"Cardiologia"
}
},
"agenda":{
"idAgenda":"123123",
"dataHora":"2022-02-01 14:00:00"
}
}
|
Retorno da API - Falha
| Aviso |
|---|
|
...