Comparação de Páginas

...

Endpoint	Método	Header Content-Type	Descrição
exemplo.com / aps/gravarConsulta	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	OP	Number	ID do tipo de atendimento selecionado na tela de seleção de tipo de atendimento
idProfissional	OPM	String	Quando enviado deve retornar dados do detalhe da agenda do profissional. O array de profissionais deve conter somente um profissional	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.

...

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

...

Atributo	Critério	Tipo	Descrição
nome	M	String	Nome do contato
celular	M	String	Celular do contato
email	M	String	Email do contato

...

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

profissionaisAgendas

paciente

M

Array

Array de objetos de dataProfissionais

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

data

M

String

Data da agenda

Deve conter o seguinte formato

Formato: YYYY-MM-DD

profissionais

M

Array

Array de objeto profissional

Objeto

Objeto com dados do paciente

Bloco de código
{ "profissionaisAgendas": [ Array-Objetos ] }

Objeto dataProfissionais

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
{ "profissionaisAgendasnumeroProtocolo": [ "String", "paciente":{ Objeto }, "profissional":{ Objeto } }, "dataagenda": "YYYY-MM-DD", "profissionais": [ Array-objetos ] } ] { Objeto } }

Objeto profissionalpaciente

Atributo	Critério	Tipo	Descrição

Regra de preenchimento

nome

M

String

Nome do

profissional

Texto livre

id

paciente
chaveUnica	M	String

id

Chave unica do

profissional

paciente

telefone

urlFoto

OP

String

URL da foto

Telefone do

profissional

paciente

conselho

M

String

Texto de informação do conselho do profissional

Texto Livre.

Ex: "CRM ES 123123"

localAtendimento

M

Objeto

Objeto com dados sobre o local de atendimento

Objeto do tipo localAtendimento

especialidade

M

Objeto

Objeto com dados da especialidade do profissional

Objeto do tipo especialidade

horarios

M

Array

Array de horarios disponíveis para atendimento

Array de objetos horario

