Estrutura de retorno de agendas (Payload Cliente) V2

Tópicos

1 1- Request
- 1.1 1.1- Especificação do endpoint
- 1.2 1.2- Formato do endpoint completo
2 2- Response
3 3- Retorno

1- Request

1.1- Especificação do endpoint

Endpoint	Tipo	Parâmetros QueryString	Observações

Endpoint	Tipo	Parâmetros QueryString	Observações
dominio/telemedicina/agenda	GET	id_prestador=123 data_referencia=2021-05-01	O “endpoint” foi passado apenas de exemplo, não temos restrição quanto ao seu formato. O “id_prestador” é referente ao id do usuário no sistema do cliente. A “data_referencia“ seria a data dos agendamentos, exemplo: 2021-05-01.

1.2- Formato do endpoint completo

http://dominio_operadora/telemedicina/agenda?id_prestador=123&data_referencia=2021-05-01

2- Response

2.1- Objeto “raiz” do retorno

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`status`	boolean	Status do response, indica se todo o processo ocorreu corretamente para o retorno. Retorno vazio também se caracteriza status TRUE.
`data`	object	Objeto que reúne todo o conjunto de dados

2.2- Objeto “data” do retorno

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`profissional`	object	Objeto com informações do médico
`agenda`	object	Objeto com informações do agendamento

2.3- Objeto “profissional” do retorno

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`nome`	string	Nome do médico
`numeroConselho`	string	Número do conselho do médico
`siglaConselho`	string	Sigla do conselho do médico
`ufConselho`	string	UF do conselho do médico
`especialidade`	string	Especialidade do médico
`cpfCnpj`	string	CPF/CNPJ do médico
`idChaveUnica`	string	ID do médico

2.4- Objeto “agenda” do retorno

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`localAtendimentoId`	string	ID do local de atendimento
`localAtendimentoNome`	string	Nome do local de atendimento
`horarios`	array	Retorno de agendamentos

2.5- Objeto “horario” do retorno do array “horarios“

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`idAgenda`	string	ID da agenda
`data`	string	Data do agendamento (aaaa-mm-dd)
`hora`	array	Hora do agendamento (hh:mm)
`paciente`	object	Objeto com informações do paciente
`mensageria`	object	Objeto com informações do Mensageria
`status`	object	Objeto com informações do status do agendamento
`especialidade`	object	Objeto com informações da especialidade
`tipoAgenda`	object	Objeto com informações do tipo de agenda
`atendimentoSimplificado`	boolean	Campo não obrigatório, padrão false. Indica que o agendamento será de forma simplificada. Com este modo ativado, não será possível o uso da vídeo chamada, o médico vai iniciar o chamado no Mosia (sem vídeo) para utilizar os recursos como prontuário, prescrições, registro de atendimento, entre outros recursos. O paciente neste caso não tem a necessidade de ter um login/app instalado. O contato do médico com o paciente seria por telefone.
`operadoraId`	integer	Campo não obrigatório. Recebe o ID da operadora.
`operadoraNome`	string	Campo não obrigatório. Recebe o nome da operadora

2.6- Objeto “paciente” do retorno do array “horarios“

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`nome`	string	Nome do paciente
`email`	string	Email do paciente
`celular`	string	Celular do paciente
`matricula`	string	Matrícula do paciente
`cpf`	string	CPF do paciente
`idChaveUnica`	string	Login do usuário no app

2.7- Objeto “mensageria” do retorno do array “horarios“

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`localizador`	string	Localizador Mensageria. Este conteúdo deve coincidir com a chave da mensageria enviada no login do app da plataforma do beneficiário

2.8- Objeto “status” do retorno do array “horarios“

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`id`	string	ID do status
`nome`	string	Nome do Status
`corLabel`	string	Hexadecimal para renderização da cor da label, exemplo: “#ff0000”

2.9- Objeto “especialidade” do retorno do array “horarios“

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`id`	string	ID da especialidade
`nome`	string	Nome do especialidade

2.10- Objeto “tipoAgenda” do retorno do array “horarios“

Campos	Tipo	Descrição

Campos	Tipo	Descrição
`id`	string	ID do tipo de agenda
`nome`	string	Nome do tipo de agenda

3- Retorno

3.1- Retorno de sucesso (StatusCode 200)

{
  "status": true,
  "data": {
    "profissional": {
      "nome": "Dr. João Passos",
      "numeroConselho": "101010",
      "siglaConselho": "CRM",
      "ufConselho": "DF",
      "especialidade": "Cardiologia",
      "cpfCnpj": "10010010000",
      "idChaveUnica": "12321"
    },
    "agenda": {
      "localAtendimentoId": "1234",
      "localAtendimentoNome": "Unidade Virtual",
      "horarios": [
        {
          "idAgenda": "101004",
          "data": "2020-03-24",
          "hora": "10:00",
          "paciente": {
            "nome": "Rafael Simão AG: 1001010",
            "email": "rafael@mobilesaude.com.br",
            "celular": "27999999999",
            "matricula": "000001",
            "cpf": "99999999999",
            "idChaveUnica": "rafael@mobilesaude.com.br"
          },
          "mensageria": {
            "localizador": "rafael@mobilesaude.com.br"
          },
          "status": {
            "id": "0",
            "nome": "Agendado",
            "corLabel": "#E7A566"
          },
          "especialidade": {
            "id": "223910",
            "nome": "Ortoptista"
          },
          "tipoAgenda": {
            "id": "0",
            "nome": "Consulta"
          },
          "operadoraId": 0,
          "operadoraNome": "Portal Saúde"
        }
      ]
    }
  }
}

3.2- Retorno de sucesso, sem conteúdo (StatusCode 200). Neste caso não há atendimento para o dia requisitado.

{
  "status": true,
  "data": {
    "profissional": {
      "nome": "Dr. João Passos",
      "numeroConselho": "101010",
      "siglaConselho": "CRM",
      "ufConselho": "DF",
      "especialidade": "Cardiologia",
      "cpfCnpj": "10010010000",
      "idChaveUnica": "12321"
    },
    "agenda": {
      "horarios": []
    }
  }
}

3.3- Retorno de erro (StatusCode 200)

{
    "status": false,
    "msg": "Texto com a descrição do erro para impressão na interface do atendente"
}