Você está na página 1de 60

Web Service AOL

Manual Técnico
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

A reprodução integral ou parcial deste documento somente poderá ser realizada com autorização escrita da
Diagnósticos da América S.A.

Controle de Versão
DATA
Nº VERSÃO AUTOR Observação
LIBERAÇÃO

1.0 13/12/2016 Mario Rossafa Construção inicial

Reformulação manual e atualização de todos os


2.0 04/06/2018 Wellington Santos
serviços

Inserção do serviço /v2/resultados/pdf e


3.0 25/07/2018 Wellington Santos
atualização

4.0 04/09/2018 Wellington Santos Inserção do serviço /v2/resultados/lote

4.1 24/09/2018 Wellington Santos Alteração do serviço /v2/resultados/lote

1
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

Índice
Web Service 3
Ambientes 3
Homologação 3
Produção 3
Serviços 3
Teste de conexão 3
Listar materiais 4
Listar materiais exame 6
Listar situação amostra 8
Incluir solicitação 10
Incluir exame 27
Excluir exame 35
Listar resultados 39
Listar resultados PDF 52
Listar resultados lote 54

2
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

Web Service
O Web Service descrito aqui tem por objetivo disponibilizar recursos de integração do serviço de apoio
laboratorial e outro sistema LIS(Laboratory Integration System) sem a necessidade de utilização do software
AOL. Segue o padrão REST, ou seja a troca de mensagens com o Web Service é feita utilizando-se métodos
HTTP (POST, PUT, GET e DELETE) para mapear as ações de um CRUD.

Ambientes
O Web Service possui os ambientes de homologação e produção.

Homologação
Neste ambiente o desenvolvedor realiza testes e validações das suas aplicações sem ocorrência de impacto
na produção. O ambiente está disponível na URL abaixo:

➔ http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao

Produção
Neste ambiente não devem ser realizados testes pois a inserção de informações pode causar impactos na
produção. O ambiente está disponível na URL abaixo:

➔ http://webservice.alvaro.com.br/webserviceaol/rest/producao

Serviços
Os serviços são disponibilizados através de ​endpoint’s​ e podem conter ou não parâmetros e cabeçalho que
influenciam no que será retornado, abaixo detalharemos cada um deles.

Teste de conexão
Serviço para consultar estado e versão do Web Service.

REQUISIÇÃO
MÉTODO HTTP GET

ENDPOINT /teste

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/teste

3
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

RESPOSTA
CONTENT TYPE TEXTO

EXEMPLO OK v4.6.3

CÓDIGOS RESPOSTA
200 Sucesso

500 Falha interna, comunicar suporte da DASA

Listar materiais
Serviço para consultar todos os exames e seus respectivos materiais compatíveis, essa informação é
relevante pois o Web Service não aceita material não compatível para um exame específico.

REQUISIÇÃO
MÉTODO HTTP GET

ENDPOINT /listarMateriais

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/listarMateriais

HEADER

IDAGENTE Identificador do agente vinculado a entidade

SENHA Senha do agente

RESPOSTA
CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<consultaMaterialRetorno>
<exame exame="17ALF">
<materialPossivel codigo="5198" descricao="Soro RIA"/>
EXEMPLO
</exame>
<exame exame="17ALFAHP">
<materialPossivel codigo="5037" descricao="soro EXT"/>
</exame>

4
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<exame exame="17ALFCURVA">
<materialPossivel codigo="5198" descricao="Soro RIA"/>
</exame>
...
<consultaMaterialRetorno>

<?xml version="1.0" standalone="yes"?>


<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="consultaMaterialRetorno" type="consultaMaterialRetornoDTO"/>

<xs:complexType name="consultaMaterialRetornoDTO">
<xs:sequence>
<xs:element name="exame" type="exameMaterialDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="exameMaterialDTO">
XSD <xs:sequence>
<xs:element name="materialPossivel" type="materialDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="exame" type="xs:string"/>
</xs:complexType>

<xs:complexType name="materialDTO">
<xs:sequence/>
<xs:attribute name="codigo" type="xs:long"/>
<xs:attribute name="descricao" type="xs:string"/>
</xs:complexType>
</xs:schema>

CÓDIGOS RESPOSTA
CÓDIGO DESCRIÇÃO

200 Sucesso

401 Entidade ou agente sem permissão

500 Falha interna, comunicar suporte da DASA

5
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ELEMENTOS DO XML
CONSULTAMATERIALRETORNO

Elemento principal do retorno

EXAME

ATRIBUTO TIPO DESCRIÇÃO

EXAME STRING Identificador do exame

MATERIALPOSSIVEL

ATRIBUTO TIPO DESCRIÇÃO

CODIGO LONG Identificador do material

DESCRICAO STRING Descritivo do material

Listar materiais exame


Serviço para consultar todos os materiais compatíveis do exame especificado, essa informação é relevante
pois o Web Service não aceita material não compatível com o exame.

REQUISIÇÃO
MÉTODO HTTP GET

ENDPOINT /listarMateriais/{codigoExame}

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/listarMateriais/TSH

HEADER

IDAGENTE Identificador do agente vinculado a entidade

SENHA Senha do agente

PARÂMETRO DO ENDPOINT

CODIGOEXAME Identificador do exame a ser localizado

6
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

RESPOSTA
CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<consultaMaterialRetorno>
<exame exame="TSH">
EXEMPLO
<materialPossivel codigo="543" descricao="soro"/>
</exame>
</consultaMaterialRetorno>

<?xml version="1.0" standalone="yes"?>


<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="consultaMaterialRetorno" type="consultaMaterialRetornoDTO"/>

<xs:complexType name="consultaMaterialRetornoDTO">
<xs:sequence>
<xs:element name="exame" type="exameMaterialDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="exameMaterialDTO">
XSD <xs:sequence>
<xs:element name="materialPossivel" type="materialDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="exame" type="xs:string"/>
</xs:complexType>

<xs:complexType name="materialDTO">
<xs:sequence/>
<xs:attribute name="codigo" type="xs:long"/>
<xs:attribute name="descricao" type="xs:string"/>
</xs:complexType>
</xs:schema>

7
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

CÓDIGOS RESPOSTA
CÓDIGO DESCRIÇÃO

200 Sucesso

401 Entidade ou agente sem permissão

500 Falha interna, comunicar suporte da DASA

ELEMENTOS DO XML
CONSULTAMATERIALRETORNO

Elemento principal do retorno

EXAME

ATRIBUTO TIPO DESCRIÇÃO

EXAME STRING Identificador do exame

MATERIALPOSSIVEL

ATRIBUTO TIPO DESCRIÇÃO

CODIGO LONG Identificador do material

DESCRICAO STRING Descritivo do material

Listar situação amostra


Serviço para consultar a situação da amostra

REQUISIÇÃO
MÉTODO HTTP GET

SERVIÇO /situacaoAmostra/{codigoBarrasAmostra}

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/situacaoAmostra/01234567890

8
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

HEADER

IDAGENTE Identificador do agente vinculado a entidade

SENHA Senha do agente

PARÂMETRO

CODIGOBARRASAMOSTRA Código de barras da amostra a ser localizada

RESPOSTA
CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


EXEMPLO <AmostraSituacaoRetorno amostra="030700730778" dataRecebimento="2010-03-16 08:11:27.0"
ordemServico="32680935"/>

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="AmostraSituacaoRetorno" type="amostraSituacaoRetornoDTO"/>

<xs:complexType name="amostraSituacaoRetornoDTO">
XSD <xs:sequence/>
<xs:attribute name="amostra" type="xs:string"/>
<xs:attribute name="dataRecebimento" type="xs:string"/>
<xs:attribute name="ordemServico" type="xs:string"/>
</xs:complexType>
</xs:schema>

CÓDIGOS RESPOSTA
CÓDIGO DESCRIÇÃO

200 Sucesso

401 Entidade ou agente sem permissão

500 Falha interna, comunicar suporte da DASA

9
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ELEMENTOS DO XML
AMOSTRASITUACAORETORNO

Elemento principal do retorno

ATRIBUTO TIPO DESCRIÇÃO

AMOSTRA STRING Código de barras da amostra

DATARECEBIMENTO STRING Data que a amostra foi recebida

ORDEMSERVICO STRING Ordem de serviço da amostra

Incluir solicitação
Serviço para inclusão de solicitações

REQUISIÇÃO
MÉTODO HTTP PUT

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao

BODY

CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<solicitacoes datahora="2018-05-10T17:45:00.000-03:00"
idagente="123456" lis="teste" operador="teste" senha="4D74C5" versao="0">
<entidade codigo="123456">
<pacientes>
<paciente codigolis="123456" datanasc="1987-01-01-03:00" nome="FULANO" sexo="M" />
</pacientes>
<medicos>
EXEMPLO <medico crm="000000" nome="LABORATÓRIO XYZ" />
</medicos>
<solicitacao codigolis="" codigopaciente="123456" crm="0000-00" data="2018-05-02-03:00"
medicamentos="" observacao="" id_sequencial="TESTE1">
<amostra descricao="BASAL" material="897">
<exame codigo="CARIB" dadosadicionais=""/>
</amostra>
<amostra descricao="BASAL" material="543">
<exame codigo="TSH" dadosadicionais=""/>

10
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

</amostra>
</solicitacao>
</entidade>
</solicitacoes>

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>


<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="solicitacoes" type="solicitacoes"/>

<xs:complexType name="solicitacoes">
<xs:sequence>
<xs:element name="entidade" type="entidade" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="datahora" type="xs:dateTime" use="required"/>
<xs:attribute name="idagente" type="xs:int" use="required"/>
<xs:attribute name="lis" type="xs:string" use="required"/>
<xs:attribute name="operador" type="xs:string" use="required"/>
<xs:attribute name="senha" type="xs:string" use="required"/>
<xs:attribute name="versao" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:length value="8"/>
</xs:restriction>
</xs:simpleType>
XSD </xs:attribute>
</xs:complexType>

<xs:complexType name="entidade">
<xs:sequence>
<xs:element name="pacientes" type="pacientes" minOccurs="1" maxOccurs="1"/>
<xs:element name="medicos" type="medicos" minOccurs="0" maxOccurs="1"/>
<xs:element name="solicitacao" type="solicitacao" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>

<xs:attribute name="chave">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:length value="16"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="codigo" use="required" type="xs:string"/>


</xs:complexType>

11
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:complexType name="pacientes">
<xs:sequence>
<xs:element name="paciente" type="paciente" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="paciente">
<xs:sequence/>

<xs:attribute name="cep">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:length value="9"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="cidade">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="codigolis" use="required">


<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="datanasc" type="xs:date" use="required"/>

<xs:attribute name="endereco">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="40"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="estado">
<xs:simpleType>
<xs:restriction base="xs:string">

12
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:length value="2"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="nome" use="required">


<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="60"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="sexo" use="required">


<xs:simpleType>
<xs:restriction base="xs:string">
<xs:length value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>

<xs:complexType name="medicos">
<xs:sequence>
<xs:element name="medico" type="medico" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="medico">
<xs:sequence/>

<xs:attribute name="crm" use="required">


<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="7"/>
<xs:maxLength value="13"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="datanasc" type="xs:date"/>


<xs:attribute name="email" type="xs:string"/>

<xs:attribute name="nome" use="required">


<xs:simpleType>
<xs:restriction base="xs:string">

13
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:maxLength value="40"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="telefone" type="xs:string"/>


</xs:complexType>

<xs:complexType name="solicitacao">
<xs:sequence>
<xs:element name="amostra" type="amostra" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>

<xs:attribute name="codigolis">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="id_sequencial">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="45"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="codigopaciente" type="xs:string" use="required"/>

<xs:attribute name="crm">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="7"/>
<xs:maxLength value="13"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="dadosadicionais">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"/>
</xs:restriction>
</xs:simpleType>

14
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

</xs:attribute>

<xs:attribute name="data" type="xs:date" use="required"/>

<xs:attribute name="medicamentos">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="observacao">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>

<xs:complexType name="amostra">
<xs:sequence>
<xs:element name="exame" type="exame" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>

<xs:attribute name="descricao" use="required">


<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="identificacao" >


<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="14"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="material" type="xs:integer" use="required"/>


</xs:complexType>

15
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:complexType name="exame">
<xs:sequence>
<xs:element name="exameParticipante" type="exameParticipante" minOccurs="0"
maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="codigo" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="10"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="dadosadicionais">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="idlis">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>

<xs:complexType name="exameParticipante">

<xs:attribute name="nome" use="required">


<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="200"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="datanasc">
<xs:simpleType>
<xs:restriction base="xs:date" />
</xs:simpleType>
</xs:attribute>
<xs:attribute name="sexo">

16
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="tipo">
<xs:simpleType>
<xs:restriction base="xs:string">
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="observacao">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="nomeColetador">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="200"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="nomeJuiz">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="200"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="nomeIdentificador">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="200"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:schema>

17
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ELEMENTOS DO XML (BODY)


SOLICITACOES

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

DATAHORA DATETIME Data e hora da solicitação SIM yyyy-MM-ddTHH:mm:ss.SSSZ

IDAGENTE INTEGER Identificador do agente SIM 10

LIS STRING LIS​ (Laboratory Integration System) SIM 250

OPERADOR STRING Nome do operador SIM 20

SENHA STRING Senha do agente SIM 20

VERSAO STRING Versão do sistema SIM 8

ENTIDADE

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

CHAVE STRING Chave de autorização NÃO 16

CODIGO STRING Identificador da entidade SIM 11

PACIENTES

Lista de pacientes da solicitação

PACIENTE

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

Identificador do​ ​LIS​ (Laboratory


CODIGOLIS STRING SIM 20
Integration System)

CODIGO
STRING Identificador do paciente SIM 7 até 13
PACIENTE

DATANASC DATE Data de nascimento SIM yyyy-MM-dd

NOME STRING Nome do paciente SIM 60

SEXO STRING Sexo do paciente SIM 1

ENDERECO STRING Logradouro com número do paciente NÃO 40

MEDICOS

18
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

Lista de médicos da solicitação

MEDICO

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

Identificador do Conselho Regional de


CRM STRING SIM 7 até 13
Medicina

NOME STRING Nome do médico SIM 40

EMAIL STRING Email do médico NÃO 40

DATANASC DATE Data de nascimento do médico NÃO yyyy-MM-dd

TELEFONE STRING Telefone do médico NÃO 20

SOLICITACAO

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

Identificador do​ ​LIS​ (Laboratory


CODIGOLIS STRING NÃO 20
Integration System)

ID_SEQUENCIAL STRING Identificador sequencial NÃO 45

CODIGO
STRING Identificador do paciente SIM 40
PACIENTE

Identificador do Conselho Regional de


CRM STRING NÃO 7 até 13
Medicina

DATA DATETIME Data da solicitação SIM yyyy-MM-ddTHH:mm:ss.SSSZ

DADOSADICIONAIS STRING Descritivo de informações adicionais NÃO 250

Descritivo dos medicamentos a serem


MEDICAMENTOS STRING NÃO 250
utilizados

Descritivo de informações a serem


OBSERVACAO STRING NÃO 250
observadas

AMOSTRA

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

DESCRICAO STRING Descritivo da amostra SIM 20

IDENTIFICACAO STRING Identificador da amostra NÃO 14

19
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

MATERIAL INTEGER Identificador do material SIM 11

EXAME

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

CODIGO STRING identificador do exame SIM 10

DADOS
STRING Informações complementares NÃO 250
ADICIONAIS

Identificador do​ ​LIS​ (Laboratory


IDLIS STRING NÃO 250
Integration System)

EXAMEPARTICIPANTE

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

NOME STRING Nome do participante SIM 200

DATANASC DATE Data de nascimento do participante NÃO yyyy-MM-dd

SEXO STRING Sexo do participante NÃO 1

Tipo do participante
Valores suportados:
MÃE
TIPO STRING SIM 150
SUPOSTA MÃE
SUPOSTO PAI
FILHO

OBSERVACAO STRING Observações referente ao participante NÃO 250

NOMECOLETADOR STRING Nome do colaborador que fez a coleta do exame NÃO 200

NOME
STRING Nome do juiz que solicitou o exame NÃO 200
JUIZ

NOME
IDENTIFICADOR
STRING Primeiro nome do participante NÃO 200

20
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

