Árvore de páginas

Versões comparadas

Chave

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


ÍNDICE

  1. Visão Geral
  2. Configurando o ambiente de administração
  3. Customização de Verificação de Elegibilidade
  4. Customização de Validação do procedimento
  5. Customização da Gravação da autorização

01. VISÃO GERAL

Esta documentação visa explanar sobre as API's desenvolvidas para verificar regras específicas (customizadas) da operadora de saúde em determinados pontos da autorização construída no HAT. Isto é, a Operadora de Saúde deverá desenvolver uma API em seu software de gestão que validará regras específicas na verificação de elegibilidade do beneficiário, na validação dos procedimentos e na gravação do atendimento. A padronização de como o HAT enviará as informações para esta API e o que esperará de retorno será documentada neste espaço.

Para mais informações sobre outras API's acesse o endereço https://api.totvs.com.br/

02. Configurando o ambiente de administração

Para configurar os endpoints da customização, é necessário acessar o painel de administração do HAT.

...

  1.        Informe a URL Base no campo endpoint
  2.        Informe o path do endpoint conforme exemplo abaixo
  3.        O tipo deve ser POST
  4.        Informe um tempo de timeout em segundos. Este tempo será usado para informar ao HAT qual o tempo crítico que a customização leva para responder.
  5.        Se possuir healthcheck do endpoint, informe a URL.

        

03. Customização de Verificação de Elegibilidade

Abaixo é o corpo da requisição que o HAT enviará para o seu endpoint customizado

...

Nome

Tipo

Descrição

beneficiary

Object

Dados do beneficiário

beneficiary.phoneNumber

String

Telefone do beneficiário

beneficiary.newbornAttendance

String

S para atendimento RN e N para atendimento normal

beneficiary.holderCPF

String

CPF do beneficiário ou responsável

beneficiary.whenToCharge

String

1 para Coparticipação com pagamento no ato e 0 Sem coparticipação

beneficiary.birthdate

String

Data de nascimento

Beneficiary.owner

Object

Dados do titular

beneficiary.isOwner

Boolean

Se o beneficiário é titular

beneficiary.CNS

String

Código do Cartão Nacional de saúde

beneficiary.subscriberId

String

Matrícula

beneficiary.name

String

Nome

beneficiary.companyName

String

Nome da empresa do plano

beneficiary.oldSubscriberId

String

Matricula antiga (matant)

beneficiary.healthInsurance

Object

Dados do plano

beneficiary.healthInsurance.code

String

Código do plano

beneficiary.healthInsurance.roomType

String

Tipo de acomodação

beneficiary.healthInsurance.description

String

Descrição do plano

beneficiary.cardExpiration

String

Data de expiração da carteirinha

rejectionCauses

Array of Object

Críticas já validadas pelo HAT

rejectionCauses[n].code

String

Código da Crítica

rejectionCauses[n].alert

String

Se é alerta “1” ou não “0”

rejectionCauses[n].description

String

Descrição da crítica

authorizationTypeString

Tipo de guia

1 – Consulta

2 – Exame

3 – Execução

4 – Internação

9 – Tratamento odontológico

journeyString

Jornada da guia

1 – Consulta

2 – Exame

3 – Execução

4 – Internação

9 – Tratamento odontológico

10 – Pronto Socorro

11 – Tratamento Seriado

Abaixo a resposta que o seu endpoint deve retornar:

...

Bloco de código
languagejs
themeRDark
titleJSON de envio
linenumberstrue
collapsetrue
{
    "beneficiary": {
        "phoneNumber":"63989382024",
        "newbornAttendance":"N",
        "holderCPF":"72454212501",
        "whenToCharge":"0",
        "birthdate":"1983-03-23",
        "owner": {
            "phoneNumber":"2129543310",
            "newbornAttendance":"N",
            "holderCPF":"81419722190",
            "whenToCharge":"0",
            "birthdate":"1985-05-26",
            "isOwner": true,
            "CNS":"207239309460006",
            "subscriberId":"00010002000005001",
            "name":"Iago Vinicius Oliveira",
            "companyName":"TOTVS SA",
            "oldSubscriberId":"148792460664",
            "healthInsurance": {
                "code":"0001",
                "roomType":"01",
                "description":"Plano Essential Plus",
            },
            "cardExpiration":"2020-10-15",
        },
        "isOwner": false,
        "CNS":"973117025950000",
        "subscriberId":"00010002000005015",
        "name":"Andrea Manuela Beatriz Lima",
        "companyName":"TOTVS SA",
        "oldSubscriberId":"248792460664",
        "healthInsurance": {
            "code":"0001",
            "roomType":"01",
            "description":"Plano Essential Plus",
        },
        "cardExpiration":"2020-10-15"
    },
    "rejectionCauses": [
        {
            "code":"505",
            "alert":"0",
            "description":"Familia Bloqueada"
        }
    ],
	"authorizationType": 3,
	"journey": 11
}
Bloco de código
languagejs
themeRDark
titleJSON de resposta
linenumberstrue
collapsetrue
{
    "elegibilityResponse":"N",
    "rejectionCauses": [
        {
            "code":"505",
            "alert":"0",
            "description":"Familia Bloqueada"
        }
    ]
}

04. Customização da Validação do procedimento

O HAT vai enviar para o seu endp um corpo diferente para cada tipo de atendimento pois as informações variam de acordo com a guia. Por exemplo: Data de internação: Informado somente na guia de internação.

...

Bloco de código
languagejs
themeRDark
titleJSON de resposta
linenumberstrue
collapsetrue
{
    "procedureStatus": "0"
    "auditing":false,
    "rejectionCauses": [
      {
        "idTiss": "1007",
        "code": "002",
        "alert": "0",
        "description": "Procedimento em carencia para este usuario.. Data fim da carencia: 03/11/2068"
      }
    ]
}

05. Customização da Gravação da autorização

O HAT vai enviar para o seu endpoint de customização, um corpo diferente para cada tipo de atendimento pois as informações variam de acordo com a guia. Por exemplo: Data de internação: Informado somente na guia de internação.

...