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
Parâmetros

01. VISÃO GERAL

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.

...

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

05. ATRIBUTOS DE RESPOSTA

...

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):

Image Added

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:

...

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

...

Bloco de código

title	Ponto de Entada PLRSTPR2

User Function PLRSTPR2()

    Local oItem := paramixb[1]
    Local cItem := ''
    
    //Implementar ajuste desejado
    cItem := oItem:toJson()
    Conout('Procedure description: ' + TRB->PROCEDUREDESCRIPTIONJSON) //Capturando descricao do evento no alias TRB
    Conout('Json do objeto posicionado: ' + cItem) //Imprimindo Json do Evento posicionado

Return oItem

07. PARÂMETROS

A partir da versão disponibilizada na ISSUE DSAUREV-12086 (PLSProceduresSvc.tlpp - 11/07/2024 - 09:50:31) foi criado o parâmetro:

Parâmetro

Tipo

Descrição

Conteúdo Padrão

MV_PLAPIPR

Caracter

Define o modo de pesquisa da API procedures.

1 = BUSCA %

2 = % BUSCA %

1

Indicando 1 no parâmetro, a API vai buscar todos o registros que o início seja idêntico a pesquisa realizada. Exemplos:

Buscando por CONSUL, podemos ter os resultados:

CONSULTA DE URGÊNCIA
CONSULTA ELETIVA
CONSULTA ODONTOLÓGICA

Indicado 2 no parâmetro, a API vai buscar todos o registros que tenham a pesquisa realizada, independente se estiver no meio do registro encontrado. Exemplos:

Buscando por CONSUL, podemos ter os resultados:

APLICAÇÃO DE HIPOSSENSIBILIZANTE - EM CONSULTÓRIO (AHC) EXCLUSIVE O ALÉRGENO - PLANEJAMENTO TÉCNICO
ATENDIMENTO AMBULATORIAL OFTALMOLÓGICO DE CRIANÇA PRÉ-VERBAL (<4 ANOS) OU CRIANÇAS COM DÉFICIT INTELECTUAL, DIFICULDADE DE COMUNICAÇÃO OU POUCO COLABORATIVAS REALIZADA EM CONSULTÓRIO
BIOPSIA PERCUTANEA COM AGULHA GROSSA, EM CONSULTORIO

Card documentos

Informacao	A ordenação padrão da API sempre vai trazer os registros em ordem alfabética, por isso, atenção ao utilizar o conteúdo 2 no parâmetro pois os resultados podem ser diferente do esperado pelo Operador. No exemplo acima procuramos por CONSUL em vista de utilizar a Consulta Eletiva, mas haviam registros com CONSUL no meio da descrição e foram apresentados antes pela questão de ordenação.
Titulo	ATENÇÃO

Árvore de páginas

Versões comparadas

Versão antiga 22

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

05. ATRIBUTOS DE RESPOSTA

07. PARÂMETROS