Histórico da Página
CONTEÚDO
- Visão Geral
- Configurações INI
- Verbos
- Query Params - GET
- Atributos de Resposta
- Exemplos de JSONs de Resposta
01. VISÃO GERAL
A API UserUsage tem como objetivo retornar a utilização do plano de saúde de um beneficiário. A API recebe parâmetros como a matrícula, período de e até, e retorna os eventos executados pelo beneficiário no período informado.
Os registros listados são provenientes de uma Query executada na tabela BD6.
02. CONFIGURAÇÕES INI
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:
...
Logo, a minha URL será: http://spon019400235:8080/rest/totvsHealthPlans/v1/userUsage
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | Path | Descrição |
---|---|---|
GET | /userUsage | Extrato de utilização de beneficiários de saúde |
04. QUERY PARAMS - GET
Lista de query params obrigatórios:
...
Campo | Descrição |
---|---|
fields | Indica os campos que serão retornados na consulta. |
order | Indica uma lista de atributos para realizar a ordenação dos registros. Indicando o caracter – no início, indica que será realizado uma ordenação decrescente. Lista de atributos que são passíveis de ordenação: procedureCode, procedureName, |
pageSize | Indica quantos registros serão retornados na requisição. O padrão do sistema são 20 registros. Caso ainda existam registros para serem exibidos, o atributo hasNext será retornado com true. |
page | Indica a página de ordenação que os registros serão apresentados. Se atentar ao controle booleano hasNext |
procedureCode, executionDate, healthProviderCode, healthProviderDocument, cid, procedureName, healthProviderName, quantity, toothRegion, face | Indicando um desses atributos e um valor, a API realizará um filtro adicional com o atributo e valor informado. |
05. ATRIBUTOS DE RESPOSTA
Atributo | Campo | Tipo | Descrição |
---|---|---|---|
procedureCode | BD6_CODPRO | String | Código do procedimento |
procedureName | BD6_DESPRO | String | Descrição do procedimento |
executionDate | BD6_DATPRO | String | Data do evento no formato yyyy-mm-dd |
subscribername | BD6_NOMUSR | String | Nome do beneficiário |
healthProviderCode | BD6_CODRDA | String | Código da rede de atendimento |
healthProviderName | BD6_NOMRDA | String | Nome da rede de atendimento |
serviceType | BR8_CLASSE | String | Código da classe de procedimento |
serviceTypeDescription | BJE_DESCRI | String | Descrição da classe de procedimento |
quantity | BD6_QTDPRO | Number | Quantidade do evento |
healthProviderDocument | BD6_CPFRDA | String | CPF/CNPJ da rede de atendimento |
cid | BD6_CID | String | CID principal do atendimento |
toothRegion | BD6_DENREG | String | Região do dente |
face | BD6_FADENT | String | Face do dente |
paidValue | BD6_VLRPAG | Number | Valor pago |
disallowanceValue | BD6_VLRGLO | Number | Valor de glosa |
coPaymentValue | BD6_VLRTPF | Number | Valor de co-participação |
subscriberId | BD6_OPEUSR+BD6_CODEMP+BD6_MATRIC+BD6_TIPREG+BD6_DIGITO | String | Matrícula do beneficiário |
05. EXEMPLOS DE JSONS DE RESPOSTA
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "items": [ { "healthProviderDocument": "34391654857", "paidValue": 90.64, "subscriberId": "00010001000003002", "face": "", "coPaymentValue": 0, "procedureCode": "10101012", "executionDate": "2017-12-27", "subscribername": "RENATA", "healthProviderName": "RDA SILVIA SANT'ANNA", "serviceTypeDescription": "CONSULTAS", "serviceType": "000001", "cid": "A00", "procedureName": "CONSULTA EM CONSULTORIO", "healthProviderCode": "000007", "disallowanceValue": 44.87, "quantity": 1, "toothRegion": "" } ], "hasNext": false } |
...