Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
  • Introdução

  • Método "gravarConsulta"

  • Endpoint

Dica

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/atividades/detalhe"

Informações

Endpoint

Endpoint

Método

Header Content-Type

Descrição

exemplo.com / aps/atividades

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/aps/atividades/detalhe

POST

application/json

Endpoint responsavel por obter o detalhe de uma atividade

 

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.

...

Bloco de código
{
    "beneficiario":{
      "chaveUnica":"String",
      "numeroContrato":"String",
      "integracao":{ Objeto }
}

Exemplo request

Bloco de código
{
  "chaveUnica": "101012",
  "integracao": {
    "cpf": "123456789123",
    "numero_cartao": "9288701",
  },
  "beneficiario": {
    "chaveUnica": "101012", //geralmente é o cpf
    "numeroContrato": "616161",
    "integracao": {
        "cpf": "123456789123", 
        "numero_cartao": "9288701",
      },
  },
  "idAtividade":123,
}

 

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.

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigoAtividade

M

Numer

Codigo identificador da pergunta cadastrada no Previvaatividade

 

codigoAtendimento

M

Number

ID Codigo identificador do atendimento cadastrada pelo PREVIVA

numeroProtocolo

OP

Numer

Numero de protocolo gerado pela atividade no sistema da PREVIVA

 

titulo

M

String

Titulo da atividade

 

descricao

OP

String

Descrição da atividade

 

programa

M

Objeto do tipo "programa"

 

 

situacao

M

Objeto do tipo "item"

Situação da atividade

Enum:

  • pendente,

  • em progresso,

  • em espera,

  • agendado,

  • executado,

  • concluido,

  • cancelado

agenda

C

Objeto do tipo "agenda"

Obrigatório quando a classificação do tipo de atendimento for "visita presencial"

 

dataSugerida

OP

String

Data “limite" sugerida para realização da atividade

 Formato esperado:

YYYY-MM-DD HH:mm:ss

dataRealizado

OP

String

Data na qual a atividade foi realizada

 Formato esperado:

YYYY-MM-DD HH:mm:ss

regiao

OP

Objeto do tipo "itemObjeto do tipo item"

Enviado em caso de consulta presencial

classificacaoTipoAtendimentotipoAtendimento

M

Objeto do tipo item"tipoAtendimento"

 

proximoAtendimento

OP

Objeto do tipo item

classificação do tipo de atendimento

  • Agendamento

  • visita presencial

  • Atividade educacional

  • Questionario

tipoAtendimento
"tipoAtendimento"

 

tipoAtividade

M

Objeto do tipo item

Objeto do tipo item

 

proximoAtendimento

OP

Objeto

Objeto do tipo
"tipoAtendimento"

 
"tipoAtividade"

modoAtendimento

M

Objeto do tipo “item"

 

Bloco de código
{
      "codigoAtividade":" Number,
      "codigoAtendimento":" Number,
      "numeroProtocolo": "String"
      "titulo":"String",
      "descricao":"String",
      "programa":"Objeto",
      "situacao":"Objeto",
      "agenda":"Objeto",
      "dataSugerida": "String",
      "dataRealizado": "String",
      "regiao":"Objeto",
      "tipoAtendimento":"Objeto",
      "classificacaoTipoAtendimentotipoAtividade": "Objeto",
      "tipoAtendimentomodoAtendimento":"Objeto",
      "proximoAtendimento":"Objeto",
}

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

Number

Codigo identificador do item

 

titulo

M

String

Titulo do item

descricao

M

String

Descrição do item

 

classificacaoTipoAtendimento

M

Objeto do tipo "item"Objeto

classificação do tipo item de atendimento

  • Agendamento

  • visita presencial

  • Atividade educacional

  • Questionario

servico

MObjeto

Objeto do tipo "item"

Enum:

  • Remoto

  • Presencial

Bloco de código
{
    "codigo":"Number",
    "titulo":"String",
    "descricao":"String",
    "classificacaoTipoAtendimento": {
        "codigo":"string", 
        "descricao"Objeto":"string"
    },
    "servico": "Objeto"
}

 

Objeto "programatipoAtividade"

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

Numer

Codigo identificador do

porgrama

tipo de atividade

 

titulo

descricao

M

String

Titulo

Descrição do

programa

tipo de atividade

 

descricao

classificacaoTipoAtividade

OP

String

Descrição do programa

 

icone

OP

String

Icone do programa

 

grupos

OP

Array de objetos do tipo "grupo"

 

 

M

 Objeto do tipo "item"

classificação do tipo de atividade

documento

C

Objeto do tipo “documento"

curso

C

Objeto

idConteudoOrientacao

OP

String

idFormulario

OP

String

Bloco de código
{
    "programatipoAtividade": {
        "codigo": "string", 
 Number,       "titulodescricao":"Stringstring",
        "descricaoclassificacaoTipoAtividade":"String",{
            "iconecodigo":"Stringstring", 
            "gruposdescricao":[ "Objetostring"
   ],     }
}

 

...


        "documento": "Objeto",
        "curso": "Objeto"
        "idConteudoOrientacao": 123,
        "idFormulario": 123
    },
}

 

