Lista Atividades - release 02

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"

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 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.

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
idPrograma	OP	Number	ID do programa cadastrado pela PREVIVA	Exemplo: Programa de atenção primaria a saúde
idGrupo	OP	Number	ID do grupo cadastrado pela PREVIVA	Exemplo: Programa de nutrição
idSubgrupo	OP	Number	ID do subgrupo cadastrado pela PREVIVA	Exemplo: Nivel intermediario
idTipoAtendimento	OP	Number	ID do tipo de atendimento cadastrado pela PREVIVA
idTipoAtividade	OP	Number	ID do tipo de atividade cadastrado pela PREVIVA
dataInicial	OP	Number	Data inicial do periodo. desejado.	Formato: `"YYYY/MM/DD"`
dataFinal	OP	Number	Data final do periodo desejado.	Formato: `"YYYY/MM/DD"`

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    },
    "idPrograma:": Number,
    "idGrupo:": Number,
    "idSubgrupo:": Number,
    "idTipoAtendimento:": Number,
    "idTipoAtividade:": Number,
    "dataInicial": "YYYY/MM/DD",
    "dataFinal": "YYYY/MM/DD"
}

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 }
}

Exemplo request

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

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
atividades	M	Array de objetos do tipo atividade

{
  "atividades": [ "Objeto" ],
}

Objeto “atividade"

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`
classificacaoTipoAtendimento	M	Objeto do tipo item	Objeto do tipo item	classificação do tipo de atendimento

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

}

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"

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

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

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

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

Retorno da API - Sucesso

{
    "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
          "icone":"<link da imagem>",
          "grupo":{
              "codigo": 123,
              "titulo": "Atendimento Primário a Saúde",
              "descricao": "Grupo Xpto",
              "icone":"<link da imagem>",
              "subgrupo":{
                "codigo":123,
                "titulo": "Atendimento Primário a Saúde",
                "descricao": "xpto",
                "icone":"<link da imagem>",
              },
            },
        },
        "situacao":{
          "codigo": 123,
          "descricao": "agendado"
        },
        "dataSugerida": "01/02/2024 09:00:00",
        "dataRealizado":"01/02/2024 09:00:00",
        "tipoAtendimento": {
            "codigo":25, 
            "descricao":"descricao do tipo de atendimenot",
            "classificaoTipoAtendimento":{
                "codigo":123, 
                "descricao":"Agendamento"
            }
        },
        "tipoAtividade": {
            "codigo":123, 
            "descricao":"descricao do tipo de atividade",
            "classificaoTipoAtividade":{
                "codigo":123, 
                "descricao":"Agendamento"
            }
        },
    ]
}

Retorno da API - Falha

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

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;