Histórico da Página

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/{apiversion}/integration/{tokenId} que retornara o status de processamento no seguinte formato:

...

{
"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:

{

...

"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:

Body:{

{
    "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:

Body:

...

{
    "items":

...

 [
        {
            "subscriberId":

...

 "00010002012345010",
            "contractNumber": "

...

098765432109",

...

            "contractVersion": "

...

098",

...

            "subContractNumber": "

...

098765432",

...

            "subContractVersion": "

...

098",

...

            "holderCpf": "

...

098765432",

...

            "personId": "

...

98765432",

...

            "name":

...

 "Usuario de exemplo",
            "birthdate": "

...

19000101",

...

            "blockedDate": "

...

19000101",

...

            "unblockDate": "

...

19000101",

...

            "gender": "

...

F",

...

            "effectiveDate": "

...

19000101",

...

            "healthInsuranceCode": "

...

098765",

...

            "healthInsuranceVersion": "

...

098",

...

            "zipCode": "

...

09876543",

...

            "cityCode": "

...

3550308",

...

            "waitingPeriodDate": "

...

19000101",

...

            "cardExpiration": "

...

19000101",

...

            "holderRelationship": "

...

T",

...

            "cardMagneticField": "

...

098765432109",

...

            "oldSubscriberId": "

...

00010002012345010",

...

            "habilitagrpcob": "

...

0",

...

            "habilitaclacar": "

...

0"
        }
    ],
    "healthInsurerId":

...

 "0001",
    "ansRegistry": "

...

321456"

...

}

...

BeneficiaryStatus

API: beneficiaryStatus (Beneficiários - Bloqueio/Desbloqueio)
Funcionalidade: API utilizada para a bloqueio e desbloqueio de beneficiários na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/beneficiaryStatus

Header:

Authorization: Token de autorização para comunicar com a API
idTenant: Id do tenant da operadora
tenantName: Nome do tenant da operadora

Propriedades:

Body:

...

{
    "items":

...

 [
        {
            "eventDate": "

...

19000101",

...

            "eventType": "

...

Desbloqueio

...

",

...

            "entry_hour":

...

 "00:01",
            "subscriberId": "

...

00010002012345010",

...

            "entry_date": "

...

19000101"
        }
    ],
    "healthInsurerId":

...

 "0001",
    "ansRegistry": "

...

321456"

...

}

...

HealthProviders

API: healthProviders (Redes de Atendimento - Inclusão/Alteração)
Funcionalidade: API utilizada para a inclusão e alteração de redes de atendimento na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/healthProviders

Header:

Authorization: Token de autorização para comunicar com a API
idTenant: Id do tenant da operadora
tenantName: Nome do tenant da operadora

Propriedades:

Body:

...

{
    "items":

...

 [
        {
            "healthProviderCode": "

...

098765",

...

            "healthProviderDocument": "

...

0001098765000101",

...

            "name":

...

 "Exemplo de prestador RDA",
            "healthProviderType": "

...

J",

...

            "healthProviderClass": "

...

CLI",

...

            "email":

...

 "[email protected]"
        }
    ],
    "healthInsurerId":

...

 "0001",
    "ansRegistry": "

...

321456"

...

}

...

AttendanceLocations

API: attendanceLocations (Locais de atendimento - Inclusão/Alteração)
Funcionalidade: API utilizada para a inclusão e alteração de locais de atendimento na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/attendanceLocations

Header:

Authorization: Token de autorização para comunicar com a API
idTenant: Id do tenant da operadora
tenantName: Nome do tenant da operadora

Propriedades:

Body:

...

{
    "items":

...

 [
        {
            "codint": "

...

0001",

...

            "healthProviderCode": "

...

098765",

...

            "locationCode": "

...

001",

...

            "locationTypeCode": "

...

001",

...

            "locationDescription": "

...

CLINICAS",

...

            "zipCode": "

...

09876543",
            "address":

...

 "Exemplo de endereco",
            "addressNumber": "

...

123",
            "addressComplement":

...

 "Complemento de endereco",
            "cityName": "Exemplo de municipio",
            "stateAbbreviation": "

...

SP",

...

            "district":

...

 "Exemplo de bairro",
            "cnesCode": "0987654,
            "region": "012"
        }
    ],
    "healthInsurerId": "0001",
    "ansRegistry": "321456"
}

HealthProviderSpecialties

...

API: healthProviderSpecialties (Especialidades para redes de atendimento - Inclusão/Alteração)
Funcionalidade: API utilizada para a inclusão e alteração de especialidades para redes de atendimento na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/healthProviderSpecialties

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	Obrigatório
codint	Código da operadora	4	Caractere	0123	x
healthProviderCode	Código da rede de atendimento	8	Caractere	09876543	x
specialtyCode	Código da especialidade	3	Caractere	098	x
subspecialtyCode	Código da subespecialidade	3	Caractere	098	x
locationCode	Código do local de atendimento	3	Caractere	098	x
blockDate	Data de bloqueio da especialidade	8	Caractere	aaaammdd	x
considerSpecialty	Indica se devem ser checadas as regras de solicita/executa para esta especialidade.	1	Caractere	0 - Não 1 - Sim	x
allowsMaterial	Indica se para este especialidade a RDA poderá solicitar materiais e medicamentos.	1	Caractere	0 - Não 1 - Sim	x
searchOrder	Indica se a ordem de pesquisa de autorização, será primeiro por Procedimentos Autorizados ou Procedimentos Não Autorizados.	1	Caractere	0 - Não 1 - Sim	x

Body:
{

Bloco de código
theme Midnight title HealthProviderSpecialties linenumbers true
{ "items":

...

[ { "codint": "BAX_CODINT

...

(Varchar(4)) Example: 0001", "healthProviderCode": "BAX_CODIGO

...

(Varchar(8)) Example: 098765", "specialtyCode": "BAX_CODESP

...

(Varchar(3)) Example: 001", "subspecialtyCode": "BAX_CODSUB

...

(Varchar(3)) Example: 002", "locationCode": "BAX_CODLOC

...

(Varchar(3)) Example: 001", "blockDate": "BAX_DATBLO

...

(Varchar(8)) Example: 19000101", "considerSpecialty": "BAX_CONESP

...

(Varchar(1)) Example: '1' para sim e '0' para não", "allowsMaterial": "BAX_LIMATM

...

(Varchar(1)) Example: 1", "searchOrder": "BAX_ORDPES

...

(Varchar(1)) Example: 0" } ], "healthInsurerId":

...

"Example: 0001", "ansRegistry":

...

"Example: 321456" }