Comparação de Páginas

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"

Informações
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/atividades

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/aps/atividades

POST

application/json

Endpoint responsavel por realizar a adesão no programa de APS

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",
      },
  },
  "idPrograma":123,
  "idGrupo":123,
  "idSubgrupo":123,
  "idTipoAtendimento": 123,
  "idTipoAtividade":123, 
  "dataInicial": "2023/06/01",
  "dataFinal": "2024/06/01"
}

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 atividade cadastrada no Previva
codigoAtendimento	M	Number	ID do atendimento cadastrada pelo PREVIVA
numeroProtocolo	OP	String	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
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`
classificacaoTipoAtendimentotipoAtendimento	M	Objeto	Objeto do tipo item“tipoAtendimento"	classificação do tipo de atendimento
tipoAtividade	M	Objeto	objeto do tipo item“tipoAtividade"	classificação do tipo de atendimentoatividade

Bloco de código

breakoutMode	wide

{
      "codigoAtividade":" Number,
      "codigoAtendimento":" Number,
      "numeroProtocolo": "String"
      "titulo":"String",
      "descricao":"String",
      "programa":"Objeto" ,
      "situacao":"Objeto" ,
      "dataSugerida": "String",
      "dataRealizado": "String",
      "classificacaoTipoAtendimentotipoAtendimento":"Objeto",
      "tipoAtividade":"Objeto",

}

Objeto "programatipoAtendimento"

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

porgrama

tipo de atendimento

titulo

descricao

OP

String

descricao

M

String

Titulo do programa

Descrição do

programa

tipo de atendimento

icone

classificacaoTipoAtendimento

OP

M

String

Objeto

Icone do programa

grupos

OP

Array de objetos do

Objeto do tipo "

grupo

classificacaoTipoAtendimento"

classificação do tipo de atendimento

wide

Bloco de código

breakoutMode

{
    "programatipoAtendimento": {
        "codigo": " Number,string", 
        "titulodescricao":"Stringstring",
        "descricaoclassificacaoTipoAtendimento":"String",{
            "iconecodigo":"Stringstring", 
     "grupos       "descricao":[ "Objeto" ],string"
        }
    },
}

Objeto "grupoclassificacaoTipoAtendimento"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigo	M	Numer	Codigo identificador da classificacao do

grupo

tipo de atendimento

titulo

descricao

OP

String

descricao

M

String

Titulo do grupo

Descrição do

grupo

icone

OP

String

Icone do grupo

subgrupo

OP

Objeto do tipo subgrupo

tipo de atendimento

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

Objeto "subgrupo"

...

Atributo

...

Critério

...

Tipo

...

Descrição

...

}
}

Objeto "tipoAtividade"

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

subgrupo

tipo de atividade

titulo

descricao

M

String

Titulo

Descrição do

subgrupo

tipo de atividade

descricao

classificacaoTipoAtividade

OP

M

String

icone

OP

String

Icone do subgrupo

Objeto

Descrição do subgrupo

Objeto do tipo "classificacaoTipoAtividade"

classificação do tipo de atividade

Bloco de código
{ "codigotipoAtividade": Number, { "titulocodigo": "Stringstring", "descricao":"Stringstring", "icone":"String", }

Objeto “item"

...

Atributo

...

Critério

...

Tipo

classificacaoTipoAtividade":{
            "codigo":"string", 
            "descricao":"string"
        }
    },
}

Objeto "classificacaoTipoAtividade"

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

do item

da classificacao do tipo de atividade
descricao	M	String	Descrição da classificacao do

item

tipo de atividade

Bloco de código

language	json

{
    "codigo": Number,{
    "classificacaoTipoAtividade":{
        "codigo":"string", 
        "descricao":"string"
    }
}

Objeto "programa"

Atributo	Critério	Tipo	Descrição
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
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
codigo	M	Numer	Codigo identificador do subgrupo
titulo	M	String	Titulo do subgrupo
descricao	OP	String	Descrição do subgrupo
icone	OP	String	Icone do subgrupo

Bloco de código
{ "codigo": Number, "titulo":"String", "descricao":"String", "icone":"String", }

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

language	json

{
    "codigo": Number,
    "descricao":"String",
}

Retorno da API - Sucesso

Bloco de código

language	json

{
    "atividades": [
      {
        "codigoAtividade": 123,
        "codigoAtendimento": 123,
        "numeroProtocolo": "123",
        "titulo": "Médico - Agendar consulta",
        "descricao": null, 
        "programa":{
          "codigo":11023,
          "titulo": "Atendimento Primário a Saúde",
          "descricao": "A linha de cuidado atendimento primário a saúde é a linha de cuidado que...", //Parametro opcional
          "descricaoicone":"String<link da imagem>",
}

Retorno da API - Sucesso

Bloco de código

language	json

{
          "atividadesgrupo": [
{
     {         "codigoAtividadecodigo": 123,
              "codigoAtendimentotitulo": 123 "Atendimento Primário a Saúde",
        "numeroProtocolo      "descricao": "123Grupo Xpto",
              "tituloicone": "Médico<link -da Agendar consultaimagem>",
         "descricao": null,    "subgrupo":{
     "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...", //Parametro opcional"descricao": "xpto",
                "icone":"<link da imagem>",
           "grupo":{   },
           "codigo": 123},
        },
     "titulo": "Atendimento Primário a Saúde",
   "situacao":{
          "descricaocodigo": "Grupo Xpto",
    123,
          "iconedescricao": "agendado"<link
 da imagem>",      },
        "subgrupodataSugerida":{        "01/02/2024 09:00:00",
        "codigodataRealizado":123,
       "01/02/2024 09:00:00",
        "titulotipoAtendimento": "Atendimento{
Primário a Saúde",                 "descricao": "xpto""codigo":25, 
               "iconedescricao":"<link da imagem>",descricao do tipo de atendimenot",
            "classificacaoTipoAtendimento":{
    },             }"codigo":123, 
       },         "situacaodescricao":{"Agendamento"
            "codigo": 123,}
        },
   "descricao": "agendado",    "tipoAtividade": {
   },         "dataSugeridacodigo": "01/02/2024 09:00:00",123, 
            "dataRealizadodescricao":"01/02/2024 09:00:00",descricao do tipo de atividade",
            "classificaoTipoAtendimentoclassificacaoTipoAtividade":{
                "codigo":123, 
                "descricao":"Agendamento",
            }
        },
    ]
}

Retorno da API - Falha

Bloco de código

language	json

{
  "mensagem": "Não foi possível listar suas atividades"
}

Aviso
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;

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Introdução

Método "aps/atividades"

Endpoint

Parâmetros de entrada

Exemplo request

Descrição dos objetos e atributos de retorno - Sucesso

Retorno da API - Sucesso

Retorno da API - Sucesso

Retorno da API - Falha