RESPOSTA
CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<aol versao="0">
<cadastros tempoProcessamento="93.0">
<pacientes tempoProcessamento="78.0">
<paciente idAlvaro="11111111" idLis="123"/>
</pacientes>
<medicos tempoProcessamento="15.0">
<medico crm="0000-00" idAlvaro="123456"/>
</medicos>
</cadastros>
<solicitacoes tempoProcessamento="877.0">
<solicitacao id_sequencial="TESTE" incluido="true" baseBarras="4YTRCH" idAlvaro="123456"
tempoProcessamento="0.0">
<amostra codigoBarras="030792922792" descricao="basal" idAcondicionamento="26"
idAmostra="0" idAmostraExecutor="030792922792" idDestino="2" identificacao="" material="897">
<exame exame="CARIB" incluido="true" informacao="Exame(s): CARIB -&gt; incluído(s) com
sucesso!"/>
<layoutetiqueta>
<layout>N&#xD;
ZB&#xD;
EXEMPLO
q400&#xD;
D10&#xD;
A10,1,0,1,1,2,N,"FULANO"&#xD;
A10,23,0,1,1,1,N,"8776 18/05 300360113 45a"&#xD;
A10,35,0,1,1,1,N,"CARIB"&#xD;
A20,80,1,1,1,1,N,"030792922792"&#xD;
A380,2,1,1,2,1,N,"R"&#xD;
A380,20,1,1,1,1,N,"SANGUE TOT"&#xD;
A367,20,1,1,1,1,N,"BASAL"&#xD;
A354,20,1,1,1,1,N,""&#xD;
B40,80,0,2,3,5,80,N,"030792922792"&#xD;
P1&#xD;
</layout>
</layoutetiqueta>
</amostra>
</solicitacao>
</solicitacoes>
</aol>

<?xml version="1.0" standalone="yes"?>


XSD
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
21
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:element name="aol" type="aolRetornoDTO"/>

<xs:element name="baseRetornoLayoutEtiquetaDTO" type="baseRetornoLayoutEtiquetaDTO"/>

<xs:complexType name="aolRetornoDTO">
<xs:sequence>
<xs:element name="cadastros" type="cadastrosRetornoDTO" minOccurs="0"/>
<xs:element name="solicitacoes" type="solicitacoesRetornoDTO" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="versao" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="cadastrosRetornoDTO">
<xs:sequence>
<xs:element name="pacientes" type="pacientesRetornoDTO" minOccurs="0"/>
<xs:element name="medicos" type="medicosRetornoDTO" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="tempoProcessamento" type="xs:double" use="required"/>
</xs:complexType>

<xs:complexType name="pacientesRetornoDTO">
<xs:sequence>
<xs:element name="paciente" type="pacienteRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="tempoProcessamento" type="xs:double" use="required"/>
</xs:complexType>

<xs:complexType name="pacienteRetornoDTO">
<xs:sequence/>
<xs:attribute name="idAlvaro" type="xs:string"/>
<xs:attribute name="idLis" type="xs:string"/>
</xs:complexType>

<xs:complexType name="medicosRetornoDTO">
<xs:sequence>
<xs:element name="medico" type="medicoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="tempoProcessamento" type="xs:double" use="required"/>
</xs:complexType>

<xs:complexType name="medicoRetornoDTO">
<xs:sequence/>
<xs:attribute name="crm" type="xs:string"/>

22
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:attribute name="idAlvaro" type="xs:string"/>


</xs:complexType>

<xs:complexType name="solicitacoesRetornoDTO">
<xs:sequence>
<xs:element name="solicitacao" type="solicitacaoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="tempoProcessamento" type="xs:double" use="required"/>
</xs:complexType>

<xs:complexType name="solicitacaoRetornoDTO">
<xs:complexContent>
<xs:extension base="baseRetornoSolicitacaoDTO">
<xs:sequence/>
<xs:attribute name="fap" type="xs:string"/>
<xs:attribute name="idLis" type="xs:string"/>
<xs:attribute name="id_sequencial" type="xs:string"/>
<xs:attribute name="incluido" type="xs:boolean" use="required"/>
<xs:attribute name="informacao" type="xs:string"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:complexType name="baseRetornoSolicitacaoDTO" abstract="true">


<xs:sequence>
<xs:element name="amostra" type="baseRetornoAmostraDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="baseBarras" type="xs:string"/>
<xs:attribute name="idAlvaro" type="xs:string"/>
<xs:attribute name="tempoProcessamento" type="xs:string"/>
</xs:complexType>

<xs:complexType name="baseRetornoAmostraDTO">
<xs:sequence>
<xs:element name="exame" type="baseRetornoExameDTO" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="layoutetiqueta" type="baseRetornoLayoutEtiquetaDTO" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="codigoBarras" type="xs:string"/>
<xs:attribute name="descricao" type="xs:string"/>
<xs:attribute name="idAcondicionamento" type="xs:int"/>
<xs:attribute name="idAmostra" type="xs:string"/>
<xs:attribute name="idAmostraExecutor" type="xs:string"/>
<xs:attribute name="idDestino" type="xs:string"/>

23
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:attribute name="identificacao" type="xs:string"/>


<xs:attribute name="incluido" type="xs:boolean"/>
<xs:attribute name="informacao" type="xs:string"/>
<xs:attribute name="material" type="xs:string"/>
</xs:complexType>

<xs:complexType name="baseRetornoExameDTO">
<xs:sequence>
<xs:element name="exame" type="xs:string" minOccurs="0"/>
<xs:element name="exameParticipante" type="exameParticipanteEntradaDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="codigo" type="xs:string"/>
<xs:attribute name="exame" type="xs:string"/>
<xs:attribute name="incluido" type="xs:boolean" use="required"/>
<xs:attribute name="informacao" type="xs:string"/>
</xs:complexType>

<xs:complexType name="exameParticipanteEntradaDTO">
<xs:sequence/>
<xs:attribute name="boObrigatorio" type="xs:string"/>
<xs:attribute name="datanasc" type="xs:dateTime"/>
<xs:attribute name="nome" type="xs:string"/>
<xs:attribute name="nomeColetador" type="xs:string"/>
<xs:attribute name="nomeIdentificador" type="xs:string"/>
<xs:attribute name="nomeJuiz" type="xs:string"/>
<xs:attribute name="observacao" type="xs:string"/>
<xs:attribute name="qtEtiquetas" type="xs:string"/>
<xs:attribute name="sexo" type="xs:string"/>
<xs:attribute name="tipo" type="xs:string"/>
</xs:complexType>

<xs:complexType name="baseRetornoLayoutEtiquetaDTO">
<xs:sequence>
<xs:element name="layout" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

24
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

CÓDIGOS RESPOSTA
CÓDIGO DESCRIÇÃO

200 Sucesso

401 Entidade ou agente sem permissão

500 Falha interna, comunicar suporte da DASA

ELEMENTOS DO XML
AOL

Elemento principal do retorno

ATRIBUTO TIPO DESCRIÇÃO

VERSAO INTEGER Versão do WebService

CADASTROS

ATRIBUTO TIPO DESCRIÇÃO

TEMPOPROCESSAMENTO DOUBLE Tempo de processamento dos cadastros

PACIENTES

ATRIBUTO TIPO DESCRIÇÃO

TEMPOPROCESSAMENTO DOUBLE Tempo de processamento dos pacientes

PACIENTE

ATRIBUTO TIPO DESCRIÇÃO

IDALVARO STRING Identificador do paciente no sistema Álvaro

IDLIS STRING Identificador do LIS ​(Laboratory Integration System)

MEDICOS

ATRIBUTO TIPO DESCRIÇÃO

TEMPOPROCESSAMENTO DOUBLE Tempo de processamento dos médicos

MEDICO

25
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ATRIBUTO TIPO DESCRIÇÃO

CRM STRING Registro do Conselho Regional de Medicina

IDALVARO STRING Identificador do médico no sistema Álvaro

SOLICITACOES

ATRIBUTO TIPO DESCRIÇÃO

TEMPOPROCESSAMENTO DOUBLE Tempo de processamento das solicitações

SOLICITACAO

ATRIBUTO TIPO DESCRIÇÃO

ID_SEQUENCIAL STRING Identificador Sequencial

IDLIS STRING Identificador LIS ​(Laboratory Integration System)

FAP STRING

INCLUIDO BOOLEAN Informa se a solicitação foi incluída

INFORMACAO STRING Informações da solicitação

BASEBARRAS STRING Código de barras da solicitação

IDALVARO STRING Identificador da solicitação no sistema Álvaro

TEMPOPROCESSAMENTO STRING Tempo de processamento da solicitação

AMOSTRA

ATRIBUTO TIPO DESCRIÇÃO

CODIGOBARRAS STRING Código de barras

DESCRICAO STRING Descritivo completo da amostra

IDACONDICIONAMENTO INTEGER Identificador do acondicionamento

IDAMOSTRA BOOLEAN Identificador da amostra

IDAMOSTRAEXECUTOR STRING Código de barras

IDDESTINO STRING Identificador do destino

IDENTIFICACAO STRING Identificador da solicitação no sistema Álvaro

26
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

INCLUIDO BOOLEAN Informa se a amostra foi incluída

INFORMACAO STRING Informações referentes a amostra

MATERIAL STRING Identificador do material

EXAME

ATRIBUTO TIPO DESCRIÇÃO

