Este documento contém a chamada a API de funcionalidades do sistema para integração com URA e callcenter
Obs.: Existem algumas funções que são legadas e o retorno não está padronizado, porém o padrão deve ser o representado abaixo:
{“success”: [true|false], “msg”: [mensagem de erro se houver], “data”: [dados em formato json retornados para o frontend]}
AUTENTICAÇÃO E CONFIGURAÇÕES DO USUÁRIO
LOGIN
PARAMETROS
usua_tx_email: e-mail de cadastro no Sistema
usua_tx_senha: sua senha
RETORNO
ERRO
{"error":true,"msg":"Usu\u00e1rio ou senha n\u00e3o conferem ou n\u00e3o existem!"}
SUCESSO
{"codigo":true, "success":true, "pess_id":"---", "usua_id":"--", "usua_tx_email":"[email protected]", "pess_tx_nome":"Nome da pessoa", "pess_tx_foto_arquivo":null, "user_hash":"----", "prof_id":false, "id_chat":3860, "token":"------", "timestamp":1469641942}
Obs.: O token pode ser utilizado para novas requisições sem a necessidade de nova autenticação
LOGOUT
MANIPULAÇÃO DA AGENDA
LISTA DE AGENDAMENTOS SEM CONFIRMACAO
Este método irá retornar todos os agendamentos das instituições que o usuário possui acesso em uma determinada data e que ainda não foram confirmados.
PARAMETROS (GET ou POST)
data_ref: data do agendamento no formato YYYY-MM-DD
inst_id: ID da instituição desejada para filtro dos dados [opcional]
RETORNO
ERRO
{"success":false, "msg":"Erro ao obter informações!"}
SUCESSO
{"success":true,
"data":[{
"agen_id": "E8611FC1-21FE-90F6-81EA-2BA0CD684C0A",
"prof_id": "1DF8819D-42DD-9C73-BA36-1AF1EC076D6A",
"agen_dt_agendamento": "2017-11-02 10:30:00",
"agen_in_encaixe": "S",
"agen_tx_observacao": null,
"agen_nr_intervalo": 30,
"agda_id": "1DBC46AE-F413-9313-E55D-7F743E7AF670",
"agda_tx_rotulo": "Cl\u00ednico Voitel",
"inst_id": "C7203505-8217-8EC2-DFDD-47279D6C2D45",
"inst_tx_nome": "Cl\u00ednica Voitel",
"siag_id": 1,
"siag_tx_situacao_agend": "Marcado",
"pess_id": "C1D7D3B9-B7FC-99D6-8E7D-28A2923394F6",
"nome_paciente": "Maria Joana Carvalho",
"pess_dt_nascimento": null,
"pess_dt_cadastro": "2017-11-01 01:55:55.888237",
"pess_in_sexo": "F",
"nome_profissional": "Cl\u00ednico Voitel",
"plso_id": 3121,
"plso_tx_nome": "CASSI",
"nome_operadora": "CASSI",
"historico": [{
"hiag_id": 15706053,
"siag_id": 1,
"hiag_tx_observacao": "oper_tx_registro_ans:\"1\";agen_in_encaixe:\"N\";plso_id:\"1\";",
"hiag_dt_atualizacao": "2017-11-01T02:01:27.510645",
"usua_id_alteracao": "3561BC74-FE51-82A5-BD5D-A56D0A0C1550"
},
{
"hiag_id": 15706051,
"siag_id": 1,
"hiag_tx_observacao": null,
"hiag_dt_atualizacao": "2017-11-01T01:55:55.888237",
"usua_id_alteracao": "3561BC74-FE51-82A5-BD5D-A56D0A0C1550"
}],
"procedimentos": [{
"orpo_id": 781092,
"proc_id": 12000,
"proc_tx_nome": "Consulta em consult\u00f3rio (no hor\u00e1rio normal ou preestabelecido)",
"proc_nr_cod_exportacao": "10101012",
"prof_id": "1DF8819D-42DD-9C73-BA36-1AF1EC076D6A",
"orpo_nr_qtd": 1,
"orpo_nr_qtd_executado": null,
"tipo": "M"
},
{
"orpo_id": 781094,
"proc_id": 14555,
"proc_tx_nome": "Eletroneuromiografia de MMSS e MMII",
"proc_nr_cod_exportacao": "40103331",
"prof_id": "1DF8819D-42DD-9C73-BA36-1AF1EC076D6A",
"orpo_nr_qtd": 1,
"orpo_nr_qtd_executado": null,
"tipo": "M"
}],
"etiquetas": null
},
{
"agen_id": "98ED0681-7400-77A4-B607-FE1BBA333875",
"prof_id": "1DF8819D-42DD-9C73-BA36-1AF1EC076D6A",
"agen_dt_agendamento": "2017-11-02 11:00:00",
"agen_in_encaixe": "N",
"agen_tx_observacao": "Primeiro agendamento",
"agen_nr_intervalo": 30,
"agda_id": "1DBC46AE-F413-9313-E55D-7F743E7AF670",
"agda_tx_rotulo": "Cl\u00ednico Voitel",
"inst_id": "C7203505-8217-8EC2-DFDD-47279D6C2D45",
"inst_tx_nome": "Cl\u00ednica Voitel",
"siag_id": 1,
"siag_tx_situacao_agend": "Marcado",
"pess_id": "65F051AC-FA46-F806-93D7-06FA686BA801",
"nome_paciente": "Carlos Silva Santos",
"pess_dt_nascimento": null,
"pess_dt_cadastro": "2017-11-01 01:54:54.96229",
"pess_in_sexo": "M",
"nome_profissional": "Cl\u00ednico Voitel",
"plso_id": 3120,
"plso_tx_nome": "PETROBRAS",
"nome_operadora": "PETROBRAS",
"historico": [{
"hiag_id": 15706052,
"siag_id": 1,
"hiag_tx_observacao": "oper_tx_registro_ans:\"1\";plso_id:\"1\";",
"hiag_dt_atualizacao": "2017-11-01T02:00:58.285708",
"usua_id_alteracao": "3561BC74-FE51-82A5-BD5D-A56D0A0C1550"
},
{
"hiag_id": 15706050,
"siag_id": 1,
"hiag_tx_observacao": null,
"hiag_dt_atualizacao": "2017-11-01T01:54:54.96229",
"usua_id_alteracao": "3561BC74-FE51-82A5-BD5D-A56D0A0C1550"
}],
"procedimentos": [{
"orpo_id": 781090,
"proc_id": 12000,
"proc_tx_nome": "Consulta em consult\u00f3rio (no hor\u00e1rio normal ou preestabelecido)",
"proc_nr_cod_exportacao": "10101012",
"prof_id": "1DF8819D-42DD-9C73-BA36-1AF1EC076D6A",
"orpo_nr_qtd": 1,
"orpo_nr_qtd_executado": null,
"tipo": "M"
}],
"etiquetas": null
}]
}
OBTER DADOS DE AGENDAMENTOS
Este método irá retornar os dados e status de um determinado agendamento que o usuário possui acesso
PARAMETROS (GET ou POST)
agen_id: ID do agendamento
RETORNO
ERRO
{"success":false, "msg":"Erro ao obter informações!"}
SUCESSO
{"success":true,
"data":[{
"agen_id": "E8611FC1-21FE-90F6-81EA-2BA0CD684C0A",
"prof_id": "1DF8819D-42DD-9C73-BA36-1AF1EC076D6A",
"agen_dt_agendamento": "2017-11-02 10:30:00",
"agen_in_encaixe": "S",
"agen_tx_observacao": null,
"agen_nr_intervalo": 30,
"agda_id": "1DBC46AE-F413-9313-E55D-7F743E7AF670",
"agda_tx_rotulo": "Cl\u00ednico Voitel",
"inst_id": "C7203505-8217-8EC2-DFDD-47279D6C2D45",
"inst_tx_nome": "Cl\u00ednica Voitel",
"siag_id": 1,
"siag_tx_situacao_agend": "Marcado",
"pess_id": "C1D7D3B9-B7FC-99D6-8E7D-28A2923394F6",
"nome_paciente": "Maria Joana Carvalho",
"pess_dt_nascimento": null,
"pess_dt_cadastro": "2017-11-01 01:55:55.888237",
"pess_in_sexo": "F",
"nome_profissional": "Cl\u00ednico Voitel",
"plso_id": 3121,
"plso_tx_nome": "CASSI",
"nome_operadora": "CASSI",
"historico": [{
"hiag_id": 15706053,
"siag_id": 1,
"hiag_tx_observacao": "oper_tx_registro_ans:\"1\";agen_in_encaixe:\"N\";plso_id:\"1\";",
"hiag_dt_atualizacao": "2017-11-01T02:01:27.510645",
"usua_id_alteracao": "3561BC74-FE51-82A5-BD5D-A56D0A0C1550"
},
{
"hiag_id": 15706051,
"siag_id": 1,
"hiag_tx_observacao": null,
"hiag_dt_atualizacao": "2017-11-01T01:55:55.888237",
"usua_id_alteracao": "3561BC74-FE51-82A5-BD5D-A56D0A0C1550"
}],
"procedimentos": [{
"orpo_id": 781092,
"proc_id": 12000,
"proc_tx_nome": "Consulta em consult\u00f3rio (no hor\u00e1rio normal ou preestabelecido)",
"proc_nr_cod_exportacao": "10101012",
"prof_id": "1DF8819D-42DD-9C73-BA36-1AF1EC076D6A",
"orpo_nr_qtd": 1,
"orpo_nr_qtd_executado": null,
"tipo": "M"
},
{
"orpo_id": 781094,
"proc_id": 14555,
"proc_tx_nome": "Eletroneuromiografia de MMSS e MMII",
"proc_nr_cod_exportacao": "40103331",
"prof_id": "1DF8819D-42DD-9C73-BA36-1AF1EC076D6A",
"orpo_nr_qtd": 1,
"orpo_nr_qtd_executado": null,
"tipo": "M"
}],
"etiquetas": null
}]
}
REGISTRAR EVENTO NO AGENDAMENTO
Este método irá gravar um determinado evento realizado no histórico do agendamento utilizando o usuário logado na aplicação
PARAMETROS (GET ou POST)
agen_id: ID do agendamento
manter_status: Indica se será registrado apenas a observação ou se o status será alterado [true | false]
status: ID do novo status do agendamento. Opções: 1; "Marcado" 2; "Confirmado" 92; "Desmarcado" 93;"Remarcado"
observacao: Texto da observação que irá ser gravada no histórico do agendamento
limpar_observacao: Indica que o texto da observação anterior será substituído completamente pela nova observação (o histórico sempre é preservado) [true | false]
nova_data*: Data e hora do novo horário que o paciente deseja (necessário que o status enviado seja remarcado)
RETORNO
ERRO
{"success":false, "msg":"Status de agendamento permitidos: [1] MARCADO, [2] CONFIRMADO ou [92] DESMARCADO!"}
SUCESSO
{"success":true}