Caso sua empresa deseje exibir informações de utilização do beneficiário e de seu grupo familiar, ou ainda implementar a funcionalidade de PIN-SS Utilização, esta API deverá ser implementada.
...
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
/extratoUtilizacao/extrato
| POST | application/json | Endpoint para listar os registros de utilização relacionadas ao localizador (chaveUnica) |
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento | ||
|---|---|---|---|---|---|---|
chaveUnica | M | String | Chave de identificação do usuario. |
| ||
codigoProcedimento | M | String | Código do procedimento a ser exibido no extrato | Formato: Texto livre. | ||
dataAtendimento | M | String | Data de execução do serviço / atendimento | Formato: YYYY-MM-DD | ||
descricaoProcedimento | M | String | Descrição do procedimento a ser exibido | Formato: Texto livre. | ||
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 | ||
idContrato | M | String | Numero do contrato na qual o cliente esta vinculado |
| ||
idExecutante | M | String | Código de identificação do prestador executante no seu sistema. | Formato: ASCII (nao permite especiais). | ||
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 | ||
idTipoUsuario | M | String | Informe o tipo de usuário | Conteúdo válido: | ||
localAtendimento | M | String | Indique o local no qual foi realizado o atendimento | Formato: Texto livre | ||
nomeBeneficiario | M | String | Nome do beneficiário que aparecerá no extrato | Formato: Texto livre. | ||
nomeExecutante | M | String | Nome do prestador executante. | Formato: Texto livre. | ||
numeroGuia | M | String | numero da guia de registro do serviço/atendimento prestado. | Formato: Texto livre | ||
quantidade | M | Numerico | Quantidade executada. | Numérico | ||
valorServico | M | Numerico | Indique o valor 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.
|
Retorno da API - Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"alerta": "Dica: Extrato de utilização se refere aos serviços médicos realizados em tempo real. Os valores informados se referem aos custos da operadora.",
"dataInicioPeriodoApuracao": "2021-05-01",
"dataFimPeriodoApuracao": "2021-05-15",
"extrato": [
{
"idContrato": "99991",
"chaveUnica": "10102",
"nomeBeneficiario": "Derlandy Belchior",
"idTipoUsuario": "T",
"codigoProcedimento": "10101012",
"descricaoProcedimento": "Consulta eletiva em consultório",
"numeroGuia": "817191203-1019",
"dataAtendimento": "2019-03-01",
"idExecutante": "001",
"nomeExecutante": "Dr. Elias Lovato Neto",
"idTipoServico": "1",
"descricaoTipoServico": "Consulta",
"quantidade": 6.5,
"valorServico": 553.7,
"localAtendimento": "Laboratório Pretti Vitória"
},
{
"idContrato": "99991",
"chaveUnica": "10102",
"nomeBeneficiario": "Derlandy Belchior",
"idTipoUsuario": "T",
"codigoProcedimento": "10101012",
"descricaoProcedimento": "Consulta eletiva em consultório",
"numeroGuia": "817191203-1019",
"dataAtendimento": "2019-03-01",
"idExecutante": "001",
"nomeExecutante": "Dr. Elias Lovato Neto",
"idTipoServico": "1",
"descricaoTipoServico": "Consulta",
"quantidade": 6.5,
"valorServico": 553.7,
"localAtendimento": "Laboratório Pretti Vitória"
}
]
} |
...
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
http://exemplo.com/ extratPdf
| POST | application/json |
|
Parâmetros de entrada
...