Este documento tem como objetivo demonstrar a utilização dos endpoints de doenças preexistentes do beneficiário (CID), que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).
Esses endpoints são utilizados na nova tela de posição do beneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)
Clique aqui para detalhes sobre como habilitar o serviço de APIs
Retorna as doenças preexistentes (CID) do beneficiário.
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/cid |
|
| Authorization (header) |
| Cabeçalho usado para autorização das requisições | *required |
Content-Type (header) |
| 'application/json' é o formato do conteúdo | *required |
| SubscriberId (path) |
| Número da carteirinha do beneficiário | *required |
| page (query) |
| Paginação da Coleção | |
| pageSize (query) |
| Quantidade de Itens por Página | |
| order (query) |
| Ordenação da Coleção | |
| fields (query) |
| Filtro de campos dos registros | |
| filter (query) |
| Indica o filtro querystring recebido (pode se utilizar um filtro oData) |
Não possui body!
items |
| Doenças preexistentes do beneficiário |
| items.{campo do SX3} |
| Os campos retornados da tabela BF3:
|
| struct |
| Estrutura dos fields de acordo com o dicionário de dados (SX3) |
| hasNext |
| Indica se ainda existem registros a serem retornados |
| remainingRecords |
| Quantidade de registros ainda existem para retorno |
{
"items": [
{
"bf3_coddoe": "14.0",
"bf3_desdoe": "GlossiteExcluir: glossite atrofica(K14.42)",
"bf3_pagagr": "0",
"bf3_valagr": 0,
"bf3_peragr": 0,
"bf3_mesagr": 1,
"bf3_unagr": "1",
"bf3_datcpt": "2022-1-1"
},
{
"bf3_coddoe": "14.1",
"bf3_desdoe": "Glossite romboide mediana",
"bf3_pagagr": "0",
"bf3_valagr": 0,
"bf3_peragr": 0,
"bf3_mesagr": 2,
"bf3_unagr": "2",
"bf3_datcpt": "2022-1-1"
},
{
"bf3_coddoe": "14.3",
"bf3_desdoe": "Hipertrofia das papilas linguais",
"bf3_pagagr": "0",
"bf3_valagr": 0,
"bf3_peragr": 0,
"bf3_mesagr": 3,
"bf3_unagr": "3",
"bf3_datcpt": "2022-1-1"
},
{
"bf3_coddoe": "14.5",
"bf3_desdoe": "Lingua escrotal, Fissurada, Gretada Lingua, Sulcada Exclui: lingua Fissurada, congenita (Q38.33)",
"bf3_pagagr": "0",
"bf3_valagr": 0,
"bf3_peragr": 0,
"bf3_mesagr": 4,
"bf3_unagr": "4",
"bf3_datcpt": "2022-1-1"
}
],
"hasNext": false,
"remainingRecords": 0,
"struct": [
{
"field": "BF3_CODDOE",
"type": "C",
"title": "C.I.D.",
"description": "Cod.Doenca",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": []
},
{
"field": "BF3_DESDOE",
"type": "C",
"title": "Descricao",
"description": "Descricao",
"picture": "@!",
"size": 25,
"decimals": 0,
"cbox": []
},
{
"field": "BF3_PAGAGR",
"type": "C",
"title": "Pg. Agr./CPT",
"description": "Paga o Agravo/CPT ?",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Sim"
},
{
"value": "0",
"description": "Nao"
}
]
},
{
"field": "BF3_VALAGR",
"type": "N",
"title": "Vlr. Agravo",
"description": "Valor do Agravo",
"picture": "@E 99,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BF3_PERAGR",
"type": "N",
"title": "Per.Mensalid",
"description": "Percentual da Mensalidade",
"picture": "@E 99,999,999.99",
"size": 17,
"decimals": 2,
"cbox": []
},
{
"field": "BF3_MESAGR",
"type": "N",
"title": "T.Agravo/CPT",
"description": "Tempo Meses do Agravo/CPT",
"picture": "999",
"size": 3,
"decimals": 0,
"cbox": []
},
{
"field": "BF3_UNAGR",
"type": "C",
"title": "Unidade",
"description": "Unidade",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Horas"
},
{
"value": "2",
"description": "Dias"
},
{
"value": "3",
"description": "Meses"
},
{
"value": "4",
"description": "Anos"
}
]
},
{
"field": "BF3_DATCPT",
"type": "D",
"title": "Dt. Base CPT",
"description": "Data Base CPT",
"picture": "@D",
"size": 8,
"decimals": 0,
"cbox": []
}
]
} |
code |
| Código identificador do erro. (Tabela de Erros) |
message |
| Literal no idioma da requisição descrevendo o erro para o usuário. |
detailedMessage |
| Mensagem técnica e mais detalhada do erro. |
{
"code": "E001",
"message": "Beneficiário não encontrado.",
"detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
} |
Código de erros informado no Json de retorno com falha (404):
| Code | message | detailedMessage |
|---|---|---|
| E001 | Beneficiário não encontrado. | Não foi encontrado nenhum Beneficiário com a matricula {subscriberId} |
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica | Não se aplica |
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| Não se aplica | Não se aplica |
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |
