Histórico da Página

...

Visão Geral
Exemplo de utilização
1. CID
2. Procedimentos do CID
3. Tabela de Código de Erros
Tela Doenças Preexistentes
1. Outras Ações / Ações relacionadas
Tela Doenças Preexistentes
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

Este documento tem como objetivo demonstrar a utilização dos endpoints de doenças preexistentes do beneficiário (CID), que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).

/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/cid
/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/cid/{cid}/procedures

Esses endpoints são utilizados na nova tela de

...

Gestão do

...

Beneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)

Clique aqui para detalhes sobre como habilitar o serviço de APIs

02. EXEMPLO DE UTILIZAÇÃO

...

Retorna as doenças preexistentes (CID) do beneficiário.

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/cid

Image Modified

Parâmetros

Authorization (header)	Image Modified	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	Image Modified	'application/json' é o formato do conteúdo	*required
SubscriberId (path)	Image Modified	Número da carteirinha do beneficiário	*required
page (query)	Image Modified	Paginação da Coleção
pageSize (query)	Image Modified	Quantidade de Itens por Página
order (query)	Image Modified	Ordenação da Coleção
fields (query)	Image Modified	Filtro de campos dos registros
filter (query)	Image Modified	Indica o filtro querystring recebido (pode se utilizar um filtro oData)

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

items	Image Modified	Doenças preexistentes do beneficiário
items.{campo do SX3}	Image Modified	Os campos retornados da tabela BF3: bf3_coddoe bf3_desdoe bf3_pagagr bf3_valagr bf3_peragr bf3_mesagr bf3_unagr bf3_datcpt
struct	Image Modified	Estrutura dos fields de acordo com o dicionário de dados (SX3)
hasNext	Image Modified	Indica se ainda existem registros a serem retornados
remainingRecords	Image Modified	Quantidade de registros ainda existem para retorno

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso
linenumbers	true
collapse	true

{
  "items": [
    {
      "bf3_coddoe": "14.0",
      "bf3_desdoe": "GlossiteExcluir: glossite atrofica(K14.42)",
      "bf3_pagagr": "0",
      "bf3_valagr": 0,
      "bf3_peragr": 0,
      "bf3_mesagr": 1,
      "bf3_unagr": "1",
      "bf3_datcpt": "2022-1-1"
    },
    {
      "bf3_coddoe": "14.1",
      "bf3_desdoe": "Glossite romboide mediana",
      "bf3_pagagr": "0",
      "bf3_valagr": 0,
      "bf3_peragr": 0,
      "bf3_mesagr": 2,
      "bf3_unagr": "2",
      "bf3_datcpt": "2022-1-1"
    },
    {
      "bf3_coddoe": "14.3",
      "bf3_desdoe": "Hipertrofia das papilas linguais",
      "bf3_pagagr": "0",
      "bf3_valagr": 0,
      "bf3_peragr": 0,
      "bf3_mesagr": 3,
      "bf3_unagr": "3",
      "bf3_datcpt": "2022-1-1"
    },
    {
      "bf3_coddoe": "14.5",
      "bf3_desdoe": "Lingua escrotal, Fissurada, Gretada Lingua, Sulcada Exclui: lingua Fissurada, congenita (Q38.33)",
      "bf3_pagagr": "0",
      "bf3_valagr": 0,
      "bf3_peragr": 0,
      "bf3_mesagr": 4,
      "bf3_unagr": "4",
      "bf3_datcpt": "2022-1-1"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0,
  "struct": [
    {
      "field": "BF3_CODDOE",
      "type": "C",
      "title": "C.I.D.",
      "description": "Cod.Doenca",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BF3_DESDOE",
      "type": "C",
      "title": "Descricao",
      "description": "Descricao",
      "picture": "@!",
      "size": 25,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BF3_PAGAGR",
      "type": "C",
      "title": "Pg. Agr./CPT",
      "description": "Paga o Agravo/CPT ?",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Sim"
        },
        {
          "value": "0",
          "description": "Nao"
        }
      ]
    },
    {
      "field": "BF3_VALAGR",
      "type": "N",
      "title": "Vlr. Agravo",
      "description": "Valor do Agravo",
      "picture": "@E 99,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BF3_PERAGR",
      "type": "N",
      "title": "Per.Mensalid",
      "description": "Percentual da Mensalidade",
      "picture": "@E 99,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BF3_MESAGR",
      "type": "N",
      "title": "T.Agravo/CPT",
      "description": "Tempo Meses do Agravo/CPT",
      "picture": "999",
      "size": 3,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BF3_UNAGR",
      "type": "C",
      "title": "Unidade",
      "description": "Unidade",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Horas"
        },
        {
          "value": "2",
          "description": "Dias"
        },
        {
          "value": "3",
          "description": "Meses"
        },
        {
          "value": "4",
          "description": "Anos"
        }
      ]
    },
    {
      "field": "BF3_DATCPT",
      "type": "D",
      "title": "Dt. Base CPT",
      "description": "Data Base CPT",
      "picture": "@D",
      "size": 8,
      "decimals": 0,
      "cbox": []
    }
  ]
}

