Dica |
---|
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"
Informações |
---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
---|---|---|---|---|---|
exemplo.com / aps/atividades
| POST | application/json | Endpoint responsavel por realizar a adesão no programa de APS |
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.
...
Bloco de código |
---|
{ "beneficiario":{ "chaveUnica":"String", "numeroContrato":"String", "integracao":{ Objeto } } |
Exemplo request
Bloco de código |
---|
{ "chaveUnica": "101012", "integracao": { "cpf": "123456789123", "numero_cartao": "9288701", }, "beneficiario": { "chaveUnica": "101012", //geralmente é o cpf "numeroContrato": "616161", "integracao": { "cpf": "123456789123", "numero_cartao": "9288701", }, }, "idPrograma":123, "idGrupo":123, "idSubgrupo":123, "idTipoAtendimento": 123, "idTipoAtividade":123, "dataInicial": "2023/06/01", "dataFinal": "2024/06/01" } |
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.
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
codigoAtividade | M | Numer | Codigo identificador da atividade cadastrada no Previva | |
codigoAtendimento | M | Number | ID do atendimento cadastrada pelo PREVIVA | |
numeroProtocolo | OP | String | 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:
|
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:
|
classificacaoTipoAtendimentotipoAtendimento | M | Objeto | Objeto do tipo item“tipoAtendimento" | classificação do tipo de atendimento |
tipoAtividade | M | Objeto | objeto do tipo item“tipoAtividade" | classificação do tipo de atendimentoatividade |
Bloco de código | breakoutMode | wide
---|
{ "codigoAtividade":" Number, "codigoAtendimento":" Number, "numeroProtocolo": "String" "titulo":"String", "descricao":"String", "programa":"Objeto" , "situacao":"Objeto" , "dataSugerida": "String", "dataRealizado": "String", "tipoAtendimento":"Objeto", "tipoAtividade":"Objeto", } |
Objeto "tipoAtendimento"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
codigo | M | Numer | Codigo identificador do tipo de atendimento |
|
descricao | M | String | Descrição do tipo de atendimento |
|
classificacaoTipoAtendimento | M | Objeto | Objeto do tipo "classificacaoTipoAtendimento" | classificação do tipo de atendimento |
Bloco de código |
---|
{
"tipoAtendimento": {
"codigo": "string",
"descricao":"string",
"classificacaoTipoAtendimento":{
"codigo":"string",
"descricao":"string"
}
},
} |
Objeto "classificacaoTipoAtendimento"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
codigo | M | Numer | Codigo identificador da classificacao do tipo de atendimento |
|
descricao | M | String | Descrição do tipo de atendimento |
|
Bloco de código |
---|
{
"classificacaoTipoAtendimento":{
"codigo":"string",
"descricao":"string"
}
} |
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 | Objeto do tipo "classificacaoTipoAtividade" | classificação do tipo de atividade |
Bloco de código |
---|
{
"tipoAtividade": {
"codigo": "string",
"descricao":"string",
"classificacaoTipoAtividade":{
"codigo":"string",
"descricao":"string"
}
},
} |
Objeto "classificacaoTipoAtividade"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
codigo | M | Numer | Codigo identificador da classificacao do tipo de atividade |
|
descricao | M | String | Descrição da classificacao do tipo de atividade |
|
Bloco de código |
---|
{ "programaclassificacaoTipoAtividade":"Objeto"{ , "situacaocodigo":"Objetostring" , "dataSugerida": "String", "dataRealizadodescricao": "Stringstring", "classificacaoTipoAtendimento":"Objeto" , } } |
Objeto "programa"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
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 | breakoutMode | wide
---|
{ "programa":{ "codigo":" Number, "titulo":"String", "descricao":"String", "icone":"String", "grupos":[ "Objeto" ], } } |
...
Bloco de código | ||
---|---|---|
| ||
{ "codigo": Number, "descricao":"String", } |
Retorno da API - Sucesso
Bloco de código | ||
---|---|---|
| ||
{ "atividades": [ { "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", "classificaoTipoAtendimentoclassificacaoTipoAtendimento":{ "codigo":123, "descricao":"Agendamento" } }, "tipoAtividade": { "codigo":123, "descricao":"descricao do tipo de atividade", "classificaoTipoAtividadeclassificacaoTipoAtividade":{ "codigo":123, "descricao":"Agendamento" } }, ] } |
Retorno da API - Falha
Bloco de código | ||
---|---|---|
| ||
{ "mensagem": "Não foi possível listar suas atividades" } |
Aviso |
---|
|