EXAME STRING Código do exame

INCLUIDO BOOLEAN Informa se o exame foi incluído

INFORMACAO STRING Informações referentes ao exame

EXAMEPARTICIPANTE

ATRIBUTO TIPO DESCRIÇÃO

NOME STRING Nome do paciente participante

SEXO STRING Sexo do participante

TIPO STRING Tipo do participante

DATANASC DATETIME Data de nascimento do participante

NOMECOLETADOR STRING Nome do colaborador que fez a coleta

NOMEJUIZ STRING Nome do juiz que solicitou o exame

LAYOUTETIQUETA

LAYOUT

TIPO DESCRIÇÃO

STRING Template para impressão de etiqueta

Incluir exame
Serviço para inclusão de exames em solicitações

27
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

REQUISIÇÃO
MÉTODO HTTP POST

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao

BODY

CONTENT TYPE XML

<?xml version="1.0" encoding="ISO-8859-1"?>


<inclusoes datahora="2014-05-02T10:35:56" idagente="123456"
lis="SISTEMAXYZ" operador="FULANO" senha="123456">
<entidade codigo="1234">
<solicitacao idAlvaro="11111111">
EXEMPLO <amostra material="123" identificacao="2" descricao="2" novaAmostra="true">
<exame codigoExame="TSH" dadosadicionais="volume=200" />
</amostra>
</solicitacao>
</entidade>
</inclusoes>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="inclusoes" type="inclusoes"/>

<xs:complexType name="inclusoes">
<xs:sequence>
<xs:element name="entidade" type="entidade" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="datahora" type="xs:dateTime"/>
<xs:attribute name="idagente" type="xs:int" use="required"/>
<xs:attribute name="lis" type="xs:string"/>
XSD <xs:attribute name="operador" type="xs:string"/>
<xs:attribute name="senha" type="xs:string"/>
</xs:complexType>

<xs:complexType name="entidade">
<xs:sequence>
<xs:element name="solicitacao" type="solicitacao" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="codigo" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="solicitacao">
<xs:sequence>

28
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:element name="amostra" type="amostra" minOccurs="0" maxOccurs="unbounded"/>


</xs:sequence>
<xs:attribute name="idAlvaro" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="amostra">
<xs:sequence>
<xs:element name="exame" type="exame" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="identificacao" type="xs:string" use="required"/>
<xs:attribute name="descricao" type="xs:string" use="required"/>
<xs:attribute name="material" type="xs:int" use="required"/>
<xs:attribute name="novaAmostra" type="xs:boolean" use="required"/>
</xs:complexType>

<xs:complexType name="exame">
<xs:sequence/>
<xs:attribute name="codigoExame" type="xs:string"/>
<xs:attribute name="dadosadicionais" type="xs:string"/>
<xs:attribute name="idlis" type="xs:string"/>
</xs:complexType>
</xs:schema>

ELEMENTOS XML (BODY)


INCLUSOES

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

DATAHORA DATETIME Data e hora da solicitação SIM yyyy-MM-ddTHH:mm:ss.SSSZ

IDAGENTE INTEGER Identificador do agente SIM 10

LIS STRING LIS​ (Laboratory Integration System) SIM 250

OPERADOR STRING Nome do operador SIM 20

SENHA STRING Senha do agente SIM 20

ENTIDADE

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

CODIGO STRING Identificador da entidade SIM 11

SOLICITACAO
29
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

Identificador da solicitação no sistema


IDALVARO INTEGER SIM 11
Álvaro

AMOSTRA

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

DESCRICAO STRING Descritivo da amostra SIM 20

IDENTIFICACAO STRING Identificador da amostra SIM 14

MATERIAL INTEGER Identificador do material SIM 11

Informa se é uma nova amostra ou


NOVAAMOSTRA BOOLEAN SIM true/false
usará uma existente

EXAME

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

CODIGO STRING identificador do exame SIM 10

DADOS
STRING Informações complementares NÃO 250
ADICIONAIS

Identificador do​ ​LIS​ (Laboratory


IDLIS STRING NÃO 250
Integration System)

RESPOSTA
CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<inclusoes tempoProcessamento="0.0">
<entidade codigo="1234">
<solicitacao baseBarras="4YTRF0" idAlvaro="11111111">
<amostra codigoBarras="030792923324" descricao="basal" idAcondicionamento="26"
idAmostra="0" idAmostraExecutor="030792923324" idDestino="2" identificacao="" incluido="true"
EXEMPLO
material="123">
<exame incluido="true" informacao="Exame(s): CARIB -&gt; incluído(s) com sucesso!">
<exame>CARIB</exame>
</exame>
<layoutetiqueta>
<layout>N&#xD;

30
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ZB&#xD;
q400&#xD;
D10&#xD;
A10,1,0,1,1,2,N,"FULANO DE TAL"&#xD;
A10,23,0,1,1,1,N,"1234 21/05 1111111145a"&#xD;
A10,35,0,1,1,1,N,"CARIB"&#xD;
A20,80,1,1,1,1,N,"030792923324"&#xD;
A380,2,1,1,2,1,N,"R"&#xD;
A380,20,1,1,1,1,N,"SANGUE TOT"&#xD;
A367,20,1,1,1,1,N,"BASAL"&#xD;
A354,20,1,1,1,1,N,""&#xD;
B40,80,0,2,3,5,80,N,"030792923324"&#xD;
P1&#xD;
</layout>
</layoutetiqueta>
</amostra>
<amostra codigoBarras="177188783619" descricao="2" idAcondicionamento="26"
idAmostra="1" idAmostraExecutor="177188783619" idDestino="35" identificacao="2"
incluido="true" material="123">
<exame incluido="true" informacao="Exame(s): TSH -&gt; incluído(s) com sucesso!">
<exame>TSH</exame>
</exame>
<layoutetiqueta>
<layout>N&#xD;
ZB&#xD;
q400&#xD;
D10&#xD;
A10,1,0,1,1,2,N,"FULANO DE TAL"&#xD;
A10,23,0,1,1,1,N,"1234 21/05 11111111 45a"&#xD;
A10,35,0,1,1,1,N,"TSH"&#xD;
A20,80,1,1,1,1,N,"177188783619"&#xD;
A380,2,1,1,2,1,N,"R"&#xD;
A380,20,1,1,1,1,N,"SORO"&#xD;
A367,20,1,1,1,1,N,"2"&#xD;
A354,20,1,1,1,1,N,""&#xD;
B40,80,0,2,3,5,80,N,"177188783619"&#xD;
P1&#xD;
</layout>
</layoutetiqueta>
</amostra>
</solicitacao>
</entidade>
</inclusoes>

<?xml version="1.0" standalone="yes"?>


XSD
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

31
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:element name="baseRetornoLayoutEtiquetaDTO" type="baseRetornoLayoutEtiquetaDTO"/>

<xs:element name="inclusoes" type="inclusaoRetornoDTO"/>

<xs:complexType name="inclusaoRetornoDTO">
<xs:sequence>
<xs:element name="entidade" type="entidadeInclusaoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="tempoProcessamento" type="xs:double" use="required"/>
</xs:complexType>

<xs:complexType name="entidadeInclusaoRetornoDTO">
<xs:sequence>
<xs:element name="solicitacao" type="solicitacaoInclusaoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="codigo" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="solicitacaoInclusaoRetornoDTO">
<xs:complexContent>
<xs:extension base="baseRetornoSolicitacaoDTO">
<xs:sequence/>
<xs:attribute name="informacao" type="xs:string"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:complexType name="baseRetornoSolicitacaoDTO" abstract="true">


<xs:sequence>
<xs:element name="amostra" type="baseRetornoAmostraDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="baseBarras" type="xs:string"/>
<xs:attribute name="idAlvaro" type="xs:string"/>
<xs:attribute name="tempoProcessamento" type="xs:string"/>
</xs:complexType>

<xs:complexType name="baseRetornoAmostraDTO">
<xs:sequence>
<xs:element name="exame" type="baseRetornoExameDTO" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element name="layoutetiqueta" type="baseRetornoLayoutEtiquetaDTO" minOccurs="0"/>
</xs:sequence>

32
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:attribute name="codigoBarras" type="xs:string"/>


<xs:attribute name="descricao" type="xs:string"/>
<xs:attribute name="idAcondicionamento" type="xs:int"/>
<xs:attribute name="idAmostra" type="xs:string"/>
<xs:attribute name="idAmostraExecutor" type="xs:string"/>
<xs:attribute name="idDestino" type="xs:string"/>
<xs:attribute name="identificacao" type="xs:string"/>
<xs:attribute name="incluido" type="xs:boolean"/>
<xs:attribute name="informacao" type="xs:string"/>
<xs:attribute name="material" type="xs:string"/>
</xs:complexType>

