API Authorizations/{cpf}/cpf

CONTEÚDO

Visão Geral
Configuraçóes INI
Verbos
Uso da API - GET
Exemplos de JSON de Resposta
Tabelas utilizadas

01. VISÃO GERAL

Esta parte da API authorizations tem como objetivo realizar ações referentes a guias de beneficiários mediantes a informação de seu CPF. Atualmente temos as seguintes ações:

Action - validRelease (Verbo GET) - Retorna as guias de liberação disponíveis para serem executadas.

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:

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo	URL	Descrição
GET	https://<url>:porta>/rest/totvsHealthPlans/v1/authorizations/{cpf}/cpf	Retorna guias de liberação em aberto

04. USO DA API

GET - RETORNA LIBERAÇÕES EM ABERTO PARA EXECUÇÃO

Queryparams:

Atributo	Tipo	Regra	Descrição
action	Caracter	Obrigatório	Ação que será realizada: validRelease - Retorna guias de liberação em aberto
healthProviderCode	Caracter	Condicionado	Se action = validRelease, Código da RDA que realizará e execução da guia (obrigatório)
locationCode	Caracter	Condicionado	Se action = validRelease, Código do Local de Atendimento que realizará e execução da guia (obrigatório)
pageSize	Caracter	Opcional	Controle de quantidade de itens que serão retornados.
page	Caracter	Opcional	Controle de paginação
expand	Caracter	Opcional	Indica os expandables que serão retornados no json. Opções: beneficiary, healthProvider, procedures

Exemplo solicitação anexos clínicos relacionados:

05. EXEMPLOS DE JSON DE RESPOSTA

Falha 400 - Guia não encontrada

{
    "code": 400,
    "message": "Guia informada nao encontrada",
    "detailedMessage": "Entre em contato com o Suporte"
}

Falha 400 - QueryParam obrigatório não informado

{
    "code": 400,
    "message": "QueryParams obrigatórios não informados",
    "detailedMessage": "locationCode "
}

Sucesso 200 - Guias encontradas

{
    "items": [
        {
            "actionReturn": true,
            "actionMessage": "",
            "idOnHealthProvider": "000120240100000043",
            "authorizationDate": "2024-01-24",
            "beneficiary": {
                "isInterchange": false,
                "name": "CARLOS ROBERTO",
                "socialName": "",
                "holderCPF": "44171339804",
                "birthdate": "1962-12-12",
                "holderRelationship": "T",
                "gender": "1",
                "cardExpiration": "",
                "oldSubscriberId": "",
                "weight": 0,
                "height": 0,
                "subscriberId": "00010013000001003",
                "healthInsurance": {
                    "code": "0005",
                    "roomType": "01",
                    "description": "PRODUTO MEDICO"
                }
            },
            "healthProvider": {
                "name": "HOSPITAL BOM CLIMA",
                "cityCode": "3518800",
                "type": "J",
                "healthProviderId": "000004",
                "officialRecord": "34585221000190",
                "healthInsurerType": "HOS",
                "blockDate": "",
                "email": ""
            },
            "procedures": [
                {
                    "tableCode": "22",
                    "procedureCode": "10101012",
                    "requestedQuantity": 1,
                    "authorizedQuantity": 1,
                    "procedureDescription": "CONSULTA EM CONSULTORIO",
                    "balance": 1,
                    "status": 1,
                    "auditing": false,
                    "procedureType": "0",
                    "authLevelKey": "0110101012",
                    "authLevel": "PLS"
                }
            ],
            "_expandables": []
        }
    ],
    "hasNext": true
}

06. TABELAS UTILIZADAS

BEA - Atendimentos
BE2 - Autorização e Procedimentos

Árvore de páginas