Histórico da Página
CONTEÚDO
- Visão Geral
- Configurações INI
- Verbos
- Exemplo de Chamada da API
- Atributos de Resposta
- Exemplos de JSON de Resposta
01. VISÃO GERAL
A API authorizations tem como objetivo, trabalhar com ações relacionadas as guias geradas no sistema de gestão Plano de Saúde.
...
Outra funcionalidade da API POST é realizar a validação da execução de uma Liberação. Para realizar esta validação é necessário informar o queryparam action com o conteúdo execute. A validação realizada é a mesma do Portal do Prestador do Produto Planos de Saúde SIGAPLS.
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://localhost:8080/rest/totvsHealthPlans/v1/authorizations/<guia>
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | Path | Path Param | Query Param | Descrição |
---|---|---|---|---|
GET | authorizations | idHealthIns (número da guia) | Guia realizada pelo beneficiário | |
POST | authorizations | resendBatch=true | Valida se é possível realizar o Reenvio da guia pelo HAT |
04. EXEMPLO DE CHAMADA DA API
Chamada GET - Retorna dados de uma Guia
...
Atributo | Descrição | Tipo |
---|---|---|
idOnHealthInsurer | Número da Guia | Caracter |
healthProviderCode | Código da Rede de Atendimento | Caracter |
locationCode | Código do Local de Atendimento | Caracter |
05. ATRIBUTOS DE RESPOSTA
CHAMADA GET
Cabeçalho
Atributo | Campo | Tipo |
---|---|---|
subscriberId | BEA_OPEUSR+BEA_CODEMP+BEA_MATRIC+BEA_TIPREG+BEA_DIGITO | Caracter |
primaryICD | BEA_CID | Caracter |
attendanceLocation | BEA_LOCAL | Caracter |
password | BEA_SENHA | Caracter |
accidentIndication | BEA_INDACI | Caracter |
attendanceModel | BEA_TIPADM | Caracter |
attendanceProtocol | BEA_PROATE | Caracter |
attendanceType | BEA_TIPATE | Caracter |
authorizationDate | BEA_DATPRO | Data |
authorizationStatus | BEA_STATUS | Caracter |
authorizationType | BEA_TIPGUI | Caracter |
billingType | BEA_TIPFAT | Caracter |
clinicalCondition | BEA_INDCLI | Caracter |
closingReason | BEA_TIPSAI | Caracter |
consultationType | BEA_TIPCON | Caracter |
endTreatmentDate | BEA_DPTETA | Data |
healthProviderId | BEA_CODRDA | Caracter |
idAuthOnHealthProvider | BEA_GUIPRE | Caracter |
locationCode | BEA_CODLOC | Caracter |
mainAuthorizationCode | BEA_GUIPRI | Caracter |
newbornAttendance | BEA_ATERNA | Caracter |
passwordExpireDate | BEA_VALSEN | Data |
priorAuthorization | BEA_LIBERA | Caracter |
priorAuthorizationStatus | BEA_STALIB | Caracter |
professionalRequestorId | BEA_CDPFSO | Caracter |
professionalExecutorId | BEA_CDPFRE | Caracter |
requestDate | BEA_DATSOL | Data |
attendanceToken | BEA_TOKEDI | Caracter |
missingValidationCode | BEA_AUSVLD | Caracter |
specialtyCode | BEA_CODESP | Caracter |
professionalRequestorCouncil | BEA_SIGLA | Caracter |
professionalRequestorState | BEA_ESTSOL | Caracter |
professionalRequestorCouncilNumber | BEA_REGSOL | Caracter |
professionalRequestorSpecialtyCode | BEA_ESPSOL | Caracter |
professionalExecutorCouncil | BEA_SIGEXE | Caracter |
professionalExecutorState | BEA_ESTEXE | Caracter |
professionalExecutorCouncilNumber | BEA_REGEXE | Caracter |
dischargedType | BE4_TIPALT | Caracter |
dischargedDate | BE4_DTALTA | Data |
dischargedHour | BE4_HRALTA | Caracter |
expectedHospitalizationDate | BE4_PRVINT | Data |
hospType | BE4_TIPINT | Caracter |
...
Atributo | Campo | Tipo |
---|---|---|
procedureSequence | BEG_SEQUEN/BEL_SEQUEN | Caracter |
code | BEG_CODGLO/BEL_CODGLO | Caracter |
rejectionSequence | BEG_SEQCRI/BEL_SEQCRI | Caracter |
description | BEG_DESGLO/BEL_DESGLO | Caracter |
CHAMADA POST
Atributo | Campo | Tipo |
---|---|---|
code | Campo fixo que indica a ação encontrada: 0001 e 0002. | Caracter |
message | Mensagem indicativa referente ao código acima: 0001 - Guia informada encontrada, apta para realizar a contingencia 0002 - Não foi encontrada guia, e possível realizar o reenvio | Caracter |
idOnHealthInsurer | Número da guia (baseado no alias da guia informada) BEA_OPEMOV+BEA_ANOAUT+BEA_MESAUT+BEA_NUMAUT B4Q_OPEMOV+B4Q_ANOAUT+B4Q_MESAUT+B4Q_NUMAUT | Caracter |
authorization | Estrutura JSON no modelo do verbo GET acima (será informado quando existir a guia) | Caracter |
06. EXEMPLOS DE JSON DE RESPOSTA
Solicitação GET:
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "endTreatmentDate": null, "locationCode": "001", "professionalRequestorSpecialtyCode": "063", "professionalRequestorCouncil": "CRM", "professionalExecutorCouncil": "", "procedures": [ { "status": "0", "sequence": "001", "endingTime": "1800", "auditing": "1", "requestedQuantity": 1, "startingTime": "1800", "tableCode": "22", "authorizedQuantity": 1, "accessWay": "", "priorAuthorization": "0", "priorAuthorizationStatus": "", "rejectionCauses": [ { "code": "", "procedureSequence": "001", "rejectionSequence": "002", "description": "NÍVEL: BRV - PLANOS E GRUPOS DE COBERTURA ( 02 - ATUALIZACOES / PRODUTO SAUDE / PRODUTO SAUDE --> FOLDER COBERTURA/CAREN" }, { "code": "025", "procedureSequence": "001", "rejectionSequence": "001", "description": "PARA ESTE PROCEDIMENTO NECESSITA AUDITORIA." } ], "executionDate": "2022-09-15", "procedureCode": "10101012", "unitaryWorth": 0, "authLevelKey": "00010001001022", "balance": 0, "usedTechnique": "", "authLevel": "" } ], "healthProviderId": "000004", "consultationType": "1", "requestDate": null, "dischargedDate": null, "hospType": "", "priorAuthorizationStatus": "", "newbornAttendance": "0", "professionalExecutorState": "", "attendanceLocation": "008", "specialtyCode": "002", "authorizationType": "01", "passwordExpireDate": "2022-10-15", "professionalRequestorId": "A01834", "missingValidationCode": "01", "attendanceModel": "1", "attendanceToken": "", "professionalRequestorCouncilNumber": "654321", "professionalExecutorCouncilNumber": "", "subscriberId": "00010101000007012", "billingType": "", "dischargedType": "", "professionalExecutorId": "", "accidentIndication": "9", "priorAuthorization": "0", "idAuthOnHealthProvider": "", "password": "", "attendanceType": "05", "attendanceProtocol": "88888820220915300033", "dischargedHour": null, "authorizationStatus": "6", "primaryICD": "", "professionalRequestorState": "SP", "authorizationDate": "2022-09-15", "mainAuthorizationCode": "", "expectedHospitalizationDate": null, "closingReason": "", "clinicalCondition": "" } |
...