<xs:complexType name="baseRetornoExameDTO">
<xs:sequence>
<xs:element name="exame" type="xs:string" minOccurs="0"/>
<xs:element name="exameParticipante" type="exameParticipanteEntradaDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="codigo" type="xs:string"/>
<xs:attribute name="exame" type="xs:string"/>
<xs:attribute name="incluido" type="xs:boolean" use="required"/>
<xs:attribute name="informacao" type="xs:string"/>
</xs:complexType>

<xs:complexType name="exameParticipanteEntradaDTO">
<xs:sequence/>
<xs:attribute name="boObrigatorio" type="xs:string"/>
<xs:attribute name="datanasc" type="xs:dateTime"/>
<xs:attribute name="nome" type="xs:string"/>
<xs:attribute name="nomeColetador" type="xs:string"/>
<xs:attribute name="nomeIdentificador" type="xs:string"/>
<xs:attribute name="nomeJuiz" type="xs:string"/>
<xs:attribute name="observacao" type="xs:string"/>
<xs:attribute name="qtEtiquetas" type="xs:string"/>
<xs:attribute name="sexo" type="xs:string"/>
<xs:attribute name="tipo" type="xs:string"/>
</xs:complexType>

<xs:complexType name="baseRetornoLayoutEtiquetaDTO">
<xs:sequence>
<xs:element name="layout" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

33
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ELEMENTOS XML
INCLUSOES

Elemento principal do retorno

ATRIBUTO TIPO DESCRIÇÃO

TEMPOPROCESSAMENTO DOUBLE Tempo de processamento das inclusões

ENTIDADE

ATRIBUTO TIPO DESCRIÇÃO

CODIGO INTEGER Identificador da entidade

SOLICITACAO

ATRIBUTO TIPO DESCRIÇÃO

INFORMACAO STRING Informações da solicitação

BASEBARRAS STRING Código de barras da solicitação

IDALVARO STRING Identificador da solicitação no sistema Álvaro

TEMPOPROCESSAMENTO STRING Tempo de processamento da solicitação

AMOSTRA

ATRIBUTO TIPO DESCRIÇÃO

CODIGOBARRAS STRING Código de barras

DESCRICAO STRING Descritivo completo da amostra

IDACONDICIONAMENTO INTEGER Identificador do acondicionamento

IDAMOSTRA BOOLEAN Identificador da amostra

IDAMOSTRAEXECUTOR STRING Código de barras

IDDESTINO STRING Identificador do destino

IDENTIFICACAO STRING Identificador da solicitação no sistema Álvaro

INCLUIDO BOOLEAN Informa se a amostra foi incluída

INFORMACAO STRING Informações referentes a amostra

34
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

MATERIAL STRING Identificador do material

EXAME

ATRIBUTO TIPO DESCRIÇÃO

EXAME STRING Código do exame

INCLUIDO BOOLEAN Informa se o exame foi incluído

INFORMACAO STRING Informações referentes ao exame

LAYOUTETIQUETA

LAYOUT

TIPO DESCRIÇÃO

STRING Template para impressão de etiqueta

Excluir exame
Serviço para remoção de exames em solicitações cadastradas no sistema Álvaro.

REQUISIÇÃO
MÉTODO HTTP DELETE

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao

BODY

CONTENT TYPE XML

<?xml version="1.0" encoding="ISO-8859-1"?>


<exclusoes idagente="123456" lis="SISTEMAXYZ" operador="FULANO" senha="ABCDEF">
<entidade codigo="1234">
<solicitacao idAlvaro="123456">
EXEMPLO
<exame codigoExame="TSH"/>
</solicitacao>
</entidade>
</exclusoes>

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">


XSD
<xs:element name="exclusoes" type="exclusoes"/>

35
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:complexType name="exclusoes">
<xs:sequence>
<xs:element name="entidade" type="entidade" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="datahora" type="xs:dateTime"/>
<xs:attribute name="idagente" type="xs:int" use="required"/>
<xs:attribute name="lis" type="xs:string" use="required"/>
<xs:attribute name="operador" type="xs:string" use="required"/>
<xs:attribute name="senha" type="xs:string" use="required"/>
</xs:complexType>

<xs:complexType name="entidade">
<xs:sequence>
<xs:element name="solicitacao" type="solicitacao" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="codigo" type="xs:string" use="required"/>
</xs:complexType>

<xs:complexType name="solicitacao">
<xs:sequence>
<xs:element name="exame" type="exame" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="idAlvaro" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="exame">
<xs:sequence/>
<xs:attribute name="codigoExame" type="xs:string" use="required"/>
</xs:complexType>
</xs:schema>

ELEMENTOS XML(BODY)
EXCLUSOES

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

DATAHORA DATETIME Data e hora da solicitação NÃO yyyy-MM-ddTHH:mm:ss.SSSZ

IDAGENTE INTEGER Identificador do agente SIM 10

LIS STRING LIS​ (Laboratory Integration System) SIM 250

36
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

OPERADOR STRING Nome do operador SIM 20

SENHA STRING Senha do agente SIM 20

ENTIDADE

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

CODIGO STRING Identificador da entidade SIM 11

SOLICITACAO

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

Identificador da solicitação no sistema


IDALVARO INTEGER SIM 11
Álvaro

EXAME

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

CODIGOEXAME STRING identificador do exame SIM 10

RESPOSTA
CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<exclusoes idagente="123456" lis="SISTEMAXYZ" operador="FULANO" senha="ABCDEF">
<entidade codigo="1234">
<solicitacao idAlvaro="11111111">
EXEMPLO
<exame codigoExame="TSH" excluido="true" informacao="Excluído com sucesso"/>
</solicitacao>
</entidade>
</exclusoes>

<?xml version="1.0" standalone="yes"?>


<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="exclusoes" type="exclusoesRetornoDTO"/>


XSD
<xs:complexType name="exclusoesRetornoDTO">
<xs:sequence>
<xs:element name="entidade" type="entidadeExclusaoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>

37
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:attribute name="datahora" type="xs:dateTime"/>


<xs:attribute name="idagente" type="xs:int" use="required"/>
<xs:attribute name="lis" type="xs:string"/>
<xs:attribute name="operador" type="xs:string"/>
<xs:attribute name="senha" type="xs:string"/>
</xs:complexType>

<xs:complexType name="entidadeExclusaoRetornoDTO">
<xs:sequence>
<xs:element name="solicitacao" type="solicitacaoExclusaoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="codigo" type="xs:string"/>
</xs:complexType>

<xs:complexType name="solicitacaoExclusaoRetornoDTO">
<xs:sequence>
<xs:element name="exame" type="exameExclusaoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="idAlvaro" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="exameExclusaoRetornoDTO">
<xs:sequence/>
<xs:attribute name="codigoExame" type="xs:string"/>
<xs:attribute name="excluido" type="xs:boolean" use="required"/>
<xs:attribute name="informacao" type="xs:string"/>
</xs:complexType>
</xs:schema>

CÓDIGOS RESPOSTA
CÓDIGO DESCRIÇÃO

200 Sucesso

500 Falha interna, acionar suporte DASA

38
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ELEMENTOS XML
EXCLUSOES

ATRIBUTO TIPO DESCRIÇÃO

IDAGENTE INTEGER Identificador do agente

LIS STRING LIS​ (Laboratory Integration System)

OPERADOR STRING Nome do operador

SENHA STRING Senha do agente

ENTIDADE

ATRIBUTO TIPO DESCRIÇÃO

CODIGO INTEGER Identificador da entidade

SOLICITACAO

ATRIBUTO TIPO DESCRIÇÃO

IDALVARO STRING Identificador da solicitação no sistema Álvaro

EXAME

ATRIBUTO TIPO DESCRIÇÃO

EXAME STRING Código do exame

EXCLUIDO BOOLEAN Informa se o exame foi excluído

INFORMACAO STRING Informações referentes ao exame

Listar resultados

REQUISIÇÃO
MÉTODO HTTP PUT

ENDPOINT /v2/resultados

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados
39
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

PARÂMETROS

ANEXOFORMATO

DESCRIÇÃO Parâmetro para informar que deverá ser retornada imagem do exame(VIT25 e ELETROFORESE) gerada
no laudo no elemento anexo dentro do elemento exame

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados?anexoFormato=S


VG

VALORES SVG - Retorna a imagem no formato SVG


SUPORTADOS PNG - Retorna o anexo no formato Base64

RESPONSAVELTECNICOASSINATURA

