Versões comparadas

Chave

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

Caso sua empresa deseje exibir informações de coparticipação do beneficiário e de seu grupo familiar, esta API deverá ser implementada.

...

Informações
Nota

IMPORTANTE

Os aplicativos e plataformas web refletem os dados conforme são consumidos diretamente da API. Caso haja necessidade de ordenar ou organizar as informações seguindo regras específicas da operadora, essas configurações devem ser realizadas diretamente na API responsável pelo fornecimento dos dados.

Endpoint

Endpoint

Método

Header Content-Type

Descrição

/extratoCoparticipacao/extrato

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/extrato”.

POST

application/json

Endpoint para listar os registros de coparticipação relacionadas ao localizador (chaveUnica)

...

Nota

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

idContrato

M

String

Numero do contrato na qual o cliente esta vinculado.

 

descricaoContrato

M

String

Nome do contrato que aparecerá no extrato.

 

dataInicioVigenciaContrato

M

String

Data de inicio da vigencia do contrato que aparecerá no extrato.

 

chaveUnica

M

String

Chave de identificação do usuario.

 

nomeBeneficiario

M

String

Nome do beneficiário que aparecerá no extrato

Formato: Texto livre.

idTipoUsuario

M

String

Informe o tipo de usuário

Conteúdo válido:
T = Titular
D = Dependente
A = Agregado
Apenas maiúsculos.

codigoProcedimento

M

String

Código do procedimento a ser exibido no extrato

Formato: Texto livre.

descricaoProcedimento

M

String

Descrição do procedimento a ser exibido

Formato: Texto livre.

numeroGuia

M

String

numero da guia de registro do serviço/atendimento prestado.

Formato: Texto livre

dataAtendimento

M

String

Data de execução do serviço / atendimento

Formato: YYYY-MM-DD

idExecutante

M

String

Código de identificação do prestador executante no seu sistema.

Formato: ASCII (nao permite especiais). 

nomeExecutante

M

String

Nome do prestador executante.

Formato: Texto livre.

idTipoServico

M

String

Código do tipo de serviço realizado. O código de serviços será utilizado para agrupar os procedimentos e apresentar os subtotais exigidos pela RN 389

Formato: ASCII (nao permite especiais). 

Recomenda-se observância à RN 329

descricaoTipoServico

M

String

Descrição do tipo de serviço realizado, exemplo:

Consultas, Exames/Terapias, Internação, Odontologia, outras despesas, entre outras. 

Assim como o atributo codigoTipoServico, servirá como agrupador para apresentação de subtotais exigidos pela RN 389.

Formato: Texto livre.

Recomenda-se observância à RN 329

quantidade

M

Numerico

Quantidade executada.

Numérico

valorServico

M

Numerico

Indique o valor individualizado (unitário) do serviço.

Poderá definir através da configuração da funcionalidade se deseja exibir o valor por grupo/ individualmente ou apenas o total. (RN 389 permite esse comportamento).

Formato: Numérico.

Caso não tenha valor a ser exibido deve informar o valor zerado.

Caso não queria exibir deve ajustar a configuração da funcionalidade para este comportamento.

Informações

Informe o valor unitário. O valor será multiplicado pelo atributo quantidade.

valorCoparticipacao

M

Numerico

Indique o valor da coparticipação individualizado do serviço. Poderá definir através da configuração da funcionalidade se deseja exibir o valor por grupo/ individualmente ou apenas o total. (RN 389 permite esse comportamento).

Formato: Numérico.

Caso não tenha valor a ser exibido deve informar o valor zerado.

Caso não queria exibir deve ajustar a configuração da funcionalidade para este comportamento.

Informações

Informe o valor unitário. O valor será multiplicado pelo atributo quantidade.

localAtendimento

M

String

Indique o local no qual foi realizado o atendimento

Formato: Texto livre

...

Aviso

  

Método "extratoPdf"

Este método aplica-se apenas para a funcionalidade de CHAT através de widget.
Nota

...

  1. Prioriza-se a URL em relação ao base64

  2. O método construído por sua empresa deverá validar se existem lançamentos na competência selecionada.

  3. Será adicionado ao corpo da requisição as informações enviadas no atributo integracao  e chaveUnica.

...

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ extratPdf

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/extratoPdf”.

POST

application/json

 

Parâmetros de entrada

...

Aviso