...
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 |
|---|---|---|---|---|
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
| |
servico | M | Objeto do tipo "item" | Enum:
|
...
| 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"
},
"modoAtendimento":{
"codigo": 123,
"descricao": "Descricao"
}
"servico":{
"codigo": 123,
"descricao": "agendado"
},
},
"tipoAtividade": {
"codigo":123,
"descricao":"descricao do tipo de atividade",
"classificaoTipoAtividadeclassificacaoTipoAtividade":{
"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",
"classificaoTipoAtendimentoclassificacaoTipoAtendimento":{
"codigo":123,
"descricao":"Agendamento"
},
"servico":{
"codigo": 123,
"descricao": "agendado"
},
},
} |
...