Histórico da Página

...

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:

...

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

...

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

...

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

...

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

...

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:

Propriedade	Descrição	Tamanho	Tipo	Formato
eventDate	Data do evento	8	Caractere	aaaammdd
eventType	Tipo de evento	11	Caractere	Bloqueio Desbloqueio
entry_hour	Hora do registro	5	Caractere	hh:mm
subscriberId	Matricula do beneficiário	15	Caractere	012345678901234
entry_date	Data do registro	8	Caractere	aaaammdd

Body:

Bloco de código

theme	Midnight
title	beneficiaryStatus
linenumbers	true

{
    "items": [
        {
            "eventDate": "19000101",
            "eventType": "Desbloqueio",
            "entry_hour": "00:01",
            "subscriberId": "00010002012345010",
            "entry_date": "19000101"
        }
    ],
    "healthInsurerId": "0001",
    "ansRegistry": "321456"
}

...

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:

Propriedade	Descrição	Tamanho	Tipo	Formato
healthProviderCode	Indica o código da rede de atendimento	8	Caractere	098765
healthProviderDocument	Informa o CPF/CNPJ da rede de atendimento	14	Caractere	0001098765000101
name	Informa o nome da rede de atendimento	60	Caractere
healthProviderType	Indica se o prestador é do tipo pessoa física ou pessoa juridica	1	Caractere	F - Física J - Juridica
healthProviderClass	Informa o tipo de prestador	3	Caractere	MED - MEDICO LAB - LABORATORIO HOS - HOSPITAL OPE - OPERADORA CLI - CLINICA DEN - DENTISTAS
email	Informa um endereço de e-mail da rede de atendimento	60	Caractere

Body:

Bloco de código

theme	Midnight
title	healthProviders
linenumbers	true

{
    "items": [
        {
            "healthProviderCode": "098765",
            "healthProviderDocument": "0001098765000101",
            "name": "Exemplo de prestador RDA",
            "healthProviderType": "J",
            "healthProviderClass": "CLI",
            "email": "[email protected]"
        }
    ],
    "healthInsurerId": "0001",
    "ansRegistry": "321456"
}

...

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:

Propriedade	Descrição	Tamanho	Tipo	Formato
codint	Código da operadora	4	Caractere	0123
healthProviderCode	Código da rede de atendimento	8	Caractere	09876543
locationCode	Código do local de atendimento	3	Caractere	012
locationTypeCode	Código do tipo de local de atendimento	3	Caractere	012
locationDescription	Descrição do tipo de local de atendimento	30	Caractere	Exemplos: Clinica medica Laboratorio Hospital
zipCode	CEP do local de atendimento	8	Caractere	09876543
address	Endereço do local de atendimento	40	Caractere
addressNumber	Numero do endereço do local de atendimento	6	Caractere	123ABC
addressComplement	Complemento do endereço do local de atendimento	30	Caractere
cityName	Cidade do local de atendimento	30	Caractere
stateAbbreviation	Estado do local de atendimento	2	Caractere
district	Bairro do local de atendimento	30	Caractere
cnesCode	Codigo CNES do local de atendimento	7	Caractere	0987654
region	Código do municipio do local de atendimento	3	Caractere	012

Body:

Bloco de código

theme	Midnight
title	attendanceLocations
linenumbers	true

{
    "items": [

Bloco de código

theme	Midnight
title	attendanceLocations
linenumbers	true

{
    "items": [
        {
            "codint": "BB8_CODINT (Varchar(4)) Example: 0001",
            "healthProviderCode": "BB8_CODIGO (Varchar(8)) Example: 098765",
            "locationCode": "BB8_CODLOC (Varchar(3)) Example: 001",
            "locationTypeCode": "BB8_LOCAL (Varchar(3)) Example: 001",
            "locationDescription": "BB8_DESLOC (Varchar(30)) Example: CLINICAS", {
            "zipCodecodint": "BB8_CEP (Varchar(8)) Example: 098765430001",
            "addresshealthProviderCode": "BB8_END (Varchar(40)) Example: Exemplo de endereco""098765",
            "addressNumberlocationCode": "BB8_NR_END (Varchar(6)) Example: 123001",
            "addressComplementlocationTypeCode": "BB8_COMEND (Varchar(30)) Example: Complemento de endereco001",
            "cityNamelocationDescription": "BB8_MUN (Varchar(30)) Example: Exemplo de municipioCLINICAS",
            "stateAbbreviationzipCode": "BB8_EST (Varchar(2)) Example: SP09876543",
            "districtaddress": "BB8_BAIRRO (Varchar(30)) Example: Exemplo de bairroendereco",
            "cnesCodeaddressNumber": "BB8_CNES123" (Varchar(7)) Example: 0987654,
            "addressComplement": "Complemento de endereco",
            "regioncityName": "BB8_REGMUN (Varchar(3)) Example: 012"
    Exemplo de municipio",
    }
    ],
    "healthInsurerIdstateAbbreviation": "Example: 0001SP",
     "ansRegistry": "Example: 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:

...

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

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

Árvore de páginas

Versões comparadas

Versão antiga 13

Nova versão 14

Chave

HealthProviderSpecialties

HealthProviderSpecialties