Essa é uma revisão anterior do documento!

Service-Oriented Architecture (SOA) SSI


Especificações Técnicas: eSigsWebServiceConsulta

Objetivo

Disponibilizar as funcionalidades de Requisitar Exames a outros sistemas através de Web Service.

Atores

Endereço do Web Service

O Web Service está disponível no seguinte endereço:

Desenvolvimento 

Endereço: 
WSDL:

Homologação 

Endereço: 
WSDL:

Produção 

Endereço: http://10.65.121.12:8086/axis/eSigsWebServiceConsulta.jws
WSDL: http://10.65.121.12:8086/axis/eSigsWebServiceConsulta.jws?wsdl

Autenticação

Serviço para autenticar o usuário e fornecer uma chave que o autorizará a utilizar os serviços disponíveis.

Exemplo que deve ser passado ao método “LoginUsuario” para Autenticação:

URL http://10.65.121.12:8086/axis/eSigsWebServiceConsulta.jws?method=LoginUsuario&Usuario=wslab&Senha=123456&Instituto=ICHC 

  <Usuario>wslabs</Usuario>
  <Senha>123456</Senha>
  <Instituto>ICHC</Instituto>


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
        <LoginUsuarioResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
            <LoginUsuarioReturn xsi:type="xsd:string">4953535348515251485453535552625362634954498892983884791827447794679884791</LoginUsuarioReturn>
        </LoginUsuarioResponse>
    </soapenv:Body>
</soapenv:Envelope>

Consulta Genérica

O Web Service “PesquisaGenerica” é composto de métodos que apóiam o processo de requisição de exame. Interpreta as solicitações do usuário, valida parâmetros e repassa-as aos outros objetos envolvidos no processo.

Método Exame

Este método retorna estrutura contendo informações dos exames cadastrados no Sistema de Laboratório SIGH_LAB.

Parâmetros de entrada

Nome Tipo Obrigatório Comentário
Pesquisa S EXAME
Autenticacao S Chave de Autorização obtido na execução do método “LoginUsuario”
PesqExata S N (não), S(sim)
Ativo S ‘S’ (sim), ‘N’ (não) ou 'T' (todos)
Identificador N Objetivo é obter os dados do exame pelo Número Identificador do campo Id_Unid_Exame_Material
Codigo N Objetivo é buscar dados de exames com código ou parte dele no campo cd_exame.
Descricao N Objetivo é buscar dados de exame com o nome ou parte do nome do exame do campo NM_Exame.
Registro N
UF N
Laboratorio N Objetivo é buscar dados dos exames de um Laboratório com a sigla do campo cd_Laboratorio.
Disponivel N

Retorno para o Cliente

Nome Tipo Conteúdo Comentário
<EXAME>
<MENSAGEM>
<VERSAO>
<DATA_VERSAO>
<DATA_SERVICO>
<COD_MENSAGEM>
<DSR_MENSAGEM>
<TPO_MENSAGEM>
</MENSAGEM>
<REGISTRO> A Pesquisa poderá retornar um ou mais registros com informações do exame.
<ID_UNID_EXAME_MATERIAL> NUMBER(15) Único Número identificador do exame
<CD_EXAME> VARCHAR2(8) Código do exame
<FL_APAC> CHAR(1) S ou N Exame requer procedimento especial para realização: APAC; BPA_I
<FL_ATIVO> CHAR(1) S ou N Se o exame está disponível para ser requisitado
<FL_DESC_MATERIAL> CHAR(1) S ou N Se o material de análise do exame requer descrição complementar?
<FL_DISPONIVEL_RECEP> CHAR(1) S ou N Exame disponível para ser solicitado fora da área técnica
<FL_ENVIO_URGENTE> CHAR(1) S ou N Se o exame é disponível 24hsr para realização
<FL_REQUER_QTDE> CHAR(1) S ou N Se para o material coletado é necessário informar o nº de frascos (ex. urina 24hrs)
<FL_TEMPO> CHAR(1) S ou N Se o exame requisitado necessita de coleta em diferentes tempos (ex: curva glicemia)
<ID_FORMULARIOPERGUNTA> NUMBER(15) Se exame requer alguma informação especial para realização.
<ID_MATERIAL> NUMBER(15) Identificador do material
<ID_SETOR> NUMBER(15) Identificador do setor que realiza o exame
<ST_SECAOEXAME> NUMBER(1) 1,2,3 ou Null Status do exame: Ativo(1), Sem previsão(2), Bloqueado para coleta(3)
<CD_MATERIAL> VARCHAR2(6) 1,2,3 ou Null Código do material do exame
<FL_BUSCA_MATERIAL> CHAR(1) Se para o material coletado é necessário abrir uma lista para nova escolha dos materiais para o exame
<NM_MATERIAL> VARCHAR2(40) Descrição do material de análise
<CD_SETOR> VARCHAR2(8) Código do setor que realiza o exame
<ID_LABORATORIO> NUMBER(15) Identificador do laboratório que realiza o exame
<NM_SETOR> VARCHAR2(45) Nome do setor responsável por realizar o exame
<NM_EXAME> VARCHAR2(100) Nome do exame
<CD_SERV> CHAR(5) Código do serviço responsável por realizar o exame
<CD_LABORATORIO> VARCHAR2(6) Sigla do laboratório responsável por realizar o exame
<ID_GR_MATERIAL> NUMBER(15) Identificador do grupo que pertence o material de análise do exame
<NM_SERVICO> VARCHAR2(60) Nome do serviço responsável por realizar o exame
</REGISTRO>
</EXAME>

Exemplo “PesquisaGenerica” para Pesquisa de Exame por Identificação:

URL: http://10.65.121.12:8086/axis/eSigsWebServiceConsulta.jws?method=&Autenticacao=&Pesquisa=&PesqExata=&Ativo=&Identificador= 

  <Pesquisa>EXAME</Pesquisa>
  <Autenticacao>49535552544849485154535355526254555362516251228589623226492471211812407203423799226492471</Autenticacao>
  <PesqExata>S</PesqExata>
  <Ativo>S</Ativo>
  <Identificador>6111</Identificador>
  <Codigo> </Codigo>
  <Descricao></Descricao>
  <Registro></Registro>
  <UF></UF>
  <Laboratorio></Laboratorio>
  <Disponivel></Disponivel>


  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <PesquisaGenericaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
        <PesquisaGenericaReturn xsi:type="xsd:string">
           <?xml version="1.0" encoding="ISO-8859-1"?> 
             <MENSAGEM>
               <VERSAO>1.17</VERSAO> 
               <DATA_VERSAO>22/12/2008</DATA_VERSAO>
               <DATA_SERVICO>29/11/2016 09:00:51</DATA_SERVICO> 
               <AMBIENTE>Desenvolvimento de Teste da Fábrica</AMBIENTE> 
               <COD_MENSAGEM>001</COD_MENSAGEM> 
               <DSR_MENSAGEM>Autenticação inválida.</DSR_MENSAGEM> 
               <TPO_MENSAGEM>ALERTA</TPO_MENSAGEM> 
             </MENSAGEM>
        </PesquisaGenericaReturn>
      </PesquisaGenericaResponse>
    </soapenv:Body>
  </soapenv:Envelope>

Exemplo “PesquisaGenerica” Projeto SoapUI:

esigswebserviceconsulta.zip