...
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
exemplo.com / aps/atividades
| 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 Previva |
|
codigoAtendimento | M | Number | ID 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:
|
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:
|
dataRealizado | OP | String | Data na qual a atividade foi realizada | Formato esperado:
|
regiao | OP | Objeto do tipo item | Objeto do tipo item | Enviado em caso de consulta presencial |
classificacaoTipoAtendimento | M | Objeto do tipo item | Objeto do tipo item | classificação do tipo de atendimento
|
tipoAtendimento | M | Objeto do tipo item | Objeto do tipo item |
|
proximoAtendimento | OP | Objeto | Objeto do tipo |
|
...
| 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",
"classificaoTipoAtendimento":{
"codigo":123,
"descricao":"Agendamento"
}
},
"tipoAtividade": {
"codigo":123,
"descricao":"descricao do tipo de atividade",
"classificaoTipoAtividade":{
"codigo":123,
"descricao":"Agendamento"
},
"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
}
},
"servico":{
"codigo": 123,
"descricao": "agendado"
},
"proximoAtendimento":{
"codigo":25,
"titulo":"",
"descricao":"descricao do tipo de atendimenot",
"classificaoTipoAtendimento":{
"codigo":123,
"descricao":"Agendamento"
}
},
"modoAtendimento":{
"codigo": 123,
"descricao": "Descricao"
}
} |
Retorno da API - Falha
| Bloco de código |
|---|
{
"mensagem": "Não foi possível listar suas atividades"
} |
...