DESCRIÇÃO Parâmetro para informar que deverão ser retornadas imagens das assinaturas dos técnicos
responsáveis do exame dentro do elemento responsavelTecnicoAssinatura dentro do elemento
cadastro

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados?responsavelTecni


coAssinatura=true

VALORES true - Retorna a imagem da assinatura em Base64


SUPORTADOS false - Não retorna a imagem da assinatura

BODY

CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<resultados idagente="123456" lis="SISTEMAXYZ" operador="FULANO" senha="ABCDEF" padrao="">
<entidade codigo="1234">
BUSCAR TODOS
<solicitacao idAlvaro="11111111">
OS EXAMES DA
​<exame codigo=""/>
SOLICITAÇÃO
</solicitacao>
</entidade>
</resultados>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<resultados idagente="123456" lis="SISTEMAXYZ" operador="FULANO" senha="ABCDEF" padrao="">
BUSCAR <entidade codigo="1234">
EXAME <solicitacao idAlvaro="11111111">
ESPECÍFICO NA ​<exame codigo="TSH"/>
SOLICITAÇÃO </solicitacao>
</entidade>
</resultados>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


XSD
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
40
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xs:element name="resultados" type="resultados"/>

<xs:complexType name="resultados">
<xs:sequence>
<xs:element name="entidade" type="entidade" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="idagente" type="xs:int" use="required"/>
<xs:attribute name="lis" type="xs:string" use="required"/>
<xs:attribute name="operador" type="xs:string"/>
<xs:attribute name="senha" type="xs:string" use="required"/>
<xs:attribute name="padrao" type="xs:string"/>
</xs:complexType>

<xs:complexType name="entidade">
<xs:sequence>
<xs:element name="solicitacao" type="solicitacao" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="codigo" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="solicitacao">
<xs:sequence>
<xs:element name="exame" type="exame" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="idAlvaro" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="exame">
<xs:attribute name="codigo" type="xs:string" use="required"/>
</xs:complexType>

</xs:schema>

ELEMENTOS XML(BODY)
RESULTADOS

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

IDAGENTE INTEGER Identificador do agente SIM 10

LIS STRING LIS​ (Laboratory Integration System) SIM 250

OPERADOR STRING Nome do operador NÃO 20

41
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

SENHA STRING Senha do agente SIM 20

PADRAO STRING NÃO 20

ENTIDADE

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

CODIGO STRING Identificador da entidade SIM 11

SOLICITACAO

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

Identificador da solicitação no sistema


IDALVARO INTEGER SIM 11
Álvaro

EXAME

ATRIBUTO TIPO DESCRIÇÃO OBRIGATÓRIO FORMATO/TAMANHO

CODIGO STRING identificador do exame SIM 10

RESPOSTA
CONTENT TYPE XML

<?xml version="1.0" encoding="UTF-8"?>


<resultados datahora="2018-05-22 18:08:19" origem="aol" versao="20101018">
<cadastros>
<pacientes>
<paciente codigo="123456" codigo_lis="" datanasc="22/02/1900" nome="Paciente Teste"
sexo="F"/>
</pacientes>
<responsaveisTecnicosAssinatura>
<responsavelTecnicoAssinatura codigo="CRF-SP: 11111">
EXEMPLO <![CDATA[IMAGEM DA ASSINATURA EM BASE64]]>
</responsavelTecnicoAssinatura>
</responsaveisTecnicosAssinatura>
<materiais>
<material codigo="123" descricao="Soro Vit. D"/>
</materiais>
<exame codigo="VIT25" descricao="VITAMINA D - 25 HIDROXI" dataalteracao="11/12/2016
09:35:49">
<linhasresultado>
<linha codigo="4101" descricao="VITAMINA D - 25 HIDROXI" unidade="ng/mL"/>

42
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

</linhasresultado>
<valorreferencia>
<![CDATA[Deficiência: até 20 ng/mL
Insuficiência: de 21 a 29 ng/mL
Suficiência: de 30 a 100 ng/mL
NOTA: Valores de 25 hidroxi-vitamina D de 30 a
100 ng/mL são considerados suficientes por terem
apresentado melhor correlação com a absorção de
cálcio, densidade mineral óssea e níveis de PTH.
Valores inferiores a 30 ng/mL podem ser indica-
tivos de insuficiência ou deficiência, devendo ser
correlacionados com a clínica e com os demais
exames laboratoriais de avaliação do metabolismo
do cálcio.
Fonte: Holick MF et al. Clinical Practice Guideli-
ne: Evaluation, treatment and prevention of vita-
min D deficiency:an endocrine Society Clinical
Practice Guideline. JCEM 2011,96(7):1911-1930).]]>
</valorreferencia>
</exame>
</cadastros>
<solicitacao codigo="137908283" codigo_aol="" codigo_lis="" paciente="133799134">
<amostras>
<amostra codigo="3" descricao="basal" identificacao="" material="4941"/>
</amostras>
<exame codigo="VIT25" observacao="" metodo="Imunoensaio Quimioluminescente de
Micropartículas - CMIA" normal="S" dataresultado="22/05/2018 15:08:20"
responsaveltecnico="Luciano Gustavo S. de Carvalho" responsaveltecnicodocumento="CRF-SP:
11111">
<resultado amostra="3" linharesultado="4101" id_lis="" resultado=" 44,7"/>
<anexos>
<anexo codigo="1" tipo="IMAGEM" formato="PNG">
<![CDATA[IMAGEM DO GRÁFICO EM BASE64]]>
</anexo>
</anexos>
</exame>
</solicitacao>
</resultados>

<?xml version="1.0" encoding="UTF-8"?>


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:complexType name="responsavelTecnicoAssinaturaResultadoRetornoDTO">
XSD <xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="codigo" type="xsd:string"/>
</xsd:extension>

43
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

</xsd:simpleContent>
</xsd:complexType>
<xsd:complexType name="cadastrosResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="pacientes" type="pacientesResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="responsaveisTecnicosAssinatura"
type="responsaveisTecnicosAssinaturaResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="materiais" type="materiaisResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="exame" type="dadosExameResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="anexoResultadoRetornoDTO">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="codigo" type="xsd:int"/>
<xsd:attribute name="tipo" type="anexoTipo"/>
<xsd:attribute name="formato" type="anexoFormato"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
<xsd:complexType name="linhaResultadoResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="linha" type="linhaCriticaResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="exameResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="resultado" type="resultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="curvas" type="curvasRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="antibiograma" type="antibiogramaRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="camposcomplementares"
type="camposComplementaresResultadoRetornoDTO" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="anexos" type="anexosResultadoRetornoDTO" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="codigo" type="xsd:string"/>
<xsd:attribute name="observacao" type="xsd:string"/>
<xsd:attribute name="metodo" type="xsd:string"/>
<xsd:attribute name="normal" type="xsd:string"/>

44
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xsd:attribute name="dataresultado" type="xsd:string"/>


<xsd:attribute name="responsaveltecnico" type="xsd:string"/>
<xsd:attribute name="responsaveltecnicodocumento" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="campoComplementarExameRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="codigo" type="xsd:int" use="required"/>
<xsd:attribute name="label" type="xsd:string"/>
<xsd:attribute name="listaLaudo" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="anexosResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="anexo" type="anexoResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="antibiogramaRetornoDTO">
<xsd:sequence>
<xsd:element name="resultado" type="antibiogramaResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id_lis" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="antibiogramaResultadoRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="antibiotico" type="xsd:string"/>
<xsd:attribute name="halo" type="xsd:string"/>
<xsd:attribute name="mic" type="xsd:string"/>
<xsd:attribute name="resistencia" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="amostraResultadoRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="codigo" type="xsd:string"/>
<xsd:attribute name="descricao" type="xsd:string"/>
<xsd:attribute name="identificacao" type="xsd:string"/>
<xsd:attribute name="material" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="camposComplementaresResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="camposcomplementares"
type="campoComplementarResultadoRetornoDTO" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="solicitacaoResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="amostras" type="amostrasResultadoRetornoDTO" minOccurs="0"

45
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

