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

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

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	Regra de preenchimento

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

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"

Objeto “tipoAtendimento"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

Objeto "tipoAtividade"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

Objeto "documento"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

Objeto "programa"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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"

Objeto "grupo"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

Objeto "subgrupo"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

Objeto “item"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

Objeto “agenda"

Consultar link da doc: 8.2 - Detalhe da consulta

Mosia Omnichannel Parceiros