8.9 - Pronto Atendimento - Gravar consulta

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
exemplo.com / gravarConsultaPA Atenção O endpoint obrigatoriamente deve terminar com “/gravarConsulta	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
idEspecialidade	OP	String	Id da especialidade
questionario	M	Objeto	Objeto dinâmico correspondente aos campos do questionário configurado na funcionalidade
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 }},
    "questionario:":{ Objeto },
    "idEspecialidade":"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 questionario

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

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/gravarConsultaPA

Body:
{
    "chaveUnica":"101012",
    "integracao":{
      "xpto":"voluptatibus",
      "xyz":"quibusdam",
      "abcdef":9288701
    },
    "paciente":{
      "chaveUnica":"101012",
      "numeroContrato":"616161",
      "integracao":{
        "xpto":"voluptatibus",
        "xyz":"quibusdam",
        "abcdef":9288701
      }
    },
    "idEspecialidade":"716171919",
    "idServico":"3321"
    "questionario":{}
    "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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
numeroProtocolo	M	String	Numero do protocolo gerado pela consulta
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
especialidade	OP	Objeto	Objeto especialidade

{
  "numeroProtocolo":"String",
  "paciente":{ objeto },
  "especialidade": { objeto },
  "posicaoFila": Number,
  "idSenha": "String"
}

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

{
  "paciente":{
    "chaveUnica":"String",
    "nome":"String",
    "telefone":"String"
  }
}

Objeto especialidade

Atributo	Obrigatório	Tipo	Descrição

Atributo	Obrigatório	Tipo	Descrição
id	M	String	Id da especialidade
descricao	M	String	Texto de descrição da especialidade

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

Retorno da API - Sucesso

{
    "numeroProtocolo":"001002003004005",
    "paciente":{
      "chaveUnica":"123123",
      "nome":"Nome paciente",
      "telefone":"27 99999-9999"
    },
    "especialidade":{
      "id":"123123",
      "descricao":"Cardiologia"
    },
    "posicaoFila": 10
    "idSenha": "6422f5253333f63b0e9e183f"
}

Retorno da API - Falha

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;

Mosia Omnichannel