A API referenceValues tem como objetivo retornar a tabela de valores de referência para apoio de análise de eventos em auditoria quando utilizado a Carol Pós.
Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:
1. Configuração do REST do Protheus
Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> + /totvsHealthPlans/v1/referenceValues Exemplo:
Logo, a minha URL será: http://localhost:8080/rest/totvsHealthPlans/v1/referenceValues
Seguem os verbos disponíveis na API:
Verbo | Path | Query Params | Descrição |
|---|---|---|---|
| GET | referenceValues |
| Retorna dados da tabela de referência |
VERBO GET
Através do verbo GET podemos retornar os dados da tabela de referência em 2 níveis:
NÍVEL 1
Retorna: Dados da Rede de Atendimento e Grupo de Internação
QueryParams obrigatórios: Não há.
URL Exemplo: http://localhost:8080/rest/totvshealthplans/v1/referenceValues?level=1
No nível 1 ainda podemos realizar alguns filtros opcionais:
| Atributo | Descrição |
|---|---|
| healthProviderId | Código RDA |
| healthProviderOfficialRecord | CPF/CNPJ RDA |
| healthProviderName | Descrição RDA |
| hospitalizationGroupId | Código Grupo de Internação |
| hospitalCategoryId | Código Categoria Hospitalar |
| accommodationId | Código Acomodação |
| hospitalRegimeId | Código Regime Hospitalar |
NÍVEL 2
Retorna: Categoria do Hospital, Regime Hospitalar e Acomodação.
QueryParams obrigatórios:
| Atributo | Descrição |
|---|---|
| healthProviderId | Código RDA |
| hospitalizationGroupId | Código Grupo de Internação |
| hospitalCategoryId | Código Categoria Hospitalar |
| accommodationId | Código Acomodação |
| hospitalRegimeId | Código Regime Hospitalar |
Chamada GET Level 1:
| Atributo | Campo Protheus | Tipo |
|---|---|---|
| healthProviderId | BO0_CODRDA | Caracter |
| hospitalizationGroupId | BO0_GRPINT | Caracter |
| officialRecord | BAU_CPFCGC | Caracter |
| name | BAU_NOME | Caracter |
| hospitalCategoryId | BO0_CATHOS | Caracter |
| accommodationId | BO0_ACOMOD | Caracter |
| hospitalRegimeId | BO0_REGINT | Caracter |
{
"hasNext": false,
"items": [
{
"healthInsurer": {
"healthProviderId": "000004",
"officialRecord": "34585221000190",
"name": "HOSPITAL BOM CLIMA"
},
"hospitalizationGroup": {
"id": "1",
"description": "Clinica"
},
"hospitalCategory": {
"id": "1",
"description": "AAA - Alto custo"
},
"hospitalRegime": {
"id": "1",
"description": "Hospitalar"
},
"accommodation": {
"id": "1",
"description": "Enfermaria"
}
},
{
"healthInsurer": {
"healthProviderId": "000004",
"officialRecord": "34585221000190",
"name": "HOSPITAL BOM CLIMA"
},
"hospitalizationGroup": {
"id": "1",
"description": "Clinica"
},
"hospitalCategory": {
"id": "1",
"description": "AAA - Alto custo"
},
"hospitalRegime": {
"id": "3",
"description": "Domiciliar"
},
"accommodation": {
"id": "1",
"description": "Enfermaria"
}
},
{
"healthInsurer": {
"healthProviderId": "000004",
"officialRecord": "34585221000190",
"name": "HOSPITAL BOM CLIMA"
},
"hospitalizationGroup": {
"id": "1",
"description": "Clinica"
},
"hospitalCategory": {
"id": "2",
"description": "AA - Custo Medio"
},
"hospitalRegime": {
"id": "1",
"description": "Hospitalar"
},
"accommodation": {
"id": "1",
"description": "Enfermaria"
}
},
{
"healthInsurer": {
"healthProviderId": "000004",
"officialRecord": "34585221000190",
"name": "HOSPITAL BOM CLIMA"
},
"hospitalizationGroup": {
"id": "2",
"description": "Cirurgica"
},
"hospitalCategory": {
"id": "2",
"description": "AA - Custo Medio"
},
"hospitalRegime": {
"id": "2",
"description": "Hospital-Dia"
},
"accommodation": {
"id": "2",
"description": "Apartamento"
}
},
{
"healthInsurer": {
"healthProviderId": "000004",
"officialRecord": "34585221000190",
"name": "HOSPITAL BOM CLIMA"
},
"hospitalizationGroup": {
"id": "3",
"description": "Obstetrica"
},
"hospitalCategory": {
"id": "3",
"description": "A - Custo Padrao"
},
"hospitalRegime": {
"id": "3",
"description": "Domiciliar"
},
"accommodation": {
"id": "3",
"description": "UTI"
}
},
{
"healthInsurer": {
"healthProviderId": "000004",
"officialRecord": "34585221000190",
"name": "HOSPITAL BOM CLIMA"
},
"hospitalizationGroup": {
"id": "4",
"description": "Pediatrica"
},
"hospitalCategory": {
"id": "4",
"description": "I - Interior"
},
"hospitalRegime": {
"id": "1",
"description": "Hospitalar"
},
"accommodation": {
"id": "1",
"description": "Enfermaria"
}
},
{
"healthInsurer": {
"healthProviderId": "000004",
"officialRecord": "34585221000190",
"name": "HOSPITAL BOM CLIMA"
},
"hospitalizationGroup": {
"id": "5",
"description": "Psiquiatrica"
},
"hospitalCategory": {
"id": "5",
"description": "E - Especial"
},
"hospitalRegime": {
"id": "2",
"description": "Hospital-Dia"
},
"accommodation": {
"id": "2",
"description": "Apartamento"
}
},
{
"healthInsurer": {
"healthProviderId": "000005",
"officialRecord": "48564082000123",
"name": "PRODE ODONTOLOGIA"
},
"hospitalizationGroup": {
"id": "1",
"description": "Clinica"
},
"hospitalCategory": {
"id": "1",
"description": "AAA - Alto custo"
},
"hospitalRegime": {
"id": "1",
"description": "Hospitalar"
},
"accommodation": {
"id": "1",
"description": "Enfermaria"
}
}
]
} |
Chamada GET Level 2:
| Atributo | Campo Protheus | Tipo |
|---|---|---|
| initialDate | BO0_DATINI | Data |
| finalDate | BO0_DATFIM | Data |
| frequence | BO0_FREQ | Numérico |
| CLDValue | BO0_CLD | Numérico |
| CMIValue | BO0_CMI | Numérico |
| hospitalizationAmount | BO0_QTDINT | Numérico |
| dailyGrouping | BO0_AGRDIA | Caracter |
{
"hasNext": false,
"items": [
{
"initialDate": "2024-01-01",
"finalDate": "2025-12-31",
"dailyGrouping": "Agrupamento Diaria 1",
"frequence": 2,
"hospitalizationAmount": 5,
"CLDValue": 60.66,
"CMIValue": 77.42
},
{
"initialDate": "",
"finalDate": "",
"dailyGrouping": "Agrupamento Diaria 2",
"frequence": 3,
"hospitalizationAmount": 3,
"CLDValue": 100,
"CMIValue": 150
}
]
} |