Objeto "documento"

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

Numer

Codigo identificador do tipo de atividade

 

titulo

M

String

Titulo do modelo de documento

descricao

M

String

Descrição modelo de documento

 

tipoDocumento

M

 Objeto do tipo "item"

classificação do tipo de atividade

idQuestionario

C

String

Codigo identificador do questionario

orientacoes

OP

String

tituloMensagem

OP

String

textoMensagem

OP

String

Bloco de código
{
    "tipoAtividade": {
        "modeloDocumento":{ //condicional, de acordo com a classficacao do tipo de atividade
            "codigo":123,
            "titulo":"Avaliação Tabagismo",
            "descricao":"A linha de cuidado atendimento primário a saúde é a linha de cuidado que...",
            "tipoDocumento":{
                "codigo":123, 
                "descricao":"questionario"
            },
            "orientacoes":"texto livre", //CONDICIONAL DE ACORDO COM O MODELO DO DOCUMENTO
            "tituloMensagem": "Titulo da mensagem", //CONDICIONAL DE ACORDO COM O MODELO DO DOCUMENTO
            "textoMensagem": "texto da mensagem", //HTML, texto livre CONDICIONAL DE ACORDO COM O MODELO DO DOCUMENTO
        }
    },
}

 

Objeto "programa"

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

Numer

Codigo identificador do porgrama

 

titulo

M

String

Titulo do programa

 

descricao

OP

String

Descrição do programa

 

icone

OP

String

Icone do programa

 

grupos

OP

Array de objetos do tipo "grupo"

 

 

Bloco de código
{
    "programa":{
      "codigo":" Number,
      "titulo":"String",
      "descricao":"String",
      "icone":"String",
      "grupos":[ "Objeto" ],
    }
}

 

Objeto "grupo"

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

Numer

Codigo identificador do grupo

 

titulo

M

String

Titulo do grupo

 

descricao

OP

String

Descrição do grupo

 

icone

OP

String

Icone do grupo

 

subgrupo

OP

Objeto do tipo subgrupo

 

 

Bloco de código
{
    "grupos":[
      {
        "codigo": Number,
        "titulo":"String",
        "descricao":"String",
        "icone":"String",
        "subgrupo":"Objeto",
      }
    ]
}

 

Objeto "subgrupo"

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

Numer

Codigo identificador do

grupo

subgrupo

 

titulo

M

String

Titulo do

grupo

subgrupo

 

descricao

OP

String

Descrição do

grupo

subgrupo

 

icone

OP

String

Icone

do grupo

 

subgrupo

OP

Objeto

do

tipo

subgrupo

 

 

Bloco de código
{
    "grupos":[
      {
   
    "codigo": Number,
   
    "titulo":"String",
   
    "descricao":"String",
  
     "icone":"String",
        "subgrupo":"Objeto",
      }
    ]
}

 

Objeto "subgrupo“item"

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

Numer

Codigo identificador do subgrupo

 

titulo

M

String

Numer

Titulo

Codigo identificador do

subgrupo

item

 

descricao

OP

M

String

Descrição do

subgrupo

item

 

icone

OP

String

Icone do subgrupo

 

Bloco de código
{
    "codigo": "Number",
    "titulodescricao":"String",
}

 

Objeto “agenda"

Consultar link da doc: 8.2 - Detalhe da consulta

Retorno da API - Sucesso

Bloco de código
{
   "descricaocodigoAtividade":"String",
  123,
  "iconecodigoAtendimento":"String"123,
}

 

Objeto “item"

...

Atributo

...

Critério

...

Tipo

...

Descrição

...

Regra de preenchimento

...

codigo

...

M

...

Numer

...

Codigo identificador do item

...

 

...

descricao

...

M

...

String

...

Descrição do item

...

 

Bloco de código
{
 
  "numeroProtocolo": "123",
  "codigotitulo":"Number "Médico - Agendar consulta",
 
  "descricao":"String",
}

 

Objeto “agenda"

Consultar link da doc: 8.2 - Detalhe da consulta

