Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

Versão 1 Próxima »

Só são suportadas integrações no padrão REST.

Método "gravarConsulta"

Endpoint

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ / gravarConsulta

Atenção

O endpoint obrigatoriamente deve terminar com “/gravarConsulta

POST

application/json

Endpoint para listar os registros de consultas relacionadas ao localizador (chaveUnica)

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

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

 

paciente

M

Objeto

Paciente selecionado para agendamento da consulta

 

idEspecialidade

M

String

Id da especialidade

 

idLocal

OP

String

Id do local

 

idProfissional

M

String

Id do profissional

 

tipoAgenda

M

String

Tipo da agenda

Conteúdo válido:
1 = Presencial
2 = Teleconsulta
3 = Pronto atendimento

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

dadosContatos

OP

Objeto

Objeto com dados do contato referente ao formulário de contato

 

responsavelAtendimento

OP

Objeto

Objeto com dados do responsável pelo atendimento do fluxo de agendamento de teleconsulta

 

Objeto paciente

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chaveUnica

M

String

Chave de identificação do paciente

 

numeroContrato

M

String

Número do contrato do paciente

 

nome

M

String

Nome do paciente

 

integracao

OP

Objeto

Nó integração retornado no login do usuário

 

Objeto responsavelAtendimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chaveUnica

M

String

Chave de identificação do paciente

 

numeroContrato

M

String

Número do contrato do paciente

 

nome

M

String

Nome do paciente

 

integracao

OP

Objeto

Nó integração retornado no login do usuário

 

Objeto dadosContato

  • 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

nome

M

String

Nome do contato

 

celular

M

String

Celular do contato

 

email

M

String

Email do contato

 

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/gravarConsulta

Body:
{
    "chaveUnica":"101012",
    "integracao":{
      "xpto":"voluptatibus",
      "xyz":"quibusdam",
      "abcdef":9288701
    },
    "tipoAgenda":"1",
    "paciente":{
      "chaveUnica":"101012",
      "numeroContrato":"616161",
      "integracao":{
        "xpto":"voluptatibus",
        "xyz":"quibusdam",
        "abcdef":9288701
      }
    },
    "responsavelAtendimento":{
      "chaveUnica":"3321",
      "numeroContrato":"444456789",
      "integracao":{
        "xpto":"voluptatibus",
        "xyz":"quibusdam",
        "abcdef":9288701
      }
    },
    "dadosContato:":{
      "nome":"Nome do contato",
      "celular":"289999999999",
      "email":"email@teste.com"
    },
    "idEspecialidade":"716171919",
    "idLocal":"818181",
    "idProfissional":"81818",
    "idAgenda":"123123",
    "dataHora":"2022-02-01 11:30:00"
}

 

  • Sem rótulos