{ "profissionaisAgendas": [ {

Bloco de código
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	OP	String	Texto de informação do conselho do profissional
especialidade	OP	Objeto especialidade	Objeto com dados da especialidade do profissional

Bloco de código
{ "profissional":{ "id":"String", "profissionaisnome":"String", [ { "id"conselho": "String", "nomeespecialidade":{ "String",Objeto } "urlFoto": "String",} }

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":{ "conselhoid": "String", "localAtendimentodescricao":"String" { Objeto }, } "especialidade": { Objeto }, "horarios": [ Array-objetos ] } ] } ] }

Objeto localAtendimento

...

Atributo

...

Critério

...

Tipo

...

Descrição

...

Regra de preenchimento

...

descricao

...

M

...

String

...

Texto de descrição do local de atendimento

...

Texto livre

Ex:”Em atendimento em Local XPTO"

...

id

...

M

...

String

...

id do local de atendimento

...

Bloco de código
{ "profissionaisAgendas": [ { "profissionais": [ { "localAtendimento": { "id": "String", "descricao": "String" } } ] } ] }

Objeto especialidade

...

Atributo

...

Critério

...

Tipo

...

Descrição

...

Regra de preenchimento

...

descricao

...

M

...

String

...

Texto de descrição da especialidade

...

Texto livre

EX:”clinica geral"

...

id

...

M

...

String

...

id da especialidade

...

Bloco de código
{ "profissionaisAgendas": [ { "profissionais": [ { "especialidade": { "descricao": "String", "id": "String" } } ] } ] }

Objeto horario

...

Atributo

...

Critério

...

Tipo

...

Descrição

...

Regra de preenchimento

...

idAgenda

...

M

...

String

...

id da agenda

...

dataHora

...

Data e hora disponível

...

Deve conter dia e hora.

Formato: YYYY-MM-DD hh:mm:ss

Bloco de código
{ "profissionaisAgendas": [ { "profissionais": [ { "horarios": [ { "idAgenda": "String", "dataHora": "YYYY-MM-DD hh:mm:ss" } ] } ] } ] }

Retorno da API - Sucesso Caso o atributo data (que é opcional) no body da requisição for preenchido

Bloco de código

{
  "profissionaisAgendas": [
    {
      "data": "2022-03-01",
      "profissionais": [
        {
          "id": "121212",
          "nome": "Dr Joaquim Das Neves",
          "urlFoto": "https://randomuser.me/api/portraits/men/80.jpg",
          "conselho": "CRM-ES 918171",
          "localAtendimento": {
            "id": "x1817",
            "descricao": "Em atendimento em Local Xpxy"
          },
          "especialidade": {
            "descricao": "clinica geral",
            "id": "01928"
          },
          "horarios": [
            {
              "idAgenda": "121212",
              "dataHora": "2022-03-01 11:40:00"
            },
            {
              "idAgenda": "121212",
              "dataHora": "2022-03-01 13:40:00"
            },
            {
              "idAgenda": "121212",
              "dataHora": "2022-03-01 14:40:00"
            }
          ]
        },
        {
          "id": "2",
          "nome": "Dr. Carlos Alberto de Souza",
          "conselho": "CRM-ES 31312312",
          "localAtendimento": {
            "id": "1",
            "descricao": "Atendimento em Hospital São José"
          },
          "especialidade": {
            "id": "1",
            "descricao": "Clínico Geral"
          },
          "horarios": [
            {
              "idAgenda": "1",
              "dataHora": "2022-03-01 11:30:00"
            },
            {
              "idAgenda": "2",
              "dataHora": "2022-03-01 13:00:00"
            },
            {
              "idAgenda": "5",
              "dataHora": "2022-03-01 15:00:00"
            },
            {
              "idAgenda": "6",
              "dataHora": "2022-03-01 16:00:00"
            }
          ]
        }
      ]
    }
  ]
}

Exemplo de retorno com "sucesso” - Caso o atributo idProfissional no body da requisição for preenchido e o atributo data for preenchido

Bloco de código

{
  "profissionaisAgendas":[
      {
        "data":"2022-02-01",
        "profissionais":[]
      },
      {
        "data":"2022-02-03",
        "profissionais":[]
      },
      {
        "data":"2022-02-04",
        "profissionais":[]
      },
      {
        "data":"2022-02-07",
        "profissionais":[
          {
            "id":"1",
            "nome":"Dr. Pedro Paulo Pereira",
            "conselho":"CRM-ES 918171",
            "urlFoto":"https://randomuser.me/api/portraits/men/80.jpg",
            "localAtendimento":{
              "id":"123",
              "descricao":"Hospital São José"
            },
            "especialidade":{
              "id":"9191919",
              "descricao":"Clínico Geral"
            },
            "horarios":[
              {
                "idAgenda":"3",
                "dataHora":"2022-02-07 10:30:00"
              },
              {
                "idAgenda":"4",
                "dataHora":"2022-02-07 11:30:00"
              },
              {
                "idAgenda":"5",
                "dataHora":"2022-02-07 13:00:00"
              },
              {
                "idAgenda":"8",
                "dataHora":"2022-02-07 15:00:00"
              },
              {
                "idAgenda":"9",
                "dataHora":"2022-02-07 16:00:00"
              },
              {
                "idAgenda":"9",
                "dataHora":"2022-02-07 17:00:00"
              }
            ]
          }
        ]
      },
      {
        "data":"2022-02-09",
        "profissionais":[]
      },
      {
        "data":"2022-02-10",
        "profissionais":[]
      },
      {
        "data":"2022-02-11",
       "profissionais":[]
      },
      {
        "data":"2022-02-15",
        "profissionais":[]
      },
      {
        "data":"2022-02-17",
        "profissionais":[]
      },
      {
        "data":"2022-02-18",
       "profissionais":[]
      },
      {
        "data":"2022-02-21",
        "profissionais":[]
      },
      {
        "data":"2022-02-23",
        "profissionais":[]
      }
    ]
}}
}

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" } }

Retorno da API - Sucesso

Bloco de código

{
  "numeroProtocolo":"001002003004005",
  "paciente":{
    "chaveUnica":"123123",
    "nome":"Nome paciente",
    "telefone":"27 99999-9999"
  },
  "profissional":{
    "id":"1231231",
    "nome":"Dr João Silva",
    "conselho":"CRM-ES 123123",
    "especialidade":{
      "id":"123123",
      "descricao":"Cardiologia"
    }
  },
  "agenda":{
    "idAgenda":"123123",
    "dataHora":"2022-02-01 14:00:00"
  }
}

Retorno da API - Falha

Aviso
Atente-se as mensagens de retorno para cada HTTPS Status Code; Siga as instruções de Descrição dos objetos e atributos de retorno - falha;

...

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Parâmetros de entrada

Retorno da API - Sucesso Caso o atributo data (que é opcional) no body da requisição for preenchido

Exemplo de retorno com "sucesso” - Caso o atributo idProfissional no body da requisição for preenchido e o atributo data for preenchido

Retorno da API - Sucesso

Retorno da API - Falha