Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Bloco de código
themeMidnight
titleBeneficiaries
linenumberstrue
{
    "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


BodyPropriedades:

...

Propriedade

...

Descrição

...

Tamanho

...

Tipo

...

Formato
eventDateData do evento8Caractereaaaammdd
eventTypeTipo de evento11CaractereBloqueio
Desbloqueio
entry_hourHora do registro5Caracterehh:mm
subscriberIdMatricula do beneficiário15Caractere012345678901234
entry_dateData do registro8Caractereaaaammdd


Body:

Bloco de código
themeMidnight
titlebeneficiaryStatus
linenumberstrue
{
    "items": [
        {
linenumberstrue
{
    "items": [
        {
            "eventDate": "Data do evento Example: 1900-01-01",
            "eventType": "Tipo de evento(Bloqueio/Desbloqueio)",
            "entry_hour": "Hora do registro Example: 00:01",
            "subscriberId": "Matricula do beneficiário Example: 00010002012345010",
            "entry_dateeventDate": "Data do registro Example: 1900-01-01"19000101",
        }
    ],
    "healthInsurerId"eventType": "Example: 0001Desbloqueio",
    "ansRegistry": "Example: 321456"
}

HealthProviders

        "entry_hour": "00:01",
            "subscriberId": "00010002012345010",
            "entry_date": "19000101"
        }
    ],
    "healthInsurerId": "0001",
    "ansRegistry": "321456"
}


HealthProviders

API: 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 operadorada operadora


Propriedades:

PropriedadeDescriçãoTamanhoTipoFormato
healthProviderCode

Indica o código da rede de atendimento

8Caractere098765
healthProviderDocument

Informa o CPF/CNPJ da rede de atendimento

14Caractere0001098765000101
name

Informa o nome da rede de atendimento

60Caractere
healthProviderTypeIndica se o prestador é do tipo pessoa física ou pessoa juridica1Caractere

F - Física

J - Juridica

healthProviderClassInforma o tipo de prestador3Caractere

MED - MEDICO

LAB - LABORATORIO

HOS - HOSPITAL

OPE - OPERADORA

CLI - CLINICA

DEN - DENTISTAS

email

Informa um endereço de e-mail da rede de atendimento

60Caractere


Body:

Bloco de código
themeMidnight
titlehealthProviders
linenumberstrue
{
    "items": [
        {
            "healthProviderCode": "BAU_CODIGO (Varchar(8)) Example: 098765",
            "healthProviderDocument": "BAU_CPFCGC (Varchar(14)) Example: 0001098765000101",
            "name": "BAU_NOME (Varchar(60)) Example: Exemplo de prestador RDA",
            "healthProviderType": "BAU_TIPPE (Varchar(1)) Example: Use 'J' para juridica e 'F' para fisica "healthProviderType": "J",
            "healthProviderClass": "BAU_TIPPRE (Varchar(3)) Example: CLI",
            "email": "BAU_EMAIL (Varchar(60)) Example: [email protected]"
        }
    ],
    "healthInsurerId": "Example: 0001",
    "ansRegistry": "Example: 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:

Bloco de código
themeMidnight
titleattendanceLocations
linenumberstrue
{
    "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",
            "zipCode": "BB8_CEP (Varchar(8)) Example: 09876543",
            "address": "BB8_END (Varchar(40)) Example: Exemplo de endereco",
            "addressNumber": "BB8_NR_END (Varchar(6)) Example: 123",
            "addressComplement": "BB8_COMEND (Varchar(30)) Example: Complemento de endereco",
            "cityName": "BB8_MUN (Varchar(30)) Example: Exemplo de municipio",
            "stateAbbreviation": "BB8_EST (Varchar(2)) Example: SP",
            "district": "BB8_BAIRRO (Varchar(30)) Example: Exemplo de bairro",
            "cnesCode": "BB8_CNES" (Varchar(7)) Example: 0987654,
            "region": "BB8_REGMUN (Varchar(3)) Example: 012"
        }
    ],
    "healthInsurerId": "Example: 0001",
    "ansRegistry": "Example: 321456"
}

...