8.14 - Gravar consulta Cabine de Atendimento

1 Método "gravarConsulta"
2 Endpoint

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

Método "gravarConsulta"

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
http://exemplo.com/ / gravarConsultaCabine Atenção O endpoint obrigatoriamente deve terminar com “/gravarConsultaCabine	POST	application/json

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição

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
dadosContato	OP	Objeto	Objeto com dados do contato referente ao formulário de contato
idCabine	M	String	ID do registro da cabine no seu sistema.
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.

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "paciente":{ Objeto }},
    "dadosContato:":{ Objeto },
    "idCabine":"String",
    "idMeeting": "String"
}

Objeto paciente

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

{
    "paciente":{
      "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	Regra de preenchimento

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

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

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
descricaoCabine	M	String	Texto descritivo
paciente	M	Objeto	Objeto com dados do paciente
posicaoFila	M	Number	Numero da posição na fila
idSenha	M	String	Identificador da posição na fila do paciente.	Id de banco de dados da consulta no seu sistema interno

Objeto paciente

Atributo	Critério	Tipo	Descrição

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

Retorno da API - Sucesso

Retorno da API - Falha

Objetos e atributos de retorno

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
mensagem	M	String	mensagem para ser exibida para o cliente	texto livre

Mosia Omnichannel