⁠⁠API Buscar Última Resposta do Indicador

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

Introdução

Método de listagem dos ultimos resultados indicadores favoritos do paciente

⁠⁠API Buscar Últimos Resultados de Indicadores
⁠⁠API Buscar Última Resposta do Indicador

Método "aps/indicadores/favoritos/ultimasRespostas"

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 / aps/indicadores/favoritos/ultimasRespostas Atenção O endpoint obrigatoriamente deve terminar com “/indicadores/favoritos/ultimasRespostas	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
beneficiario	M	Objeto	Beneficiario selecionado para agendamento da consulta
quantidadeRespostas	M	Number	Indica o numero maximo de respostas que devem ser retornadas de cada indicador
idTurma	OP	Number	Indica o id da turma	Filtra os indicadores da turma enviada

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    }
}

Objeto beneficiario

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
integracao	OP	Objeto	Nó integração retornado no login do usuário

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

Exemplo request

{
  "chaveUnica": "101012",
  "integracao": {
    "cpf": "123456789123",
    "numero_cartao": "9288701",
  },
  "beneficiario": {
    "chaveUnica": "101012", //geralmente é o cpf
    "numeroContrato": "616161",
    "integracao": {
        "cpf": "123456789123", 
        "numero_cartao": "9288701",
      },
  },
}

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
indicadores	M	Array de objetos do tipo "indicador"

Objeto “indicador"

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigoIndicador	M	Numer	Codigo identificador do indicador cadastrado no Previva
nome	M	String	Nome do indicador
descricao	OP	String	Descrição do indicador
categoria	M	Objeto do tipo item	Categoria do indicador	Enum de categorias
unidadeMedida	OP	Objeto do tipo item	Unidade de medida do indicador
dataUltimaAtualizacao	OP	String	Data da ultima atualização	Formato esperado: `YYYY-MM-DD HH:mm:ss`
valorUltimaAtualizacao	OP	Array	Array de objetos do tipo itemResposta	Os endpoint da previva possuem uma interface com tipagem forte, sendo assim, um atributo do tipo ANY (String, Objeto, Array, Number) não poderia ser utilizado. Foi proposto a padronizaçao da resposta através de um parametro do tipo array contendo um objeto com chave e valor.
historicoRespostas	M	Array	Array de objetos do tipo historicoResposta

Objeto “historicoResposta"

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

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

responsavel

M

Objeto do tipo “item"

Indica o responsável pela resposta do indicador

Enum:

1 = Beneficiario

2 = Profissional

data

M

String

Data da ultima atualização

Formato esperado:

YYYY-MM-DD HH:mm:ss

valor

M

Array

Array de objetos do tipo itemResposta

Os endpoint da previva possuem uma interface com tipagem forte, sendo assim, um atributo do tipo ANY (String, Objeto, Array, Number) não poderia ser utilizado. Foi proposto a padronizaçao da resposta através de um parametro do tipo array contendo um objeto com chave e valor.

Objeto “itemResposta"

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
chave	M	Numer	Codigo identificador da pergunta cadastrada no Previva
valor	M	ANY	Valor da resposta da pergunta, não possui tipo definido.

Objeto “item"

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigo	M	Numer	Codigo identificador do item
descricao	M	String	Descrição do item

Mosia Omnichannel Parceiros