APS - Gravar consulta

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

Introdução

Método de listagem de atividades do programa de APS

Método "aps/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
exemplo.com / aps/gravarConsulta Atenção O endpoint obrigatoriamente deve terminar com “/aps/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
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
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	OP	String	Quando enviado deve retornar dados do detalhe da agenda do profissional. O array de profissionais deve conter somente um 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.

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    },
    "idAtividade:": Number,
    "idTipoAtividade": Number,
    "idTipoAtendimento": Number,
    "idLocal": Number,
    "idProfissional": Number,
    "idAgenda": Number,
    "dataHora":"YYYY-MM-DD hh:mm:ss",
    "dadosContato:":{ Objeto },
    "idMeeting": "String"
}

Objeto beneficiario

Atributo	Critério	Tipo	Descrição
chaveUnica	M	String	Chave de identificação do paciente
numeroContrato	M	String	Número do contrato do paciente
integracao	OP	Objeto	Nó integração retornado no login do usuário

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

Exemplo request

{
  "chaveUnica": "101012",
  "integracao": {
    "cpf": "123456789123",
    "numero_cartao": "9288701",
  },
  "beneficiario": {
    "chaveUnica": "101012", //geralmente é o cpf
    "numeroContrato": "616161",
    "integracao": {
        "cpf": "123456789123", 
        "numero_cartao": "9288701",
      },
  },
  "idAtividade":123,  
  "idRegiao":123,
  "idProfissional",
  "idTipoAtendimento": 123,
  "idTipoAtividade":123,
  "idLocal": 1,
  "idAgenda": 1,
  "dataHora":"2024-05-16 14:20:00",
  "dadosContato:":{
      "nome":"Nome do contato",
      "celular":"289999999999",
      "email":"email@teste.com"
  },
  "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
profissionaisAgendas	M	Array	Array de objetos de dataProfissionais

{
  "profissionaisAgendas": [ Array-Objetos ]
}

Objeto 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

{
"profissionaisAgendas": [
    {
      "data": "YYYY-MM-DD",
      "profissionais": [ Array-objetos ]
    }
  ]
}

Objeto profissional

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
nome	M	String	Nome do profissional	Texto livre
id	M	String	id do profissional
urlFoto	OP	String	URL da foto do profissional
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": [
    {
      "profissionais": [
        {
          "id": "String",
          "nome": "String",
          "urlFoto": "String",
          "conselho": "String",
          "localAtendimento": { 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

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

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

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

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

{
  "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":[]
      }
    ]
}

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;