maxOccurs="unbounded"/>
<xsd:element name="exame" type="exameResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="codigo" type="xsd:string"/>
<xsd:attribute name="codigo_aol" type="xsd:string"/>
<xsd:attribute name="codigo_lis" type="xsd:string"/>
<xsd:attribute name="paciente" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="curvasRetornoDTO">
<xsd:sequence>
<xsd:element name="curva" type="curvaResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="materiaisResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="material" type="materialResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="resultadosRetornoDTO">
<xsd:sequence>
<xsd:element name="cadastros" type="cadastrosResultadoRetornoDTO" minOccurs="0"/>
<xsd:element name="solicitacao" type="solicitacaoResultadoRetornoDTO" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="datahora" type="xsd:string"/>
<xsd:attribute name="origem" type="xsd:string"/>
<xsd:attribute name="versao" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="resultadoRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="amostra" type="xsd:string"/>
<xsd:attribute name="linharesultado" type="xsd:string"/>
<xsd:attribute name="id_lis" type="xsd:string"/>
<xsd:attribute name="resultado" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="campoComplementarResultadoRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="codigo" type="xsd:int" use="required"/>
<xsd:attribute name="resultado" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="curvaResultadoRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="id" type="xsd:string"/>
<xsd:attribute name="pontos" type="xsd:string"/>

46
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

</xsd:complexType>
<xsd:complexType name="dadosExameResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="linhasresultado" type="linhaResultadoResultadoRetornoDTO"
minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="camposcomplementares"
type="camposComplementaresExameRetornoDTO" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="valorreferencia" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="codigo" type="xsd:string"/>
<xsd:attribute name="descricao" type="xsd:string"/>
<xsd:attribute name="dataalteracao" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="camposComplementaresExameRetornoDTO">
<xsd:sequence>
<xsd:element name="camposcomplementares" type="campoComplementarExameRetornoDTO"
minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="amostrasResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="amostra" type="amostraResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="pacienteResultadoRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="codigo" type="xsd:string"/>
<xsd:attribute name="codigo_aol" type="xsd:string"/>
<xsd:attribute name="codigo_lis" type="xsd:string"/>
<xsd:attribute name="datanasc" type="xsd:string"/>
<xsd:attribute name="nome" type="xsd:string"/>
<xsd:attribute name="sexo" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="linhaCriticaResultadoRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="codigo" type="xsd:int" use="required"/>
<xsd:attribute name="descricao" type="xsd:string"/>
<xsd:attribute name="unidade" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="pacientesResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="paciente" type="pacienteResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>

47
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xsd:complexType name="materialResultadoRetornoDTO">
<xsd:sequence/>
<xsd:attribute name="codigo" type="xsd:int" use="required"/>
<xsd:attribute name="descricao" type="xsd:string"/>
</xsd:complexType>
<xsd:complexType name="responsaveisTecnicosAssinaturaResultadoRetornoDTO">
<xsd:sequence>
<xsd:element name="responsavelTecnicoAssinatura"
type="responsavelTecnicoAssinaturaResultadoRetornoDTO" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="resultados" type="resultadosRetornoDTO"/>
<xsd:element name="responsavelTecnicoAssinaturaResultadoRetornoDTO"
type="responsavelTecnicoAssinaturaResultadoRetornoDTO"/>
<xsd:element name="cadastrosResultadoRetornoDTO" type="cadastrosResultadoRetornoDTO"/>
<xsd:element name="anexoResultadoRetornoDTO" type="anexoResultadoRetornoDTO"/>
<xsd:element name="linhaResultadoResultadoRetornoDTO"
type="linhaResultadoResultadoRetornoDTO"/>
<xsd:element name="exameResultadoRetornoDTO" type="exameResultadoRetornoDTO"/>
<xsd:element name="campoComplementarExameRetornoDTO"
type="campoComplementarExameRetornoDTO"/>
<xsd:element name="anexosResultadoRetornoDTO" type="anexosResultadoRetornoDTO"/>
<xsd:element name="antibiogramaRetornoDTO" type="antibiogramaRetornoDTO"/>
<xsd:element name="antibiogramaResultadoRetornoDTO"
type="antibiogramaResultadoRetornoDTO"/>
<xsd:element name="amostraResultadoRetornoDTO" type="amostraResultadoRetornoDTO"/>
<xsd:element name="camposComplementaresResultadoRetornoDTO"
type="camposComplementaresResultadoRetornoDTO"/>
<xsd:element name="solicitacaoResultadoRetornoDTO" type="solicitacaoResultadoRetornoDTO"/>
<xsd:element name="curvasRetornoDTO" type="curvasRetornoDTO"/>
<xsd:element name="materiaisResultadoRetornoDTO" type="materiaisResultadoRetornoDTO"/>
<xsd:element name="resultadoRetornoDTO" type="resultadoRetornoDTO"/>
<xsd:element name="campoComplementarResultadoRetornoDTO"
type="campoComplementarResultadoRetornoDTO"/>
<xsd:element name="curvaResultadoRetornoDTO" type="curvaResultadoRetornoDTO"/>
<xsd:element name="dadosExameResultadoRetornoDTO"
type="dadosExameResultadoRetornoDTO"/>
<xsd:element name="camposComplementaresExameRetornoDTO"
type="camposComplementaresExameRetornoDTO"/>
<xsd:element name="amostrasResultadoRetornoDTO" type="amostrasResultadoRetornoDTO"/>
<xsd:element name="pacienteResultadoRetornoDTO" type="pacienteResultadoRetornoDTO"/>
<xsd:element name="linhaCriticaResultadoRetornoDTO"
type="linhaCriticaResultadoRetornoDTO"/>
<xsd:element name="pacientesResultadoRetornoDTO" type="pacientesResultadoRetornoDTO"/>
<xsd:element name="materialResultadoRetornoDTO" type="materialResultadoRetornoDTO"/>

48
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<xsd:element name="responsaveisTecnicosAssinaturaResultadoRetornoDTO"
type="responsaveisTecnicosAssinaturaResultadoRetornoDTO"/>
<xsd:simpleType name="anexoTipo">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="GRAFICO"/>
<xsd:enumeration value="IMAGEM"/>
<xsd:enumeration value="HTML"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="anexoFormato">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="SVG"/>
<xsd:enumeration value="PNG"/>
<xsd:enumeration value="HTML"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>

CÓDIGOS RESPOSTA
CÓDIGO DESCRIÇÃO

200 Sucesso

500 Falha interna, acionar suporte DASA

ELEMENTOS XML
RESULTADOS

ATRIBUTO TIPO DESCRIÇÃO

DATAHORA DATETIME Data e hora da busca

ORIGEM STRING Origem dos resultados

VERSAO STRING Versão do sistema origem

CADASTROS

PACIENTES

PACIENTE

49
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador do paciente

CODIGO_LIS STRING Identificador do paciente no sistema LIS

DATANASC STRING Data de nascimento do paciente

NOME STRING Nome do paciente

SEXO STRING Sexo do paciente

RESPONSAVEISTECNICOSASSINATURA

RESPONSAVELTECNICOASSINATURA

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING CRM do responsável técnico

CDATA BASE64 Imagem da assinatura do responsável técnico

MATERIAIS

MATERIAL

ATRIBUTO TIPO DESCRIÇÃO

CODIGO INTEGER Identificador do material

DESCRICAO STRING Informações referentes ao material

EXAME

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador DEPARA do exame

DESCRICAO STRING Informações referentes ao exame

DATAALTERACAO STRING Data da última alteração

LINHARESULTADO

LINHA

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador do exame

50
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

DESCRICAO STRING Informações referentes ao exame

UNIDADE STRING Unidade de medida

CAMPOSCOMPLEMENTARES

ATRIBUTO TIPO DESCRIÇÃO

CODIGO INTEGER Identificador da informação complementar

LABEL STRING Label da informação complementar

LISTALAUDO STRING Laudos da informação complementar

SOLICITACAO

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador da solicitação

CODIGO_LIS STRING Identificador do paciente no LIS

PACIENTE STRING Identificador do paciente

AMOSTRAS

AMOSTRA

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador da amostra

DESCRICAO STRING Informações referentes a amostra

IDENTIFICACAO STRING Identificação da amostra

MATERIAL STRING Identificador do material

EXAME

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador DEPARA do exame

OBSERVACAO STRING Observações pertinentes ao exame

METODO STRING Método de execução do exame

NORMAL STRING Informação se o procedimento é normal

51
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

DATARESULTADO STRING Data do resultado do exame

RESPONSAVELTECNICO STRING Nome do responsável técnico


RESPONSAVELTECNICODOCUMENTO
STRING CRM do responsável técnico

RESULTADO

ATRIBUTO TIPO DESCRIÇÃO

AMOSTRA STRING Sequencial da amostra

LINHARESULTADO STRING Referência do identificador do exame

ID_LIS STRING Identificador do resultado no sistema LIS (Laboratory Integration System)

RESULTADO STRING Valor do resultado

ANEXOS

ANEXO

ATRIBUTO TIPO DESCRIÇÃO

CODIGO INTEGER Sequencial da amostra

