| Í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. |
...
Request
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
https://telecareservicos.mobilesaude.com.br/mssuite/plataforma_beneficiario/telemedicina/listarAgenda.php?id_prestador=208153047&dataReferencia=2020-12-04 |
...
| 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
...
| 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
|
Retorno da API - Sucesso
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"status": true,
"data": {
"profissional": {
"nome": "Dr. Francisco Humberto Moura",
"integracao": {
"idSistema": 1234
}
},
"agenda": {
"horarios": [
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "geraldo@mobilesaude.com.br",
"nome": "Geraldo Félix Júnior",
"email": "geraldo@mobilesaude.com.br",
"telefone": "27992724109",
"matricula": "000002",
"cpf": "07805206708"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "geraldo_teste@mobilesaude.com.br",
"nome": "Geraldo SMS",
"email": "geraldo_teste@mobilesaude.com.br",
"telefone": "27992724109",
"matricula": "000002",
"cpf": "07805206708"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "geraldo@mobilesaude.com.br",
"nome": "Geraldo SMS",
"email": "geraldo@mobilesaude.com.br",
"telefone": "",
"matricula": "000002",
"cpf": "07805206708"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "geraldo@mobilesaude.com.br",
"nome": "Geraldo FIXO",
"email": "geraldo@mobilesaude.com.br",
"telefone": "992724109",
"matricula": "000002",
"cpf": "07805206708"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 1001010
},
"paciente": {
"localizadorMensageria": "rafael@mobilesaude.com.br",
"nome": "Rafael Simão AG: 1001010",
"email": "rafael@mobilesaude.com.br",
"telefone": "27998554785",
"matricula": "000022",
"cpf": "05869310741"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 1001015
},
"paciente": {
"localizadorMensageria": "",
"nome": "Rafael Simão (Falta de dados)",
"email": "rafael@mobilesaude.com.br",
"telefone": "27998554785",
"matricula": "",
"cpf": ""
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "rafael_teste@mobilesaude.com.br",
"nome": "Rafael Simão (Teste)",
"email": "rafael_teste@mobilesaude.com.br",
"telefone": "",
"matricula": "000022",
"cpf": "05869310741"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 52869
},
"paciente": {
"localizadorMensageria": "ewersonv@mobilesaude.com.br",
"nome": "Ewerson Vieira Nascimento",
"email": "ewersonv@mobilesaude.com.br",
"telefone": "27996187663",
"matricula": "0003002",
"cpf": "14912323748"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "haryell@mobilesaude.com.br",
"nome": "Haryell da Silva Daleprane",
"email": "haryell@mobilesaude.com.br",
"telefone": "27996188096",
"matricula": "000021",
"cpf": "13033119760"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "leonardo@mobilesaude.com.br",
"nome": "Leonardo Xavier",
"email": "leonardo@mobilesaude.com.br",
"telefone": "27999830598",
"matricula": "000025",
"cpf": "01234567890"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "leonardo_teste@mobilesaude.com.br",
"nome": "Leonardo SMS",
"email": "leonardo_teste@mobilesaude.com.br",
"telefone": "27999830598",
"matricula": "000025",
"cpf": "01234567890"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 3000
},
"paciente": {
"localizadorMensageria": "lucas.cordeiro@mobilesaude.com.br",
"nome": "Lucas Cordeiro Pereira",
"email": "lucas.cordeiro@mobilesaude.com.br",
"telefone": "27998909507",
"matricula": "000036",
"cpf": "15560091782"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 3000
},
"paciente": {
"localizadorMensageria": "yago@mobilesaude.com.br",
"nome": "Yago Bravim",
"email": "yago@mobilesaude.com.br",
"telefone": "27997156746",
"matricula": "000037",
"cpf": "14480243747"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "auriemma@mobilesaude.com.br",
"nome": "Paulo Auriemma",
"email": "auriemma@mobilesaude.com.br",
"telefone": "27988231333",
"matricula": "000090",
"cpf": "99999999999"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "jean@mobilesaude.com.br",
"nome": "Jean Schulz",
"email": "jean@mobilesaude.com.br",
"telefone": "48988429102",
"matricula": "000091",
"cpf": "99999999999"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "victor.hugo@mobilesaude.com.br",
"nome": "Torugo",
"email": "victor.hugo@mobilesaude.com.br",
"telefone": "27999122574",
"matricula": "000091",
"cpf": "05859615736"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "derlandy@mobilesaude.com.br",
"nome": "Derlandy Belchior",
"email": "derlandy@mobilesaude.com.br",
"telefone": "27999826284",
"matricula": "000002",
"cpf": "99999999999"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 321432
},
"paciente": {
"localizadorMensageria": "bruno@mobilesaude.com.br",
"nome": "Bruno Soares da Silva Vieira",
"email": "bruno@mobilesaude.com.br",
"telefone": "27999401277",
"matricula": "000020",
"cpf": "13892637709"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 300010
},
"paciente": {
"localizadorMensageria": "geovane@mobilesaude.com.br",
"nome": "Geovane Henrique Pinto da Costa",
"email": "geovane@mobilesaude.com.br",
"telefone": "27992495884",
"matricula": "000100",
"cpf": "05805507706"
},
"data": "2020-12-04",
"hora": "08:00",
"status": "Agendado",
"especialidade": "Cardiologia"
},
{
"integracao": {
"idAgenda": 52869
},
"paciente": {
"localizadorMensageria": "31468430",
"nome": "Yago (Widget 1)",
"email": "31468430@mobilesaude.com.br",
"telefone": "27997156746",
"matricula": "0003005",
"cpf": "14480243747"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 52869
},
"paciente": {
"localizadorMensageria": "31500752",
"nome": "Yago (Widget 2)",
"email": "31468430@mobilesaude.com.br",
"telefone": "27997156746",
"matricula": "0003005",
"cpf": "14480243747"
},
"data": "2020-12-04",
"hora": "08:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 52870
},
"paciente": {
"localizadorMensageria": "phelipe@mobilesaude.com.br",
"nome": "Phelipe Momesso",
"email": "phelipe@mobilesaude.com.br",
"telefone": "34991860005",
"matricula": "0005005",
"cpf": "07048287667"
},
"data": "2020-12-04",
"hora": "09:00",
"especialidade": "Cardiologia",
"status": "Agendado"
},
{
"integracao": {
"idAgenda": 52885
},
"paciente": {
"localizadorMensageria": "vd_santana@live.com",
"nome": "Vinícius Dias",
"email": "vd_santana@live.com",
"telefone": "31994465031",
"matricula": "3020200924205636",
"cpf": "78566626036"
},
"data": "2020-12-04",
"hora": "09:00",
"especialidade": "Cardiologia",
"status": "Agendado"
}
]
}
}
} |
...