Comparação de Páginas

Í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

Bloco de código

language	json

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

Objeto paciente

Atributo	Critério	Tipo	Descrição
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

language	json

{
    "paciente":{
      "chaveUnica":"String",
      "numeroContrato":"String",
      "integracao":{ Objeto }
}

Objeto responsavelAtendimento

Atributo	Critério	Tipo	Descrição
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

language	json

{
    "responsavelAtendimento":{
      "chaveUnica":"String",
      "numeroContrato":"String",
      "integracao":{ Objeto }
}

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
nome	M	String	Nome do contato
celular	M	String	Celular do contato
email	M	String	Email do contato

Bloco de código

language	json

{
    "dadosContato:":{
      "nome":"String",
      "celular":"String",
      "email":"String"
    }
}

Exemplo request

Bloco de código

language	json

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

...

Atributo	Obrigatório	Tipo	Descrição
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

language	json

{
  "numeroProtocolo":"String",
  "paciente":{ Objeto },
  "profissional":{ Objeto }
  },
  "agenda":{ Objeto }
}

Objeto paciente

Atributo	Obrigatório	Tipo	Descrição
nome	M	String	Nome do paciente
chaveUnica	M	String	Chave unica do paciente
telefone	M	String	Telefone do paciente

Bloco de código

language	json

{
  "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	String	Texto de informação do conselho do profissional
especialidade	M	Objeto especialidade	Objeto com dados da especialidade do profissional

Bloco de código

language	json

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

language	json

{
  "profissional":{
    "especialidade":{
      "id":"String",
      "descricao":"String"
    }
  }
}

Objeto agenda

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

language	json

{
  "agenda":{
    "idAgenda":"String",
    "dataHora":"YYYY-MM-DD hh:mm:ss"
  }
}

Retorno da API - Sucesso

Bloco de código

language	json

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

...

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

Exemplo request

Retorno da API - Sucesso