TIPO ENUM Tipo do anexo(GRÁFICO, IMAGEM, HTML)

FORMATO ENUM Formato do anexo (SVG, PNG, HTML)

Listar resultados PDF


Realiza a busca dos resultados através do identificador da ordem de serviço e entidade informados e devolve em PDF.

REQUISIÇÃO
MÉTODO HTTP GET

ENDPOINT /v2/resultados/pdf

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/pdf

HEADER

AUTHORIZATION

DESCRIÇÃO Parâmetro obrigatório com as informações de ​usuário (idagente)​ e ​senha​ para validação de acesso

52
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ao recurso solicitado.

TIPO Basic Auth

PARÂMETROS

IDORDEMSERVICO

DESCRIÇÃO Parâmetro ​obrigatório​ para informar identificador da ordem de serviço a ser localizada

TIPO String

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/pdf?idOrdemServ


ico=12345678&idEntidade=12345

IDENTIDADE

DESCRIÇÃO Parâmetro ​obrigatório​ para informar identificador da entidade que cadastrou a ordem de serviço

TIPO String

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/pdf?idOrdemServ


ico=12345678&idEntidade=12345

EXAMES

DESCRIÇÃO Parâmetro ​não obrigatório​ para informar exames que retornarão no laudo PDF. Para buscar mais de
um exame, utilizar o caractere vírgula ​(“,”)​ como separador. Exemplo: T3,T4L,CARIB

TIPO String

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/pdf?idOrdemServ


ico=12345678&idEntidade=12345&exames=T3,T4L

LOGO

DESCRIÇÃO Parâmetro​ não obrigatório​ para informar se o logo deverá ser retornado no laudo. Valor default ​true

TIPO Boolean

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/pdf?idOrdemServ


ico=12345678&idEntidade=12345&logo=false

VALORES true - (default) Retorna imagem do logo no laudo pdf


SUPORTADOS false - Não retorna imagem do logo no laudo pdf

ASSINATURA

DESCRIÇÃO Parâmetro​ não obrigatório​ para informar se assinatura do responsável técnico deverá ser retornada
no laudo. Valor default ​true

53
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

TIPO Boolean

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/pdf?idOrdemServ


ico=12345678&idEntidade=12345&assinatura=false

VALORES true - (default) Retorna imagem da assinatura no laudo pdf


SUPORTADOS false - Não retorna imagem da assinatura no laudo pdf

RESPOSTA

Será gerado um arquivo em PDF

CÓDIGOS RESPOSTA
CÓDIGO DESCRIÇÃO

200 Sucesso

204 Ordem de serviço não localizada ou não pertence a entidade

401 Agente e/ou senha incorretos

403 Agente ou entidade não autorizados

500 Falha interna, acionar suporte DASA

Listar resultados lote


Realiza busca dos resultados por entidade e período. O serviço retornará no máximo 1000 resultados por requisição.

REQUISIÇÃO
MÉTODO HTTP GET

ENDPOINT /v2/resultados/lote/idEntidade/dataInicial/dataFinal

URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/lote/​idEntida
de/dataInicial/dataFinal

HEADER

AUTHORIZATION

54
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

DESCRIÇÃO Parâmetro obrigatório com as informações de ​usuário (idagente)​ e ​senha​ para validação de acesso
ao recurso solicitado.

TIPO Basic Auth

PARÂMETROS URL

ID ENTIDADE

DESCRIÇÃO Parâmetro passado via URL para informar identificador da entidade que deseja solicitar os resultados

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/lote/​164​/201809


01000000/20180901235959

DATA INICIAL

DESCRIÇÃO Parâmetro passado via URL para informar a data inicial na busca dos resultados

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/lote/164/​201809


01000000​/20180901235959

DATA FINAL

DESCRIÇÃO Parâmetro passado via URL para informar a data final na busca dos resultados

EXEMPLO URL http://ap-aolws-dev.azurewebsites.net/webserviceaol/rest/homologacao/v2/resultados/lote/164/201809


01000000/​20180901235959

RESPOSTA
CONTENT TYPE XML

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>


<resultados versao="20101018" origem="aol" datahora="2018-09-24 15:43:31">
<cadastros>
<pacientes>
<paciente codigo="163736929" codigo_lis="2" codigo_aol="163736929"
datanasc="28/01/1990" nome="PACIENTE TESTE SHIFT" sexo="M"/>
</pacientes>
EXEMPLO <materiais>
<material codigo="5214" descricao="soro congelado manual"/>
</materiais>
<exame codigo="ASPER" descricao="ASPERGILLUS - Anticorpos" dataalteracao="17/07/2017
11:15:00">
<linhasresultado>
<linha codigo="101" descricao="ASPERGILLUS NIGER" unidade=""/>
<linha codigo="102" descricao="ASPERGILLUS FUMIGATUS" unidade=""/>

55
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

<linha codigo="103" descricao="ASPERGILLUS FLAVUS" unidade=""/>


<linha codigo="10172" descricao="Aspergillus sp." unidade=""/>
</linhasresultado>
<valorreferencia>
<![CDATA[Negativo: Inferior a 5 UA/mL
Indeterminado: 5 a 10 UA/mL
Positivo: Igual ou superior a 10 UA/mL
]]>
</valorreferencia>
</exame>
</cadastros>
<solicitacao codigo="176181794" codigo_aol="176181794" codigo_lis="005-64723-141"
paciente="163736929">
<amostras>
<amostra codigo="0" identificacao="180000209000" descricao="basal" material="5214"/>
</amostras>
<exame codigo="ASPER" dataresultado="22/03/2018 20:21:42" metodo="Enzimaimunoensaio"
observacao="" normal="N">
<resultado amostra="0" linharesultado="101" resultado=" 10,0" id_lis="154"/>
<resultado amostra="0" linharesultado="102" resultado=" 10,0" id_lis="154"/>
<resultado amostra="0" linharesultado="103" resultado=" 10,0" id_lis="154"/>
<resultado amostra="0" linharesultado="10172" resultado=" 10,0" id_lis="154"/>
</exame>
</solicitacao>
</resultados>

ELEMENTOS JSON
RESULTADOS

ATRIBUTO TIPO DESCRIÇÃO

DATAHORA DATETIME Data e hora da busca

ORIGEM STRING Origem dos resultados

VERSAO STRING Versão do sistema origem

CADASTROS

PACIENTES

PACIENTE

ATRIBUTO TIPO DESCRIÇÃO

56
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

CODIGO STRING Identificador do paciente

CODIGO_LIS STRING Identificador do paciente no sistema LIS

DATANASC STRING Data de nascimento do paciente

NOME STRING Nome do paciente

SEXO STRING Sexo do paciente

MATERIAIS

MATERIAL

ATRIBUTO TIPO DESCRIÇÃO

CODIGO INTEGER Identificador do material

DESCRICAO STRING Informações referentes ao material

EXAME

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador DEPARA do exame

DESCRICAO STRING Informações referentes ao exame

DATAALTERACAO STRING Data da última alteração

LINHARESULTADO

LINHA

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador do exame

DESCRICAO STRING Informações referentes ao exame

UNIDADE STRING Unidade de medida

VALORREFERENCIA

TIPO DESCRIÇÃO

CDATA Valores de referência do exame

SOLICITACAO

57
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador da solicitação

CODIGO_LIS STRING Identificador do paciente no LIS

PACIENTE STRING Identificador do paciente

AMOSTRAS

AMOSTRA

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador da amostra

DESCRICAO STRING Informações referentes a amostra

IDENTIFICACAO STRING Identificação da amostra

MATERIAL STRING Identificador do material

EXAME

ATRIBUTO TIPO DESCRIÇÃO

CODIGO STRING Identificador DEPARA do exame

OBSERVACAO STRING Observações pertinentes ao exame

METODO STRING Método de execução do exame

NORMAL STRING Informação se é um procedimento é normal

DATARESULTADO STRING Data do resultado do exame

RESULTADO

ATRIBUTO TIPO DESCRIÇÃO

AMOSTRA STRING Sequencial da amostra

LINHARESULTADO STRING Referência do identificador da crítica

ID_LIS STRING Identificador do resultado no sistema LIS (Laboratory Integration System)

RESULTADO STRING Valor do resultado

58
Manual Técnico ​WebService AOL
Versão do Documento: 2.0
Data de Liberação ​04/09/2018

CÓDIGOS RESPOSTA
CÓDIGO DESCRIÇÃO

200 Sucesso

204 Sucesso, não há resultados a serem retornados

401 Agente e/ou senha incorretos

403 Agente ou entidade não autorizados

500 Falha interna, acionar suporte DASA

59