Adequação da integração - Detalhe Atividades

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"

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

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	Number	ID da atividade cadastrada no Previva

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

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",
      },
  },
  "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.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigoAtividade	M	Numer	Codigo identificador da atividade
codigoAtendimento	M	Number	Codigo identificador do atendimento
numeroProtocolo	OP	Numer	Numero de protocolo gerado pela atividade no sistema da PREVIVA
titulo	M	String	Titulo
descricao	OP	String	Descrição
programa	M	Objeto do tipo "programa"
situacao	M	Objeto do tipo "item"	Situação	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 "item"		Enviado em caso de consulta presencial
tipoAtendimento	M	Objeto do tipo "tipoAtendimento"
proximoAtendimento	OP	Objeto do tipo "tipoAtendimento"
tipoAtividade	M	Objeto do tipo "tipoAtividade"
modoAtendimento	M	Objeto do tipo “item"

{
      "codigoAtividade":" Number,
      "codigoAtendimento":" Number,
      "numeroProtocolo": "String"
      "titulo":"String",
      "descricao":"String",
      "programa":"Objeto",
      "situacao":"Objeto",
      "agenda":"Objeto",
      "dataSugerida": "String",
      "dataRealizado": "String",
      "regiao":"Objeto",
      "tipoAtendimento":"Objeto",
      "tipoAtividade": "Objeto",
      "modoAtendimento":"Objeto",
      "proximoAtendimento":"Objeto",
}

Objeto “tipoAtendimento"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigo	M	Number	Codigo identificador
titulo	M	String	Titulo
descricao	M	String	Descrição
classificacaoTipoAtendimento	M	Objeto do tipo "item"		classificação do tipo de atendimento Agendamento visita presencial Atividade educacional Questionario
servico	M	Objeto do tipo "item"		Enum: Remoto Presencial

{
    "codigo":"Number",
    "titulo":"String",
    "descricao":"String",
    "classificacaoTipoAtendimento": {
        "codigo":"string", 
        "descricao":"string"
    },
    "servico": "Objeto"
}

Objeto "tipoAtividade"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigo	M	Numer	Codigo identificador do tipo de atividade
descricao	M	String	Descrição do tipo de atividade
classificacaoTipoAtividade	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

{
    "tipoAtividade": {
        "codigo": "string", 
        "descricao":"string",
        "classificacaoTipoAtividade":{
            "codigo":"string", 
            "descricao":"string"
        }
        "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

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

Objeto “agenda"

Consultar link da doc: 8.2 - Detalhe da consulta

Retorno da API - Sucesso

{
  "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"
      },
      "servico":{
        "codigo": 123,
        "descricao": "agendado"
      },
   },
    "tipoAtividade": {
        "codigo":123, 
        "descricao":"descricao do tipo de atividade",
        "classificaoTipoAtividade":{
            "codigo":123, 
            "descricao":"Agendamento"
        },
        "idConteudoOrientacao": 123,
        "idFormulario": 123,
        "curso":{}, //condicional, de acordo com a classficacao do tipo de atividade
        "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
        }
    },
    "proximoAtendimento":{
      "codigo":25, 
      "descricao":"descricao do tipo de atendimenot",
      "classificaoTipoAtendimento":{
          "codigo":123, 
          "descricao":"Agendamento"
        },
        "servico":{
          "codigo": 123,
          "descricao": "agendado"
      },
    },
    "modoAtendimento":{
        "codigo": 123,
        "descricao": "Descricao"
    }
}

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;