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.

...

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

 

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

 

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
{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "tipoAgenda":"String",
    "paciente":{ Objeto }
    },
    "responsavelAtendimento":{ Objeto }
    },
    "dadosContato:":{ Objeto },
    "idEspecialidade":"String",
    "idLocal":"String",
    "idProfissional":"String",
    "idAgenda":"String",
    "dataHora":"YYYY-MM-DD hh:mm:ss",
    "idMeeting": "String"
}

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

 

...

Bloco de código
languagejson
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",
    "idMeeting": "6422f5253333f63b0e9e183f"
}

 

Descrição dos objetos e atributos de retorno - Sucesso

...