Histórico da Página

CONTEÚDO

Visão Geral

Configurações INI
Verbos
Exemplos de chamada da API
Atributos de Resposta
Pontos de Entrada

...

A API procedures foi desenvolvida para ser utilizada em conjunto com o Portal Autorizador (HAT) auxiliando a busca de procedimentos nas rotinas de Digitação de Guias e Jornadas de Atendimento.

VERBO GET

Através do verbo GET, a API retorna os eventos disponíveis para utilização realizando a busca através de um filtro complexo ou por código de procedimento (via pathparam).

...

http://localhost:8080/rest/totvshealthplans/v1/procedures/2282000026/teethRegions/12/surfaces?page=1&pageSize=10

05. ATRIBUTOS DE RESPOSTA

Chamadas GET:

Atributo	Campo Protheus	Tipo
manufacturer	BTQ_FABRIC	Caracter
procedureId	BTU_CODTAB + BTU_CDTERM ou BTQ_CODTAB + BTQ_CDTERM	Caracter
procedureCode	BTU_CDTERM ou BTQ_CDTERM	Caracter
procedureType	BR8_TPPROC	Caracter
inSerie	BJE_TIPO = '2' (o registro BJE é vinculado ao BR8_CLASSE

...

Lógico
eventType	BR8_TIPEVE	Caracter
procedureDescription	BR8_DESCRI	Caracter
anvisaId	Sempre vazio (mantido para manter a integridade já existente)	Caracter
tableCode	BTU_CODTAB ou BTQ_CODTAB	Caracter
manufacturerReference	BTQ_REFFAB	Caracter
procedureDental	BR8_ODONTO = '1'	Lógico

Exemplo de resposta com evento encontrado (filtro complexo):

Bloco de código

title	Sucesso 202

{
    "items": [
        {
            "manufacturer": "",
            "procedureId": "2210101012",
            "procedureCode": "10101012",
            "procedureType": "0",
            "inSerie": false,
            "eventType": "",
            "procedureDescription": "CONSULTA EM CONSULTORIO",
            "anvisaId": "",
            "tableCode": "22",
            "manufacturerReference": "",
			"procedureDental": false
        }
    ],
    "hasNext": false
}

Exemplo de resposta com evento encontrado (busca por ID):

Bloco de código

title	Sucesso 202

{
    "manufacturer": "",
    "procedureId": "2210101012",
    "procedureCode": "10101012",
    "procedureType": "0",
    "inSerie": false,
    "eventType": "",
    "procedureDescription": "CONSULTA EM CONSULTORIO",
    "anvisaId": "",
    "tableCode": "22",
    "manufacturerReference": "",
    "procedureDental": false
}

Em buscas por filtro complexo, a quantidade mínima de caracteres para realizar a busca é 3. Se forem informados menos que 3, será apresentada uma mensagem impeditiva:

Bloco de código

title	Sucesso 202

{
    "code": 200,
    "message": "Nao foram localizados resultados com os valores informados",
    "detailedMessage": "O servidor nao foi capaz de entender a solicitacao",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

Em buscas por filtro complexo, a quando não for encontrado um evento com os parâmetros informados:

Bloco de código

title	Sucesso 202

{
    "items": [],
    "hasNext": false
}

Busca por dentes:

...

Bloco de código

title	Sucesso 202

{
    "items": [
        {
            "procedureCode": "82000026",
            "terminologyCode": "11",
            "description": "Incisivo Central Superior Direito",
            "hasSurfaces": "1",
            "permanent": true,
            "deciduous": false
        },
        {
            "procedureCode": "82000026",
            "terminologyCode": "12",
            "description": "Incisivo Lateral Superior Direito",
            "hasSurfaces": "1",
            "permanent": true,
            "deciduous": false
        }
    ],
    "hasNext": false
}

Atributo	Campo Protheus	Tipo
procedureCode	BTU_CDTERM ou BTQ_CDTERM	Caracter
terminologyCode	B05_CODIGO	Caracter
description	BTQ_DESTER	Caracter
hasSurfaces	Verifica se há registros correspondentes no Alias BYL	Caracter
permanent	Baseado no campo B05_CODIGO: 11,12,13,14,15,16,17,18,21,22,23,24,25,26,27,28,31,32,33,34,35,36,37,38,41,42,43,44,45,46,47,48 - True 51,52,53,54,55,61,62,63,64,65,71,72,73,74,75,81,82,83,84,85 - False	Lógico
deciduous	Baseado no campo B05_CODIGO: 11,12,13,14,15,16,17,18,21,22,23,24,25,26,27,28,31,32,33,34,35,36,37,38,41,42,43,44,45,46,47,48 - False 51,52,53,54,55,61,62,63,64,65,71,72,73,74,75,81,82,83,84,85 - True	Lógico

Bloco de código

title	Sucesso 202

{
    "items": [
        {
            "procedureCode": "82000026",
            "terminologyCode": "11",
            "description": "Incisivo Central Superior Direito",
            "hasSurfaces": "1",
            "permanent": true,
            "deciduous": false
        },
        {
            "procedureCode": "82000026",
            "terminologyCode": "12",
            "description": "Incisivo Lateral Superior Direito",
            "hasSurfaces": "1",
            "permanent": true,
            "deciduous": false
        }
    ],
    "hasNext": false
}

Busca por faces:

Atributo	Campo Protheus	Tipo
procedureCode	BTU_CDTERM ou BTQ_CDTERM	Caracter
id	R_E_C_N_O_ da BYL	Numérico
teethCode	B05_CODIGO	Caracter
terminologyCode	BYL_FACE	Caracter
hasSurfaces	Verifica se há registros correspondentes no Alias BYL	Caracter
permanent	Baseado no campo B05_CODIGO: 11,12,13,14,15,16,17,18,21,22,23,24,25,26,27,28,31,32,33,34,35,36,37,38,41,42,43,44,45,46,47,48 - True 51,52,53,54,55,61,62,63,64,65,71,72,73,74,75,81,82,83,84,85 - False	Lógico
deciduous	Baseado no campo B05_CODIGO: 11,12,13,14,15,16,17,18,21,22,23,24,25,26,27,28,31,32,33,34,35,36,37,38,41,42,43,44,45,46,47,48 - False 51,52,53,54,55,61,62,63,64,65,71,72,73,74,75,81,82,83,84,85 - True	Lógico
description	BTQ_DESTER	Caracter

...

Bloco de código

title	Sucesso 202

{
    "items": [
        {
            "procedureCode": "82000026",
            "id": 10,
            "teethCode": "12  ",
            "terminologyCode": "DIL",
            "hasSurfaces": "1",
            "permanent": true,
            "deciduous": false,
            "description": "Distal Incisal Lingual"
        }
    ],
    "hasNext": false
}

06. PONTOS DE ENTRADA

Foram implementados os pontos de entrada PLRSTPR1 e PLRSTPR2 para auxiliarem na API.

...

O ponto de entrada PLRSTPR1 permite customizar a Query que será executadas para buscar os procedimentos.

Parâmetros:

Paramixb	Parâmetros	Descrição	Tipo
paramixb[1]	cSql	Query padrão montada pelo sistema	Caracter
paramixb[2]	cType	Indica se está realizando a busca por filtro complexo ou id. C - Complexo S - Busca por id	Caracter
paramixb[3]	cFilter	Conteúdo do Queryparam filter	Caracter
paramixb[4]	cTableCode	Conteúdo do Queryparam tableCode	Caracter
paramixb[5]	cProcedId	Conteúdo do Queryparam procedureId	Caracter
paramixb[6]	lSrcTabCode	Indica se a busca será realizada por Código Tabela + Procedimento	Lógico
paramixb[7]	cCodRda	Código do Prestador que está realizando a busca	Caracter

Retorno:

Retorno	Descrição	Tipo	Obrigatório
cSql	Query que será executada	Caracter	Sim

...

Bloco de código

title	Ponto de Entada PLRSTPR1

User Function PLRSTPR1()

    Local cSql := paramixb[1]
    Local cType := paramixb[2]
    Local cFilter  := paramixb[3]
    Local cTableCode := paramixb[4]
    Local cProcedID := paramixb[5]
    Local lSrcTabCode  := paramixb[6]

    	Local cCodRda:= paramixb[7]      

//Implementar ajuste desejado
   
Return cSql

...

Árvore de páginas

Versões comparadas

Versão antiga 14

Nova versão 24

Chave

CONTEÚDO

05. ATRIBUTOS DE RESPOSTA

06. PONTOS DE ENTRADA