Comparação de Páginas

...

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

...

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

Bloco de código

{
    "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
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
      "classificacaoTipoAtendimento": "Objeto" }
   "servico": "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"

...

Bloco de código

{
  "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",
    "tipoAtendimentoclassificaoTipoAtendimento":{
   {     "codigo":25123, 
        "descricao":"Agendamento"descricao
   do tipo de atendimenot"},
      "classificaoTipoAtendimentoservico":{
        "codigo": 123, 
        "descricao": "Agendamentoagendado"
      },
   },
    "tipoAtividade": {
        "codigo":123, 
        "descricao":"descricao do tipo de atividade",
        "classificaoTipoAtividade":{
            "codigo":123,, 
            "descricao":"Agendamento"
        },
        "descricaoidConteudoOrientacao":"Agendamento" 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
            "idConteudoOrientacao": 123,
    
       "idFormulario": 123
        }
    },
    "servicoproximoAtendimento":{
        "codigo": 12325,
 
      "descricao":"descricao "agendado"do tipo de atendimenot",
 },     "proximoAtendimentoclassificaoTipoAtendimento":{
          "codigo":25123, 
          "titulodescricao":"Agendamento",
         "descricao":"descricao do tipo de atendimenot"},
        "classificaoTipoAtendimentoservico":{
 
          "codigo": 123, 
 
          "descricao": "Agendamentoagendado"

         },
    },
    "modoAtendimento":{
        "codigo": 123,
        "descricao": "Descricao"
    }
}

...

Versões comparadas

Versão antiga 3

Nova versão 4

Chave