Versões comparadas

Version Versão antiga 3 Nova versão Atual
Alterações feitas por

Everson Delmaschio

Otto Freitas Quintanilha

Gravado em

Chave

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

...

gravarConsulta

Endpoint

Método

Header Content-Type

Descrição

Atenção

O endpoint obrigatoriamente deve terminar com “/aps/

exemplo.com / aps/locaisAtendimento

Nota

POST

application/json

 

Parâmetros de entrada

...

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

 

beneficiario

M

Objeto

Beneficiario selecionado para agendamento da consulta

 

idAtividade

M

Number

ID da atividade cadastrada pelo PREVIVA

idAtendimento

M

Number

ID do atendimento cadastrada pelo PREVIVA

idLocal

OP

String

Id do local da consulta

Obrigatório quando agendamento presencial

IdTipoAtividade

OP

Number

ID do tipo de atividade cadastrado pela PREVIVA

ID do tipo de atividade selecionado na etapa de seleção de tipo de consulta.

Identifica o tipo de consulta:

  • Presencial

  • teleconsulta

IdTipoAtendimento

MOP

Number

ID do tipo de atendimento retornado no payload do endpoint de: Lista de agendas dos profissionais selecionado na tela de seleção de tipo de atendimento

idProfissional

OPM

String

ID do profissional

 

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

 

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
{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    },
    "idAtividade:": Number,
    "idTipoAtividade": Number,
    "idTipoAtendimento": Number,
    "idLocal": Number,
    "idProfissional": Number,
    "idAgenda": Number,
    "dataHora":"YYYY-MM-DD hh:mm:ss",
    "dadosContato:":{ Objeto },
    "idMeeting": "String"
}

...

  • 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

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

Bloco de código
{
 
  "idAtividadechaveUnica": "908101012",
 
  "idLocalintegracao": "1",{
    "idProfissionalcpf": "95123456789123",
    "idTipoAtendimentonumero_cartao": "89288701",
  },
  "dataHorabeneficiario": "2024-05-08 17:35",{
    "idAgendachaveUnica":"2024-05-08 17:35 "101012", //geralmente é o cpf
"dadosContato": {   "numeroContrato": "616161",
    "nomeintegracao":"Nome do{
contato",         "celularcpf": "27992293372123456789123", 
        "emailnumero_cartao": "everson@mobilesaude.com.br"9288701",
      },
  },
  "idMettingidAtividade": "123",  
  "chaveUnicaidRegiao":123,
  "34261753987idProfissional",
 
  "integracaoidTipoAtendimento": {123,
        "cpf"idTipoAtividade": "34261753987",
  123,
     "numero_cartao"idLocal": "01000160600"
    },
1,
   "beneficiarioidAgenda": {1,
        "chaveUnica"dataHora": "34261753987",
   "2024-05-16 14:20:00",
    "numeroContratodadosContato:": "907337",
{
       "integracaonome":"Nome {
  do contato",
         "cpfcelular": "34261753987289999999999",
     
      "numero_cartaoemail": "01000160600"
     email@teste.com"
  },
  "idMeeting": "6422f5253333f63b0e9e183f" }
}

 

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

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

 Objeto principal

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

 

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

 

Objeto paciente

Atributo

Critério

Tipo

Descrição

nome

M

String

Nome do paciente

chaveUnica

M

String

Chave unica do paciente

telefone

M

OP

String

Telefone do paciente

Bloco de código
{
  "paciente":{
    "chaveUnica":"String",
    "nome":"String",
    "telefone":"String"
  }
}

 

Objeto profissional

Atributo

Obrigatório

Tipo

Descrição

id

M

String

Id do profissional

nome

M

String

Telefone do paciente

conselho

M

OP

String

Texto de informação do conselho do profissional

especialidade

M

OP

Objeto especialidade

Objeto com dados da especialidade do profissional

Bloco de código
{
  "profissional":{
    "id":"String",
    "nome":"String",
    "conselho":"String",
    "especialidade":{ Objeto }
  }
}

 

Objeto especialidade

Atributo

Obrigatório

Tipo

Descrição

id

M

String

Id da especialidade

descricao

M

String

Texto de descrição da especialidade

Bloco de código
{
  "profissional":{
    "especialidade":{
      "id":"String",
      "descricao":"String"
    }
  }
}

 

Objeto agenda

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

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

Bloco de código
{
  "agenda":{
    "idAgenda":"String",
    "dataHora":"YYYY-MM-DD hh:mm:ss"
  }
}

...

Aviso