...

Mensagens de Erros

code	Image Modified	Código identificador do erro. (Tabela de Erros)
message	Image Modified	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Modified	Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
}

Tabela de Código de Erros

Código de erros informado no Json de retorno com falha (404):

Procedimentos do CID

Retorna os procedimentos (Eventos) vinculado a doença preexistente (CID) do beneficiário.

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/cid/{cid}/procedures

Image Added

Parâmetros

Authorization (header)	Image Added	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	Image Added	'application/json' é o formato do conteúdo	*required
subscriberId (path)	Image Added	Número da carteirinha do beneficiário	*required
cid (path)	Image Added	Doença Preexistente (CID) retornado no endpoint: /totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/cid Atributo: bf3_coddoe	*required
page (query)	Image Added	Paginação da Coleção
pageSize (query)	Image Added	Quantidade de Itens por Página
order (query)	Image Added	Ordenação da Coleção
fields (query)	Image Added	Filtro de campos dos registros
filter (query)	Image Added	Indica o filtro querystring recebido (pode se utilizar um filtro oData)

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

items	Image Added	Procedimentos vinculado a doença preexistente do beneficiário
items.{campo do SX3}	Image Added	Os campos retornados da tabela BYY: byy_codpro byy_despro byy_carenc byy_unidad
struct	Image Added	Estrutura dos fields de acordo com o dicionário de dados (SX3)
hasNext	Image Added	Indica se ainda existem registros a serem retornados
remainingRecords	Image Added	Quantidade de registros ainda existem para retorno

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso
linenumbers	true
collapse	true

{
  "items": [
    {
      "byy_codpro": "10101012",
      "byy_despro": "CONSULTA EM CONSULTORIO",
      "byy_carenc": 1,
      "byy_unidad": "1"
    },
    {
      "byy_codpro": "40303136",
      "byy_despro": "SANGUE OCULTO, PESQUISA NAS FEZES",
      "byy_carenc": 2,
      "byy_unidad": "2"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0,
  "struct": [
    {
      "field": "BYY_CODPRO",
      "type": "C",
      "title": "Cod Proced.",
      "description": "Codigo Procedimento",
      "picture": "@!",
      "size": 16,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BYY_DESPRO",
      "type": "C",
      "title": "Descricao",
      "description": "Descricao",
      "picture": "@!",
      "size": 30,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BYY_CARENC",
      "type": "N",
      "title": "Carencia",
      "description": "Carencia",
      "picture": "9999",
      "size": 4,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BYY_UNIDAD",
      "type": "C",
      "title": "Unidade",
      "description": "Unidade",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Horas"
        },
        {
          "value": "2",
          "description": "Dias"
        },
        {
          "value": "3",
          "description": "Meses"
        },
        {
          "value": "4",
          "description": "Anos"
        }
      ]
    }
  ]
}

...

Mensagens de Erros

code	Image Added	Código identificador do erro. (Tabela de Erros)
message	Image Added	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Added	Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
}

Tabela de Código de Erros

Código de erros informado no Json de retorno com falha:

Code	message	detailedMessage	Status Code

CodemessagedetailedMessage


E001	Beneficiário não encontrado.	Não foi encontrado nenhum Beneficiário com a matricula {subscriberId}	404

03. TELA DOENÇAS PREEXISTENTES

...

Principais Campos e Parâmetros

Campo	Descrição
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO	Carteirinha do beneficiário
BF3_CODDOE	Doença preexistente (CID)	Não se aplica	Não se aplica

05. TABELAS UTILIZADAS

BA1 - Beneficiários
BF3 - Doenças Preexistentes Preexistentes
BYY - Procedimentos da Doença Preexistente (CID)

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Tabela de Código de Erros

Procedimentos do CID

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Tabela de Código de Erros

03. TELA DOENÇAS PREEXISTENTES

05. TABELAS UTILIZADAS