Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Índice
Dica

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

...

Informações

Endpoint

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ / gravarConsulta

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/gravarConsulta

POST

application/json

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

...

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

 

idServico

OP

String

Id do tipo de serviço

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

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

 

responsavelAtendimento

OP

Objeto

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

 Informe os dados do responsável por interagir com a teleconsulta, do lado do paciente. Exemplo: nos casos onde quem está agendando é o responsável por uma criança que não possua um telefone celular, aqui será passado o responsável pelo dispositivo.

IMPORTANTE: NÃO REPASSE AQUI O MÉDICO QUE VAI SER AGENDADO. ESTE CONTEÚDO É DESTINADO AO RESPONSÁVEL PELO PACIENTE

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
languagejson
{
    "paciente":{
      "chaveUnica":"String",
      "numeroContrato":"String",
      "integracao":{ Objeto }
}

Nota

IMPORTANTE

Neste objeto se faz necessário passar os dados do BENEFICIÁRIO responsável, exemplo:

  • Gravação de consulta para a beneficiária que é dependente:

    • Os atributos deste objeto podem ser preenchidos com as informações da própria beneficiária dependente;

    • Os atributos deste objeto podem ser preenchidos com as informações do beneficiário titular;

Objeto responsavelAtendimento

...

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

Valor único, não podendo se repetir.

Bloco de código
languagejson
{
  "numeroProtocolo":"String",
  "paciente":{ Objeto },
  "profissional":{ Objeto }
  },
  "agenda":{ Objeto }
}

...

Aviso