A API executions tem como objetivo, trabalhar com ações relacionadas as guias geradas no sistema de gestão Plano de Saúde.
VERBO GET
Retornar Dados de uma Guia
Através do verbo GET, a API irá retornar os dados das execuções vinculadas a liberação enviada.
Guias SADT:
Tabela | Atributo |
---|---|
BEA | (raiz do json) |
BE2 | procedures |
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/executions/<guia>. Exemplo:
Logo, a minha URL será: http://localhost:8080/rest/totvsHealthPlans/v1/executions/<guia>
Seguem os verbos disponíveis na API:
Verbo | Path | Path Param | Query Param | Descrição |
---|---|---|---|---|
GET | executions | idHealthIns (número da guia) | Numero da liberação |
Chamada GET - Retorna dados de uma Guia
Exemplo de chamada para a guia 0001.2024.04.00000196:
http://localhost:8080/rest/totvsHealthPlans/v1/executions/000120240400000196
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 procedures
Atributo | Campo | Tipo |
---|---|---|
authLevel | BE2_NIVAUT | Caracter |
sequence | BE2_SEQUEN | Caracter |
status | BE2_STATUS | Caracter |
requestedQuantity | BE2_QTDSOL | Numérico |
authorizedQuantity | BE2_QTDPRO | Numérico |
balance | BE2_SALDO | Numérico |
unitaryWorth | BD6_VLRPAG + BD6_VLRGLO | Numérico |
executionDate | BE2_DATPRO | Data |
startingTime | BE2_HORPRO | Caracter |
endingTime | BE2_HORFIM | Caracter |
accessWay | BE2_VIA | Caracter |
usedTechnique | BE2_TECUTI | Caracter |
authLevelKey | BE2_CHVNIV | Caracter |
auditing | BE2_AUDITO | Caracter |
priorAuthorization | BE2_LIBERA | Caracter |
priorAuthorizationStatus | BE2_STALIB | Caracter |
tableCode | BE2_CODPAD | Caracter |
procedureCode | BE2_CODPRO | Caracter |
Atributo rejectionCauses
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 |
Solicitação GET:
{ "items": [ { "ansRegistry": "888888", "idOnHealthInsurer": "000120240400000197", "idOnHealthProvider": "000120240400000197", "journey": "2", "subscriberId": "00010101000007012", "primaryICD": "", "attendanceLocation": "008", "password": "96753982225399803499", "accidentIndication": "9", "attendanceModel": "1", "attendanceProtocol": "88888820240402300053", "attendanceType": "02", "authorizationDate": "2024-04-02", "authorizationStatus": "1", "authorizationType": "2", "guideType": "02", "billingType": "", "clinicalCondition": "", "closingReason": "", "consultationType": "1", "endTreatmentDate": "", "healthProviderId": "000004", "idAuthOnHealthProvider": "", "locationCode": "001", "mainAuthorizationCode": "000120240400000196", "newbornAttendance": false, "passwordExpireDate": "2298-01-15", "priorAuthorization": false, "priorAuthorizationStatus": "", "professionalRequestorId": "000026", "professionalExecutorId": "", "requestDate": "2024-04-02", "attendanceToken": "", "missingValidationCode": "", "specialtyCode": "015", "specialCoverage": "", "attendanceScheme": "02", "occupationalHealth": "", "attendanceNote": " ", "professionalRequestorCouncil": "CRFA", "professionalRequestorState": "SP", "professionalRequestorCouncilNumber": "132456", "professionalRequestorSpecialtyCode": "005", "professionalExecutorCouncil": "", "professionalExecutorState": "", "professionalExecutorCouncilNumber": "", "dischargedType": "", "dischargedDate": "", "dischargedHour": "", "expectedHospitalizationDate": "", "expectedAdmissionDate": "", "hospitalizationDate": "", "hospitalizationHour": "", "hospType": "", "hasClinicalAttachment": false, "hasTreatmentExtension": false, "hasInitialSituation": false, , "professional": { "idOnHealthInsurer": "000026", "phoneNumber": "9999999", "professionalCouncil": "CRFA", "professionalIdentifier": "", "professionalCouncilNumber": "132456", "name": "ROBERTO", "email": "", "stateAbbreviation": "SP", "cbos": { "code": "221105", "specialtyDescription": "Biologo", "specialtyCode": "005", "description": "Biologo" } }, "procedures": [ { "authLevel": "BR8", "sequence": "001", "status": 1, "requestedQuantity": 1, "authorizedQuantity": 1, "authorized": "S", "balance": 0, "unitaryWorth": 30, "executionDate": "2024-04-02", "startingTime": "1740", "endingTime": "1740", "accessWay": "1", "usedTechnique": "", "authLevelKey": "0110101013", "auditing": "0", "toothRegion": "", "surfaces": "", "priorAuthorization": "0", "priorAuthorizationStatus": "2", "obsAudito": "", "medicalTeam": [ [] ], "tableCode": "00", "procedureCode": "10101013", "procedureDescription": "GLICOSE", "procedureType": "5", "rejectionCauses": [] } ] } ], "hasNext": false } |
{ "items": [], "hasNext": false } |