Só são suportadas integrações no padrão REST.
...
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
http://exemplo.com/detalheDebito /detalheConsulta | POST | application/json | Endpoint que retorna o detalhamento de um débito |
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
idAgenda | M | String | id da agenda |
|
numeroProtocolo | OP | String | Numero de protocolo do agendamento | |
dataHora | C | String | Data e hora da consulta | Obrigatório para os tipos de agendamento: Formato: YYYY-MM-DD hh:mm:ss |
tipoAgenda | M | String | Informe o tipo da agenda | Conteúdo válido: |
profissional | M | Objeto | Dados do profissional | Obrigatório para os tipos de agendamento: Objeto profissional |
especialidade | M | Objeto | Dados da especialidades
| Obrigatório para os tipos de agendamento: Objeto especialidade |
localAtendimento | M | Objeto | Objeto com dados do local de atendimento | Obrigatório para os tipos de agendamento: Objeto localAtendimento |
status | M | Objeto | Objeto com dados sobre o status da consulta | Objeto status |
paciente | M | Objeto | Objeto com dados do paciente | Objeto paciente |
configuracoes | M | Objeto | Objeto com dados da configurações da funcionalidade | Objeto configurações
|
dataTermino | OP | String | Data de termino da consulta | Deve conter dia e hora. Formato: YYYY-MM-DD hh:mm:ss |
anexos | OP | Array <anexo> | Array de anexos | |
meeting | OP | String | Objeto com dados da meeting | Agendas do tipo teleconsulta |
| Bloco de código | ||
|---|---|---|
| ||
{
"idAgenda": "String",
"numeroProtocolo": "String"
"dataHora": "YYYY-MM-DD hh:mm:ss",
"tipoAgenda": "String",
"profissional": { Objeto },
"especialidade": { Objeto },
"localAtendimento": { Objeto },
"status": { Objeto },
"paciente": { Objeto },
"configuracoes": { Objeto },
"anexos": [{ Objeto }]
"meeting": { objeto }
} |
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
descricao | M | String | Descrição do status | Texto livre |
id | M | String | id do status |
|
cor | M | String | Cor referente ao status | Hexadecimal. com o #. da cor que deseja que seja usada para representar o status da consulta. Ex.: |
motivo | OP | String | Descrição do motivo | Deve ser preenchido quando o status da consulta for cancelado |
encerrado | OP | Boolean | Consulta cancelado pelo paciente ou saber se esse atendimento está encerrado.RESERVADO. PARAMETRO AINDA NÃO DISPONÍVEL PARA USO. RECOMENDAMOS NÃO ENVIAR AGENDAMENTOS CANCELADOS. |
| Bloco de código | ||
|---|---|---|
| ||
{
"status": {
"descricao": "String",
"id": "String",
"cor": "String",
"motivo": "String"
}
} |
...