Retorno da API - Sucesso

Bloco de código
{ null, 
  "programa":{
    "codigo":11023,
    "codigoAtividadetitulo": 123, "Atendimento Primário a Saúde",
    "codigoAtendimento":123,
  "numeroProtocolo": "123",descricao": "A linha de cuidado atendimento primário a saúde é a linha de cuidado que...", //Parametro opcional
    "tituloicone": "Médico<link -da Agendar consultaimagem>",
    "descricaogrupo": null,{
   "programa":{     "codigo":11023, 123,
        "titulo": "Atendimento Primário a Saúde",

   "descricao": "A linha de cuidado atendimento primário a saúde é a linha de cuidado que..."descricao": "Grupo Xpto",
//Parametro   opcional     "icone":"<link da imagem>",
        "gruposubgrupo":{
          "codigo": 123,
          "titulo": "Atendimento Primário a Saúde",
          "descricao": "Grupo Xptoxpto",
          "icone":"<link da imagem>",
        "subgrupo":{
          "codigo":123,},
      },
  },
  "titulosituacao":{
 "Atendimento Primário a Saúde"codigo",
    : 123,
     "descricao": "xptoagendado",
  },
  "dataSugerida": "01/02/2024 09:00:00",
  "iconedataRealizado":"<link da imagem>01/02/2024 09:00:00",
  "tipoAtendimento": {
    }"codigo":25, 
     },
  },"descricao":"descricao do tipo de atendimenot",
    "situacaoclassificacaoTipoAtendimento":{
 
  "codigo": 123,     "descricaocodigo": "agendado"
  }123, 
 "dataSugerida": "01/02/2024 09:00:00",      "dataRealizadodescricao":"01/02/2024 09:00:00""Agendamento"
      },
     "tipoAtendimentomodoAtendimento":{
   {     "codigo":25 123,
        "descricao":"descricao do tipo de atendimenot", "Descricao"
      }
      "classificaoTipoAtendimentoservico":{
        "codigo": 123, 
        "descricao": "Agendamentoagendado"
      },
   },
    "tipoAtividade": {
        "codigo":123, 
        "descricao":"descricao do tipo de atividade",
        "classificaoTipoAtividadeclassificacaoTipoAtividade":{
            "codigo":123, 
            "descricao":"Agendamento"
        },
        "cursoidConteudoOrientacao":{} 123,
//condicional, de acordo com a classficacao do tipo de atividade"idFormulario": 123,
        "modeloDocumentocurso":{}, //condicional, de acordo com a classficacao do tipo de atividade
            "codigo":123,
    classficacao do tipo de atividade
        "titulomodeloDocumento":"Avaliação Tabagismo"{ //condicional, de acordo com a classficacao do tipo de     "descricao":"A linha de cuidado atendimento primário a saúde é a linha de cuidado que..."atividade
            "codigo":123,
            "tipoDocumentotitulo":{
   "Avaliação Tabagismo",
            "codigodescricao":123,"A linha de cuidado atendimento primário a saúde é a linha de cuidado que...",
    "descricao":"questionario"         "tipoDocumento":{
   },             "orientacoescodigo":"texto livre", //CONDICIONAL DE ACORDO COM O MODELO DO DOCUMENTO123, 
                "tituloMensagemdescricao":"questionario"
  "Titulo da mensagem", //CONDICIONAL DE ACORDO COM O MODELO DO DOCUMENTO},
            "textoMensagemorientacoes": "texto da mensagemlivre", //HTML, texto livre CONDICIONAL DE ACORDO COM O MODELO DO DOCUMENTO
            "idConteudoOrientacao": 123, DO DOCUMENTO
            "idFormulariotituloMensagem": 123
        } "Titulo da mensagem", //CONDICIONAL DE ACORDO COM O MODELO DO DOCUMENTO
       },     "servicotextoMensagem":{ "texto da mensagem", //HTML, texto livre CONDICIONAL DE ACORDO COM O "codigo": 123,
MODELO DO DOCUMENTO
       "descricao": "agendado" }
    },
    "proximoAtendimento":{
 
      "codigo":25,
 
      "titulo":"", 
        "descricao":"descricao do tipo de atendimenot",
 
      "classificaoTipoAtendimentoclassificacaoTipoAtendimento":{
 
          "codigo":123, 
 
          "descricao":"Agendamento"
 
        }
,
   },     "modoAtendimentoservico":{
          "codigo": 123,
          "descricao": "Descricaoagendado"
      },
    },
}

Retorno da API - Falha

Bloco de código
{
  "mensagem": "Não foi possível listar suas atividades"
}  
Aviso