Histórico da Página
Índice |
---|
Introdução
As APIs de integraçao cadastral são processadas de maneira assíncrona. Ao realizar essa ação,
o servidor irá retornar um token de processamento (tokenId) que deve ser consultado posteriormente na api
/api/healthcare/hat/v1/integration/{tokenId} que retornara o status de processamento no seguinte formato:
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "idTenant": "", "code": 0, "message": "", "detailedMessage": [] } |
Master Token
API: Master Token
Funcionalidade: API utilizada para gerar um token de autorização para autenticação nas API’s do HAT. É necessário apenas um token por cliente.
Tipo de transação: POST
Endpoint: {apiversion}/masterToken
Header:
Authorization: Token de autorização para comunicar com a API
idTenant: Id do tenant da operadora
tenantName: Nome do tenant da operadora
Body:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "name": "Teste", // Nome do token "idTenant": 5, // Id do tenant da operadora "userId": 445 // Id do usuário que está solicitando o token. O valor dessa propriedade é o mesmo contido no campo IDAUTH da base de dados de administração do HAT na tabela usuários. } |
Authorizations
API: authorizations (Autorizações)
Funcionalidade: API utilizada para a inclusão e alteração de vidas na base de dados
Tipo de transação: GET
Endpoint: {apiversion}/authorizations
Header:
Authorization: Token de autorização para comunicar com a API
idTenant: Id do tenant da operadora
tenantName: Nome do tenant da operadora
Parametros:
page: Quantidade de páginas
pageSize: Tamanho da página
expand: Informações a mais que precisa retornar (healthProvider,professional,procedures.rejectionCauses,beneficiary,medicalTeam,requestedHospitalInfo,authorizedHospitalInfo,cbos,sourceAuthorization,rejectionCauses,healthInsurance)
order: Ordenação (-authorizationId para decrescente/+authorizationId para crescente)
trackingStatus: Indica se o registro já foi ou não importado pelo software de gestão(0 para não importado, 1 para importado)
Persons
API: Persons (Vidas - Inclusão/Alteração)
Funcionalidade: API utilizada para a inclusão e alteração de vidas na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/persons
Header:
Authorization: Token de autorização para comunicar com a API
idTenant: Id do tenant da operadora
tenantName: Nome do tenant da operadora
Propriedades:
Propriedade | Descrição | Tamanho | Tipo | Formato |
---|---|---|---|---|
personId | Matricula da vida no sistema | 8 | Caractere | 01234567 |
holderCPF | CPF da vida | 14 | Caractere | 01234567890123 |
name | Nome da vida | 70 | Caractere | |
birthdate | Data de nascimento da vida | 8 | Caractere | aaaammdd |
gender | Gênero da vida | 1 | Caractere | 1 - Masculino 2 - Feminino |
nationalhealthcard | Numero da carteira nacional de saúde | 15 | Caractere | 012345678901234 |
phonenumber | Telefone de contato | 15 | Caractere | 012345678901234 |
zipcode | CEP do endereço | 8 | Caractere | 01234567 |
citycode | Código do municipio no IBGE | 7 | Caractere | 0123456 |
Email de contato | 60 | Caractere |
Body:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "items": [ { "personId": "98765432", "holderCPF": "321654987", "name": "Usuario de exemplo", "birthdate": "19000101", "gender": "F", "nationalhealthcard": "098765432109876", "phonenumber": "5511987654321", "zipcode": "09876543", "citycode": "3550308", "email": "[email protected]" } ], "healthInsurerId": "0001", "ansRegistry": "321456" } |
Beneficiaries
API: Beneficiaries (Beneficiários - Inclusão/Alteração)
Funcionalidade: API utilizada para a inclusão e alteração de beneficiarios na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/beneficiaries
Header:
Authorization: Token de autorização para comunicar com a API
idTenant: Id do tenant da operadora
tenantName: Nome do tenant da operadora
Propriedades:
Propriedade | Descrição | Tamanho | Tipo | Formato |
---|---|---|---|---|
subscriberId | Matricula do beneficiário | 15 | Caractere | 012345678901234 |
contractNumber | ||||
contractVersion | ||||
subContractNumber | ||||
subContractVersion | ||||
holderCpf | ||||
personId | ||||
name | ||||
birthdate | ||||
blockedDate | ||||
unblockDate | ||||
gender | ||||
effectiveDate | ||||
healthInsuranceCode | ||||
healthInsuranceVersion | ||||
zipCode | ||||
cityCode | ||||
waitingPeriodDate | ||||
cardExpiration | ||||
holderRelationship | ||||
cardMagneticField | ||||
oldSubscriberId | ||||
habilitagrpcob | ||||
habilitaclacar |
Body:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "items": [ { "subscriberId": "BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO (Varchar(15)) Example: 00010002012345010", "contractNumber": "BA1_CONEMP (Varchar(12)) Example: 098765432109", "contractVersion": "BA1_VERCON (Varchar(3)) Example: 098", "subContractNumber": "BA1_SUBCON (Varchar(9)) Example: 098765432", "subContractVersion": "BA1_VERSUB (Varchar(3)) Example: 098", "holderCpf": "BA1_CPFUSR (Varchar(11)) Example: 098765432", "personId": "BA1_MATVID (Varchar(8)) Example: 98765432 - Deve ser o mesmo código do campo personId da API Persons", "name": "BA1_NOMUSR (Varchar(70)) Example: Usuario de exemplo", "birthdate": "BA1_DATNAS (Varchar(8)) Example: 19000101", "blockedDate": "BA1_DATBLO (Varchar(8)) Example: 19000101", "unblockDate": "BA1_DESBLO (Varchar(8)) Example: 19000101", "gender": "BA1_SEXO (Varchar(1)) Example: F", "effectiveDate": "BA1_DATINC (Varchar(8)) Example: 19000101", "healthInsuranceCode": "BA1_CODPLA (Varchar(8)) Example: 098765", "healthInsuranceVersion": "BA1_VERSAO (Varchar(3)) Example: 098", "zipCode": "BA1_CEPUSR (Varchar(8)) Example: 09876543", "cityCode": "BA1_CODMUN (Varchar(7)) Example: 3550308", "waitingPeriodDate": "BA1_DATCAR (Varchar(8)) Example: 19000101", "cardExpiration": "BA1_DTVLCR (Varchar(8)) Example: 19000101", "holderRelationship": "BA1_TIPUSU (Varchar(1)) Example: T - Indica se o usuário é Titular 'T' ou dependente 'D'", "cardMagneticField": "BA1_TARCAR (Varchar(254)) Example: 098765432109", "oldSubscriberId": "BA1_MATANT (Varchar(17)) Example: 00010002012345010", "habilitagrpcob": "BA1_INFGCB (Varchar(1)) Example: Informa se utiliza grupo de cobertura '1' para sim / '2' para não", "habilitaclacar": "BA1_INFCOB (Varchar(1)) Example: Informa se a cobrança é feita no nível do beneficiário '1' para sim / '2' para não" } ], "healthInsurerId": "Example: 0001", "ansRegistry": "Example: 321456" } |
...