Só são suportadas integrações no padrão REST.
Introdução
Método de listagem dos indicadores favoritos do paciente
Método "aps/atividade/realizaAtividade"
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/indicadores/resposta Atenção O endpoint obrigatoriamente deve terminar com “/atividade/realizaAtividade | 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 | String | Codigo identificador da atividade | |
idAtendimento | M | String | Codigo identificador do atendimento | |
idTipoAtendimento | M | String | Codigo identificador do tipo de atendimento | |
idQuestionario | M | String | Codigo identificador do questionario cadastrado no previva | |
formData | M | Array | Array de objetos do tipo "resposta" |
|
{ "chaveUnica":"String", "integracao":{ Objeto }, "beneficiario":{ Objeto } "idAtividade": "String", "idAtendimento": "String", "idTipoAtendimento": "String", "idQuestionario": "String" "formData": [Objeto] }
Objeto beneficiario
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
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 “resposta"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
indicador | M | Numer | Codigo identificador da pergunta cadastrada no Previva | Será feito um mapeamento dos IDs dos indicadores no previva para alimentar o campo API do formulário na mobile saude. Dessa forma, a key dos formularios da mobile terão a mesma chave que os indicadores do previva. |
respostas | 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. |
{ "formData": [ { "indicador": "Number", "respostas": [itemResposta] } ], }
Objeto “itemResposta"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
chave | M | Numer | Codigo identificador da pergunta cadastrada no Previva | Atenção Deve ser informado null quando for um campo do tipo string ou numerico. |
valor | M | ANY | Valor da resposta da pergunta, não possui tipo definido. |
|
{ "formData": [ { "indicador": "Number", "respostas": [ { "chave": "Number", "valor": "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":"39", "idAtendimento":"39", "idTipoAtendimento":"39", "idQuestionario": 1, "formData":[ { "indicador": "39", "respostas":[ { "chave": null, "valor": 72.8, } ] }, { "indicador": "observacao", "respostas":[ { "chave": null, "valor": "texto da observação", } ] }, { "indicador": "justificativa", "respostas":[ { "chave": null, "valor": "texto da justificativa", } ] }, { "indicador": "dataResultado", "respostas":[ { "chave": null, "valor": "10/06/2024", } ] } ] }
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 |
---|---|---|---|---|
protocolo | M | String | Numero de protocolo gerado pelo sistema da PREVIVA. |
|
mensagem | M | String | Mensagem amigável que será exibida para o usuário |
|
{ "protocolo": "String", "mensagem": "String", }
Retorno da API - Sucesso
{ "protocolo": "123", "mensagem": "Sucesso!" }
Retorno da API - Falha
{ "mensagem": "Não foi possível registrar a sua inscrição..." }
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;