DOCUMENTAÇÃO TÉCNICA

INTEGRAÇÃO
MÓDULO DE REGULAÇÃO AMBULATORIAL
 Integração Módulo de Regulação Página
Ambulatorial 2
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Sumário
Revisões ............................................................................................................................................................................ 3
Arquitetura Técnica da integração.................................................................................................................................... 4
Tipos de Integrações ......................................................................................................................................................... 5
Integração via FTP ............................................................................................................................................................. 6
Layout dos campos para cada tipo de integração ............................................................................................................ 6
Integração via Post XML .................................................................................................................................................. 26
Schema dos XML ............................................................................................................................................................. 27
Integração Web Service – Recepção ............................................................................................................................... 33
Exemplo de um código em PHP ...................................................................................................................................... 36
Exemplo conteúdo de um arquivo CSV........................................................................................................................... 39
Tabelas auxiliares ............................................................................................................................................................ 49
 Integração Módulo de Regulação Página
Ambulatorial 3
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Revisões
Data Revisão Descrição

04/04/2019 4.0 Inclusão dos campos CD_RACA e COD_ETNIA nos agendamentos consulta e
exame. Inclusão do campo número prontuário no WebService de recepção. Revisão
nos tamanhos dos campos. Campo tipo no agendamento exame não utilizado.
Campo falta médica na integração de horários de consulta e exame e no parâmetro
de entrada de recepção não utilizado.
26/08/2020 4.1 Inclusão de recepção por teleconsulta. Onde será possível enviar presente por
(Presencial ou Teleconsulta). Atualmente as unidades encaminham a coluna status
com o valor “P”, agora além do “P(presencial)”, poderá ser enviado “T(teleconsulta)”.
17/09/2020 4.2 Alteração da sigla DF para sigla DG. Referente ao envio dos DADOS GERAIS(DG)
dos PROTOCOLOS DAS AGENDAS
 Integração Módulo de Regulação Página
Ambulatorial 4
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Arquitetura Técnica da integração

 Integração Módulo de Regulação Página
Ambulatorial 5
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Tipos de Integrações
O sistema CROSS disponibiliza os seguintes tipos de integrações com as unidades.
Sentido CROSS  Unidade
1) Operações sob demanda.
Operações de agendamento, cancelamento e transferência dos pacientes realizada no Sistema
CROSS referente a consultas e exames.

2) Configurações das agendas.

Configurações das agendas dos profissionais referente a consultas e exames no sistema CROSS.

3) Horários das agendas.

Horários das agendas dos profissionais referentes a consultas e exames no sistema CROSS a
partir da data de envio.

Sentido Unidade  CROSS

1) Recepção
Recepções dos exames e consultas das Unidades.

Segue abaixo os protocolos permitidos para cada tipo de integração.

Operações Configurações Horário das Recepção
sob demanda das agendas agendas
FTP Sim Sim Sim Não
XML Sim Não Não Não
WebService SOAP Não Não Não Sim
 Integração Módulo de Regulação Página
Ambulatorial 6
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Integração via FTP

Conforme figura abaixo, a integração via FTP é no sentido CROSS  Unidade. Para tanto a Unidade
deverá fornecer o endereço do Servidor FTP com os devidos acessos (usuário e senha).

Obs. A unidade especificará o horário de envio dos arquivos.

Layout dos campos para cada tipo de integração

1) Sob Demanda

Consulta

Nomenclatura do arquivo: UEC_YYYYMMDD.csv

YYYY = Ano, MM = Mês, DD = Dia
 Integração Módulo de Regulação Página
Ambulatorial 7
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

a. Agendamento

C
A
DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
COD_UNIDADE_EXECUTANTE S INT 11 Código Cross
da Unidade
Executante
ID_AGE_CONSULTA_HOR S INT 11 Código do
agendamento
/ horário
ID_AGE_CONSULTA S INT 11 Código da
Agenda
AGE_CONSULTA_NOME S CHAR 60 Nome da
Agenda
ID_ESPECIALIDADE S INT 11 Código da
Especialidade
NOME_ESPECIALIDADE S CHAR 50 Nome da
Especialidade
COD_DIA S INT 1 0,1,2,3, Código do dia
4,5,6 da semana,
onde 0 é
Domingo e 6 é
Sábado
DATA_AGENDA S DATE AAAA- Dia da
MM-DD consulta
HOR_INI S TIME HH:MM:S Hora de início
S da consulta
HOR_FIM S TIME HH:MM:S Hora final da
S consulta
TIPO S CHAR 1 P/R Tipo do
agendamento
(P - 1a
consulta / R -
Retorno)
ID_MOTIVO S INT 3 Vide Motivo do
seção agendamento
tabelas (Normal /
auxiliare Extra).
s
PF:
ID_PROFISSIONAL S INT 11 Código Cross
do
Profissional.
DOC_PROFISSIONAL S CHAR 45 Número do
registro do
profissional
em seu
conselho
regional
 Integração Módulo de Regulação Página
Ambulatorial 8
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

ORIGEM S CHAR 45 Sigla do

Conselho
regional do
profissional
NOME_PROFISSIONAL S CHAR 60 Nome do
Profissional
PR:
ID_PROTOCOLO N INT 11 Código Cross
do protocolo
escolhido
SUBCATEG N CHAR 4 X999 Código CID 10
do protocolo
escolhido
NOME_PROTOCOLO N CHAR 100 Nome do
Protocolo
escolhido
DS:
COD_UNIDADE_SOLICITANTE S INT 11 Código Cross
da unidade
que agendou
NOME_UNIDADE_SOLICITANTE S CHAR 100 Nome da
unidade que
agendou
CNES_UNIDADE_SOLICITANTE N CHAR 7 CNES da
unidade que
agendou
NOME_USUARIO_SOLICITANTE S CHAR 100 Nome do
usuário que
agendou
DT_ULTIMA_ATUALIZ S DATE AAAA- Data e hora
MM-DD do
HH:MM:S agendamento
S
PC:
COD_PACIENTE S INT 11 Código Cross
do Paciente
NOME_PACIENTE S CHAR 60 Nome do
paciente
agendado
SEXO S CHAR 1 M/F/I Sexo. M
(masculino), F
(feminino), I
(indeterminad
o)
DT_NASCIMENTO S DATE AAAA- Data de
MM-DD nascimento.
(0001-01-01 =
data não
informada)
RG N CHAR 20 RG do
Paciente
CPF N CHAR 25 CPF do
 Integração Módulo de Regulação Página
Ambulatorial 9
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Paciente
NOME_MAE S CHAR 60 Nome da mãe
do paciente
NOME_PAI N CHAR 60 Nome do pai
do paciente
ENDERECO N CHAR 60 Endereço do
paciente sem
número
ENDERECO_NUMERO N CHAR 5 Número do
endereço do
paciente
BAIRRO N CHAR 60 Bairro do
paciente
MUNICIPIO S CHAR 60 Município do
Paciente
UF S CHAR 2 Estado do
Paciente
CEP N CHAR 9 CEP do
Paciente
TEL_RES_DDD (*) N CHAR 2 DDD do
Telefone
residencial
TEL_RES (*) N CHAR 10 Número do
telefone
residencial
TEL_CELULAR_DDD (*) N CHAR 2 DDD do
celular
TEL_ CELULAR (*) N CHAR 10 Número do
celular
TEL_COM_DDD (*) N CHAR 2 DDD do
telefone
comercial
TEL_ COM (*) N CHAR 9 Número do
telefone
comercial
TEL_COM_RAMAL N CHAR 5 Ramal do
telefone
comercial
EMAIL N CHAR 80 e-mail do
paciente
CONTATO_NOME N CHAR 60 Nome do
contato do
telefone para
recados
CONTATO_TEL_DDD N CHAR 2 DDD do
telefone do
contado
CONTATO_TEL N CHAR 10 Número do
telefone do
contato
NUM_CNS S INT 16 Cartão
Nacional de
 Integração Módulo de Regulação Página
Ambulatorial 10
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Saúde
NUM_PRONTUARIO N INT 11 Prontuários do
paciente na
unidade
executante
CD_RACA S INT 1 Vide Código Cross
seção da raça do
tabelas paciente.
auxiliare
s.
COD_ETNIA N INT 3 Vide Código da
seção Etnia do
tabelas paciente caso
auxiliare a raça for
s. indígena.
(*) Obrigatório pelo menos um número de telefone/celular.
b. Cancelamento

C
C
DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
COD_UNIDADE_EXECUTANTE S INT 11 Código da
Unidade
Executante
ID_AGE_CONSULTA_HOR S INT 11 Código do
agendamento
do horário
COD_PACIENTE S INT 11 Código
CROSS do
Paciente
TIPO S CHAR 1 P/R Tipo do
agendamento
(P - 1a
consulta / R -
Retorno)
ID_MOTIVO S INT 1 Vide Motivos do
seção cancelamento.
tabelas
auxiliares.
US:
COD_UNIDADE_SOLICITANTE S INT 11 Código Cross
da unidade
solicitante
NOME_UNIDADE_SOLICITANTE S CHAR 100 Nome da
unidade
solicitante
NOME_USUARIO_SOLICITANTE S CHAR 100 Nome do
usuário que
realizou o
cancelamento
 Integração Módulo de Regulação Página
Ambulatorial 11
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

DT_ULTIMA_ATUALIZ S DATE AAAA-MM- Data e hora

DD da ação
HH:MM:SS

c. Transferência

C
T
DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
COD_UNIDADE_EXECUTANTE S INT 11 Código da
Unidade
Executante
ID_AGE_CONSULTA_HOR_ORIGEM S INT 11 Código do
agendament
o / horário
de origem
ID_AGE_CONSULTA_HOR S INT 11 Código do
agendament
o / horário
de destino
ID_AGE_CONSULTA S INT 11 Código da
Agenda de
destino
ID_ESPECIALIDADE S INT 11 Código da
Especialidad
e
NOME_ESPECIALIDADE S CHA 50 Nome da
R Especialidad
e
COD_DIA S INT 11 0,1,2,3, Código do
4,5,6 dia da
semana,
onde 0 é
Domingo e 6
é Sábado
DATA_AGENDA S DAT AAAA- Data da
E MM-DD consulta
HOR_INI S TIME 1 HH:MM:S Hora de
S início da
consulta
HOR_FIM S TIME 1 HH:MM:S Hora final da
S consulta
COD_PACIENTE S INT Código
Cross do
Paciente
TIPO S CHA 1 P/R Tipo do
R agendament
o (P - 1a
consulta / R
- Retorno)
 Integração Módulo de Regulação Página
Ambulatorial 12
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

ID_MOTIVO S INT 1 Vide na Motivo da

seção transferência
tabelas .
auxiliare
s.
ID_PROTOCOLO N INT 11 Código do
protocolo
escolhido no
agendament
o
PF:
ID_PROFISSIONAL S INT 11 Código
Cross do
Profissional.
DOC_PROFISSIONAL S CHA 45 Número do
R registro do
profissional
em seu
conselho
regional
ORIGEM S CHA 45 Sigla do
R Conselho
regional do
profissional
NOME_PROFISSIONAL S CHA 60 Nome do
R Profissional
US:
COD_UNIDADE_SOLICITANTE S INT 11 Código
Cross da
unidade
solicitante
NOME_UNIDADE_SOLICITANTE S CHA 100 Nome da
R unidade
solicitante
NOME_USUARIO_SOLICITANTE S CHA 100 Nome do
R usuário que
realizou a
transferência
DT_ULTIMA_ATUALIZ S DAT AAAA- Data e hora
E MM-DD da ação.
HH:MM:S
S
 Integração Módulo de Regulação Página
Ambulatorial 13
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Exame

Nomenclatura do arquivo: UEE_YYYYMMDD.csv

YYYY = Ano, MM = Mês, DD = Dia

a. Agendamento

E
A
DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
COD_UNIDADE_EXECUTANTE S INT 11 Código da
Unidade
Executante
ID_AGE_EXAME_HOR S INT 11 Código do
agendament
o / horário
ID_AGE_EXAME S INT 11 Código da
Agenda
AGE_EXAME_NOME S CHAR 60 Nome da
Agenda
ID_ASSOCIACAO S INT 11 Código do
recurso
associado à
agenda
(sala,
equipamento
, etc.)
NOME_ASSOCIACAO S CHAR 60 Nome do
recurso
COD_DIA S INT 11 0,1,2,3,4, Código do
5,6 dia da
semana,
onde 0 é
Domingo e 6
é Sábado
DATA_AGENDA S DATE AAAA- Data do
MM-DD exame
HOR_INI S TIME HH:MM:S Hora de
S início do
exame
HOR_FIM S TIME HH:MM:S Hora final do
S exame
TIPO (**) N CHAR 1 Sem Tipo do
Informaçã agendament
o o
ID_MOTIVO S INT 1 Vide Motivo do
seção agendament
tabelas o (Normal /
auxiliares Extra).
 Integração Módulo de Regulação Página
Ambulatorial 14
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

DP:
ID_PROFISSIONAL N INT 11 Código
Cross do
Profissional
DOC_PROFISSIONAL N CHAR 45 Número do
registro do
profissional
em seu
conselho
regional
ORIGEM N CHAR 45 Sigla do
conselho
regional do
profissional
NOME_PROFISSIONAL N CHAR 60 Nome do
profissional
ID_ESPECIALIDADE N INT 11 Código da
especialidad
e.
NOME_ESPECIALIDADE N CHAR 50 Nome da
especialidad
e
DE:
ID_EXAME S INT 11 Código
Cross do
Exame.
COD_EXAME S INT 11 Código
original do
Exame
NOME_EXAME S CHAR 200 Descrição do
exame
TIPO_TABELA S CHAR 5 SUS, Tabela
CBHPM, utilizada
SES
DS:
COD_UNIDADE_SOLICITANTE S INT 11 Código
Cross da
unidade que
agendou
NOME_UNIDADE_SOLICITANTE S CHAR 100 Nome da
unidade que
agendou
CNES_UNIDADE_SOLICITANTE S CHAR 7 CNES da
unidade que
agendou
NOME_USUARIO_SOLICITANTE S CHAR 45 Nome do
usuário que
agendou
DT_ULTIMA_ATUALIZ S DATE AAAA- Data e hora
MM-DD do
HH:MM:S agendament
S o
 Integração Módulo de Regulação Página
Ambulatorial 15
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

PC:
COD_PACIENTE S INT Código
Cross do
Paciente
NOME_PACIENTE S CHAR 60 Nome do
paciente
agendado
SEXO S CHAR 1 M/F/I Sexo. M
(masculino),
F (feminino),
I
(indetermina
do)
DT_NASCIMENTO S DATE AAAA- Data de
MM-DD nascimento
do paciente
RG N CHAR 20 RG do
Paciente
CPF N CHAR 25 CPF do
Paciente
NOME_MAE S CHAR 60 Nome da
mãe do
paciente
NOME_PAI N CHAR 60 Nome do pai
do paciente
ENDERECO N CHAR 60 Endereço do
paciente
sem número
ENDERECO_NUMERO N CHAR 5 Número do
endereço do
paciente
BAIRRO N CHAR 45 Bairro do
paciente
MUNICIPIO S CHAR 45 Município do
Paciente
UF S CHAR 2 Estado do
Paciente
CEP N CHAR 9 CEP do
Paciente
TEL_RES_DDD (*) N CHAR 2 DDD do
Telefone
residencial
TEL_RES (*) N CHAR 10 Número do
telefone
residencial
TEL_CELULAR_DDD (*) N CHAR 2 DDD do
celular
TEL_ CELULAR (*) N CHAR 10 Número do
celular
TEL_COM_DDD (*) N CHAR 2 DDD do
telefone
comercial
 Integração Módulo de Regulação Página
Ambulatorial 16
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

TEL_ COM (*) N CHAR 9 Número do

telefone
comercial
TEL_COM_RAMAL N CHAR 5 Ramal do
telefone
comercial
EMAIL N CHAR 80 e-mail do
paciente
CONTATO_NOME N CHAR 60 Nome do
contato do
telefone para
recados
CONTATO_TEL_DDD N CHAR 2 DDD do
telefone do
contado
CONTATO_TEL N CHAR 10 Número do
telefone do
contato
NUM_CNS S INT 16 Cartão
Nacional de
Saúde
NUM_PRONTUARIO N INT 11 Prontuários
do paciente
na unidade
executante
CD_RACA S INT 1 vide Código
tabela Cross da
auxiliares Raça do
paciente.
COD_ETNIA N INT 3 vide Código da
tabela Etnia do
auxiliares paciente
caso a raça
for indígena.

(*) Obrigatório pelo menos um número de telefone/celular.

(**) Campo não utilizado. Retorno sempre em branco.
 Integração Módulo de Regulação Página
Ambulatorial 17
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

b. Cancelamento

E
C
DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
COD_UNIDADE_EXECUTANTE S INT 11 Código da
Unidade
Executante
ID_AGE_EXAME_HOR S INT 11 Código do
agendamento
/ horário de
destino
COD_PACIENTE S INT 11 Código Cross
do Paciente
ID_MOTIVO S INT 1 Vide Motivos do
seção cancelamento.
tabelas
auxiliares.
US:
COD_UNIDADE_SOLICITANTE S INT 11 Código Cross
da unidade
solicitante
NOME_UNIDADE_SOLICITANTE S CHAR 100 Nome da
unidade
solicitante
NOME_USUARIO_SOLICITANTE S CHAR 100 Nome do
usuário que
realizou o
cancelamento
DT_ULTIMA_ATUALIZ S DATE AAAA-MM- Data e hora
DD da ação
HH:MM:SS

c. Transferência

E
T
DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
COD_UNIDADE_EXECUTANTE S INT 11 Código da
Unidade
Executante
ID_AGE_EXAME_HOR_ORIGEM S INT 11 Código do
agendamento
/ horário de
origem
ID_AGE_EXAME_HOR S INT 11 Código do
agendamento
/ horário de
destino
ID_AGE_EXAME S INT 11 Código da
 Integração Módulo de Regulação Página
Ambulatorial 18
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Agenda de
destino
COD_DIA S INT 1 0,1,2,3,4,5,6 Código do dia
da semana,
onde 0 é
Domingo e 6
é Sábado
DATA_AGENDA S DAT AAAA- Data do
E MM-DD exame
HOR_INI S TIME HH:MM: Hora de início
SS do exame
HOR_FIM S TIME HH:MM: Hora final do
SS exame
COD_PACIENTE S INT Código Cross
do Paciente
TIPO N CHA 1 P Tipo do
R agendamento
(P - 1a
exame)
ID_MOTIVO S INT 1 0 0-
Agendamento
Normal
US:
COD_UNIDADE_SOLICITANTE S INT 11 Código Cross
da unidade
solicitante
NOME_UNIDADE_SOLICITANTE S CHA 100 Nome da
R unidade
solicitante
NOME_USUARIO_SOLICITANTE S CHA 100 Nome do
R usuário que
realizou a
operação
DT_ULTIMA_ATUALIZ S DAT AAAA- Data e hora
E MM-DD da ação
HH:MM:
SS

2) Configurações das Agendas

Consulta
Nomenclatura do Arquivo: configuracao.zip
Conteúdo do zip:

o UEC_CONF_YYYYMMDD.csv
o UEC_PROT_YYYYMMDD.csv

YYYY = Ano, MM = Mês, DD = Dia

Obs. O arquivo zip gerado possui uma senha de acesso configurado pela administração.
 Integração Módulo de Regulação Página
Ambulatorial 19
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
ID_AGE_CONSULTA S INT 11 Código da
Agenda
AGE_CONSULTA_NOME S CHAR 60 Nome da
Agenda
COD_UNIDADE_EXECUTANTE S INT 11 Código da
Unidade
Executante
IDADE_INI S INT 3 Idade mínima
do paciente.
(0 = sem
restrição)
IDADE_FIM S INT 3 Idade máxima
do paciente.
(200 = sem
restrição)
BLOQUEADO S CHAR 1 S/N Indica se a
agenda está
bloqueada ou
não.
(S=agenda
bloqueada /
N=agenda
liberada)
DATA_INI S DATE AAAA- Data de Início
MM-DD da Agenda
DATA_FIM S DATE AAAA- Data Final da
MM-DD Agenda
DF:
ID_PROFISSIONAL S INT 11 Código Cross
do
Profissional.
DOC_PROFISSIONAL S CHAR 45 Número do
registro do
profissional
em seu
conselho
regional
ORIGEM S CHAR 45 Sigla do
Conselho
regional do
profissional
NOME_PROFISSIONAL S CHAR 60 Nome do
Profissional
ID_ESPECIALIDADE S INT 11 Código da
Especialidade
NOME_ESPECIALIDADE S CHAR 50 Nome da
Especialidade
CA:
COD_DIA S INT 11 0,1,2,3, Código do dia
4,5,6 da semana (0
 Integração Módulo de Regulação Página
Ambulatorial 20
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

= Domingo / 1
= Segunda / 2
= Terça ... / 6
= Sábado)
HOR_INI S DATE_TI HH:MM Horário de
ME Início da
agenda no dia
HOR_FIM S DATE_TI HH:MM Horário de
ME término da
agenda no dia
TEMPO_REALIZACAO S INT 5 Intervalo entre
a realização
das consultas.
Duração da
consulta.
PERC_PRIMEIRA_CONSULTA S INT 3 Percentual de
primeiras
consultas para
o dia nesta
agenda
PERC_RETORNO S INT 3 Percentual de
retorno para o
dia nesta
agenda
NUM_PRIMEIRA_CONSULTA S INT 3 Número de
primeiras
consultas para
o dia, nesta
agenda
NUM_RETORNO S INT 3 Número de
retornos para
o dia, nesta
agenda

Protocolos associados nas agendas

DG:

Campo Obrigatório Tipo Tamanho Formato Valores Descrição

ID_PROTOCOLO S INT 11 Código Cross
do protocolo
SUBCATEG S CHAR 4 X999 Código CID
10 do
protocolo
ID_AGE_CONSULTA S INT 11 Código da
Agenda
 Integração Módulo de Regulação Página
Ambulatorial 21
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Exame
Nomenclatura do Arquivo: configuracao.zip
Conteúdo do zip:

o UEE_CONF_YYYYMMDD.csv
o UEE_PROT_YYYYMMDD.csv

YYYY = Ano, MM = Mês, DD = Dia

Obs. O arquivo zip gerado possui uma senha de acesso configurado pela administração

DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
ID_AGE_EXAME S INT 11 Código Cross
da Agenda
AGE_EXAME_NOME S CHAR 60 Nome da
Agenda
COD_UNIDADE_EXECUTANTE S INT 11 Código da
Unidade
Executante
IDADE_INI S INT 3 Idade mínima
do paciente.
(0 = sem
restrição)
IDADE_FIM S INT 3 Idade máxima
do paciente.
(200 = sem
restrição)
BLOQUEADO S CHAR 1 S/N Indica se a
agenda está
bloqueada ou
não.
(S=agenda
bloqueada /
N=agenda
liberada)
DATA_INI S DATE AAAA- Data de Início
MM-DD da Agenda
DATA_FIM S DATE AAAA- Data Final da
MM-DD Agenda
DR:
ID_ASSOCIACAO S INT 11 Código do
Recurso
associado à
agenda (sala,
equipamento)
NOME_ASSOCIACAO S CHAR 60 Nome do
recurso
TEMPO_REALIZACAO S INT 3 Intervalo
entre a
 Integração Módulo de Regulação Página
Ambulatorial 22
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

realização
dos exames.
Duração do
exame.
PESO S INT 3 Peso máximo
do paciente.
(0 = sem
restrição)
DF
ID_PROFISSIONAL N INT 11 Código do
Profissional
no CROSS
DOC_PROFISSIONAL N CHAR 45 Número do
registro do
profissional
em seu
conselho
regional
ORIGEM N CHAR 45 Sigla do
Conselho
regional do
profissional
NOME_PROFISSIONAL N CHAR 60 Nome do
Profissional
ID_ESPECIALIDADE N INT 11 Código da
Especialidade
NOME_ESPECIALIDADE N CHAR 50 Nome da
Especialidade
CA:
COD_DIA S INT 1 0,1,2,3,4 Código do dia
,5,6 da semana (0
= Domingo / 1
= Segunda / 2
= Terça ... / 6
= Sábado)
HOR_INI S DATE HH:MM Horário de
_TIME Início da
agenda no
dia
HOR_FIM S DATE HH:MM Horário de
_TIME término da
agenda no
dia
 Integração Módulo de Regulação Página
Ambulatorial 23
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Exames associados nas agendas

DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
ID_AGE_EXAME S INT 11 Código da
Agenda
ID_EXAME S INT 11 Código do
Exame no
CROSS
COD_EXAME S INT 11 Código
original do
Exame
NOME_EXAME S CHAR 200 Descrição do
exame
TIPO_TABELA S CHAR 5 SUS,CBHPM,SES Tabela
utilizada

3) Horários das Agendas

Consulta
Nomenclatura do Arquivo: horario.zip
Conteúdo do zip:

o UEC_HOR_YYYYMMDD.csv
o UEC_CNS_YYYYMMDD.csv

YYYY = Ano, MM = Mês, DD = Dia

Obs. O arquivo zip gerado possui uma senha de acesso configurado pela administração

DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
ID_AGE_CONSULTA S INT 11 Código da
Agenda
ID_AGE_CONSULTA_HOR S INT 11 Código do
agendamento /
horário
DATA_AGENDA S DATE AAAA-MM- Dia da
DD consulta
HOR_INI S TIME HH:MM:SS Hora de início
da consulta
COD_PACIENTE S INT 11 Código Cross
do paciente
STATUS S CHAR 1 P/A/D Status da
Recepção: P -
Presente / A -
Ausente / D -
 Integração Módulo de Regulação Página
Ambulatorial 24
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Desistente
FALTA_MEDICA (*) N CHAR 1 Sem Flag de falta
informação médica
ALTA S CHAR 1 S/N Flag de alta do
paciente
ID_MOTIVO S INT 1 Vide Motivo do
seção cancelamento.
tabelas
auxiliares
BLOQUEADO S CHAR 1 S/N Indica se o
horário está
bloqueado ou
não.
(S=agenda
bloqueado / N
= liberado)

(*) Campo não utilizado. Retorno sempre em branco.

CNS dos pacientes associados nas agendas

DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
COD_PACIENTE S INT 11 Código
Cross do
paciente
NOME_PACIENTE S CHAR 60 Nome do
paciente
NUM_CNS N INT 16 Cartão
Nacional de
Saúde

Exame
Nomenclatura do Arquivo: horario.zip
Conteúdo do zip:

o UEE_HOR_YYYYMMDD.csv
o UE_CNS_YYYYMMDD.csv

YYYY = Ano, MM = Mês, DD = Dia

Obs. O arquivo zip gerado possui uma senha de acesso configurado pela administração
 Integração Módulo de Regulação Página
Ambulatorial 25
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
ID_AGE_EXAME S INT 11 Código da
Agenda
ID_AGE_EXAME_HOR S INT 11 Código do
agendamento /
horário
DATA_AGENDA S DATE AAAA-MM- Data da
DD consulta
HOR_INI S TIME 1 HH:MM:SS Hora de início
da consulta
COD_PACIENTE S INT 11 Código Cross
do paciente
STATUS S CHAR 1 P/A/D Status da
Recepção: P -
Presente / A -
Ausente / D -
Desistente
FALTA_MEDICA(*) N CHAR 1 Sem Flag de falta
informação médica
ALTA S CHAR 1 S/N Flag de alta do
paciente
ID_MOTIVO S INT 1 Vide seção Motivo do
tabelas cancelamento.
auxiliares
BLOQUEADO S CHAR 1 S/N Indica se o
horário está
bloqueado ou
não.
(S=agenda
bloqueado / N
= liberado)
(*) Campo não utilizado. Retorno sempre em branco.
CNS dos Pacientes associados nas agendas
DG:
Campo Obrigatório Tipo Tamanho Formato Valores Descrição
COD_PACIENTE S INT 11 Código
Cross do
paciente
NOME_PACIENTE S CHAR 60 Nome do
paciente
NUM_CNS N INT 16 Cartão
Nacional de
Saúde
 Integração Módulo de Regulação Página
Ambulatorial 26
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Integração via Post XML

A integração via Post XML é no sentido Cross  Unidade. O envio das informações é no formato XML
com um layout específico para cada tipo de movimentação: agendamento, cancelamento e transferência.
A unidade deverá fornecer um link preparado para receber esses xmls com os devidos acessos. Na seção
exemplo, encontra-se um trecho de um código em PHP para tratar os Xmls.

Obs. Caso o link da unidade não estiver disponível, a integração manterá as mensagens na fila e fará o
seu envio novamente.
 Integração Módulo de Regulação Página
Ambulatorial 27
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Schema dos XML

1) Sob Demanda

Consulta

a. Agendamento

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

<NewDataSet>
<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Mensagem"
msdata:UseCurrentLocale="true">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="Mensagem">
<xs:complexType>
<xs:sequence>
<xs:element name="TIPO_CONSULTA" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_EXECUTANTE" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_CONSULTA_HOR" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_CONSULTA" type="xs:string" minOccurs="0" />
<xs:element name="AGE_CONSULTA_NOME" type="xs:string" minOccurs="0" />
<xs:element name="ID_ESPECIALIDADE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_ESPECIALIDADE" type="xs:string" minOccurs="0" />
<xs:element name="COD_DIA" type="xs:string" minOccurs="0" />
<xs:element name="DATA_AGENDA" type="xs:string" minOccurs="0" />
<xs:element name="HOR_INI" type="xs:string" minOccurs="0" />
<xs:element name="HOR_FIM" type="xs:string" minOccurs="0" />
<xs:element name="TIPO" type="xs:string" minOccurs="0" />
<xs:element name="ID_MOTIVO" type="xs:string" minOccurs="0" />
<xs:element name="ID_PROFISSIONAL" type="xs:string" minOccurs="0" />
<xs:element name="DOC_PROFISSIONAL" type="xs:string" minOccurs="0" />
<xs:element name="ORIGEM" type="xs:string" minOccurs="0" />
<xs:element name="NOME_PROFISSIONAL" type="xs:string" minOccurs="0" />
<xs:element name="ID_PROTOCOLO" type="xs:string" minOccurs="0" />
<xs:element name="SUBCATEG" type="xs:string" minOccurs="0" />
<xs:element name="NOME_PROTOCOLO" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="CNES_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_USUARIO_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="DT_ULTIMA_ATUALIZ" type="xs:string" minOccurs="0" />
<xs:element name="COD_PACIENTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_PACIENTE" type="xs:string" minOccurs="0" />
<xs:element name="SEXO" type="xs:string" minOccurs="0" />
 Integração Módulo de Regulação Página
Ambulatorial 28
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

<xs:element name="DT_NASCIMENTO" type="xs:string" minOccurs="0" />

<xs:element name="RG" type="xs:string" minOccurs="0" />
<xs:element name="CPF" type="xs:string" minOccurs="0" />
<xs:element name="NOME_MAE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_PAI" type="xs:string" minOccurs="0" />
<xs:element name="ENDERECO" type="xs:string" minOccurs="0" />
<xs:element name="ENDERECO_NUMERO" type="xs:string" minOccurs="0" />
<xs:element name="BAIRRO" type="xs:string" minOccurs="0" />
<xs:element name="MUNICIPIO" type="xs:string" minOccurs="0" />
<xs:element name="UF" type="xs:string" minOccurs="0" />
<xs:element name="CEP" type="xs:string" minOccurs="0" />
<xs:element name="TEL_RES_DDD" type="xs:string" minOccurs="0" />
<xs:element name="TEL_RES" type="xs:string" minOccurs="0" />
<xs:element name="TEL_CELULAR_DDD" type="xs:string" minOccurs="0" />
<xs:element name="TEL_CELULAR" type="xs:string" minOccurs="0" />
<xs:element name="TEL_COM_DDD" type="xs:string" minOccurs="0" />
<xs:element name="TEL_COM" type="xs:string" minOccurs="0" />
<xs:element name="TEL_COM_RAMAL" type="xs:string" minOccurs="0" />
<xs:element name="EMAIL" type="xs:string" minOccurs="0" />
<xs:element name="CONTATO_NOME" type="xs:string" minOccurs="0" />
<xs:element name="CONTATO_TEL_DDD" type="xs:string" minOccurs="0" />
<xs:element name="CONTATO_TEL" type="xs:string" minOccurs="0" />
<xs:element name="NUM_CNS" type="xs:string" minOccurs="0" />
<xs:element name="NUM_PRONTUARIO" type="xs:string" minOccurs="0" />
<xs:element name="CD_RACA" type="xs:string" minOccurs="0" />
<xs:element name="COD_ETNIA" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
</NewDataSet>

b. Cancelamento

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

<NewDataSet>
<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Mensagem"
msdata:UseCurrentLocale="true">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="Mensagem">
<xs:complexType>
<xs:sequence>
<xs:element name="TIPO_CONSULTA" minOccurs="0" type="xs:string"/>
<xs:element name="COD_UNIDADE_EXECUTANTE" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_CONSULTA_HOR" type="xs:string" minOccurs="0" />
<xs:element name="COD_PACIENTE" type="xs:string" minOccurs="0" />
<xs:element name="TIPO" type="xs:string" minOccurs="0" />
 Integração Módulo de Regulação Página
Ambulatorial 29
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

<xs:element name="ID_MOTIVO" type="xs:string" minOccurs="0" />

<xs:element name="COD_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="CNES_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_USUARIO_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="DT_ULTIMA_ATUALIZ" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
</NewDataSet>

c. Transferência

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

<NewDataSet>
<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Mensagem"
msdata:UseCurrentLocale="true">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="Mensagem">
<xs:complexType>
<xs:sequence>
<xs:element name="TIPO_CONSULTA" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_EXECUTANTE" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_CONSULTA_HOR_ORIGEM" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_CONSULTA_HOR" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_CONSULTA" type="xs:string" minOccurs="0" />
<xs:element name="ID_ESPECIALIDADE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_ESPECIALIDADE" type="xs:string" minOccurs="0" />
<xs:element name="COD_DIA" type="xs:string" minOccurs="0" />
<xs:element name="DATA_AGENDA" type="xs:string" minOccurs="0" />
<xs:element name="HOR_INI" type="xs:string" minOccurs="0" />
<xs:element name="HOR_FIM" type="xs:string" minOccurs="0" />
<xs:element name="COD_PACIENTE" type="xs:string" minOccurs="0" />
<xs:element name="TIPO" type="xs:string" minOccurs="0" />
<xs:element name="ID_MOTIVO" type="xs:string" minOccurs="0" />
<xs:element name="ID_PROTOCOLO" type="xs:string" minOccurs="0" />
<xs:element name="ID_PROFISSIONAL" type="xs:string" minOccurs="0" />
<xs:element name="DOC_PROFISSIONAL" type="xs:string" minOccurs="0" />
<xs:element name="ORIGEM" type="xs:string" minOccurs="0" />
<xs:element name="NOME_PROFISSIONAL" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_USUARIO_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="DT_ULTIMA_ATUALIZ" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
 Integração Módulo de Regulação Página
Ambulatorial 30
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
</NewDataSet>

Exame

a. Agendamento

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

<NewDataSet>
<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Mensagem"
msdata:UseCurrentLocale="true">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="Mensagem">
<xs:complexType>
<xs:sequence>
<xs:element name="TIPO_EXAME" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_EXECUTANTE" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_EXAME_HOR" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_EXAME" type="xs:string" minOccurs="0" />
<xs:element name="AGE_EXAME_NOME" type="xs:string" minOccurs="0" />
<xs:element name="ID_ASSOCIACAO" type="xs:string" minOccurs="0" />
<xs:element name="NOME_ASSOCIACAO" type="xs:string" minOccurs="0" />
<xs:element name="COD_DIA" type="xs:string" minOccurs="0" />
<xs:element name="DATA_AGENDA" type="xs:string" minOccurs="0" />
<xs:element name="HOR_INI" type="xs:string" minOccurs="0" />
<xs:element name="HOR_FIM" type="xs:string" minOccurs="0" />
<xs:element name="ID_MOTIVO" type="xs:string" minOccurs="0" />
<xs:element name="ID_PROFISSIONAL" type="xs:string" minOccurs="0" />
<xs:element name="DOC_PROFISSIONAL" type="xs:string" minOccurs="0" />
<xs:element name="ORIGEM" type="xs:string" minOccurs="0" />
<xs:element name="NOME_PROFISSIONAL " type="xs:string" minOccurs="0" />
<xs:element name="ID_ESPECIALIDADE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_ESPECIALIDADE" type="xs:string" minOccurs="0" />
<xs:element name="ID_EXAME" type="xs:string" minOccurs="0" />
<xs:element name="COD_EXAME" type="xs:string" minOccurs="0" />
<xs:element name="NOME_EXAME" type="xs:string" minOccurs="0" />
<xs:element name="TIPO_TABELA" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="CNES_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_USUARIO_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="DT_ULTIMA_ATUALIZ" type="xs:string" minOccurs="0" />
<xs:element name="COD_PACIENTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_PACIENTE" type="xs:string" minOccurs="0" />
<xs:element name="SEXO" type="xs:string" minOccurs="0" />
 Integração Módulo de Regulação Página
Ambulatorial 31
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

<xs:element name="DT_NASCIMENTO" type="xs:string" minOccurs="0" />

<xs:element name="RG" type="xs:string" minOccurs="0" />
<xs:element name="CPF" type="xs:string" minOccurs="0" />
<xs:element name="NOME_MAE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_PAI" type="xs:string" minOccurs="0" />
<xs:element name="ENDERECO" type="xs:string" minOccurs="0" />
<xs:element name="ENDERECO_NUMERO" type="xs:string" minOccurs="0" />
<xs:element name="BAIRRO" type="xs:string" minOccurs="0" />
<xs:element name="MUNICIPIO" type="xs:string" minOccurs="0" />
<xs:element name="UF" type="xs:string" minOccurs="0" />
<xs:element name="CEP" type="xs:string" minOccurs="0" />
<xs:element name="TEL_RES_DDD" type="xs:string" minOccurs="0" />
<xs:element name="TEL_RES" type="xs:string" minOccurs="0" />
<xs:element name="TEL_CELULAR_DDD" type="xs:string" minOccurs="0" />
<xs:element name="TEL_CELULAR" type="xs:string" minOccurs="0" />
<xs:element name="TEL_COM_DDD" type="xs:string" minOccurs="0" />
<xs:element name="TEL_COM" type="xs:string" minOccurs="0" />
<xs:element name="TEL_COM_RAMAL" type="xs:string" minOccurs="0" />
<xs:element name="EMAIL" type="xs:string" minOccurs="0" />
<xs:element name="CONTATO_NOME" type="xs:string" minOccurs="0" />
<xs:element name="CONTATO_TEL_DDD" type="xs:string" minOccurs="0" />
<xs:element name="CONTATO_TEL" type="xs:string" minOccurs="0" />
<xs:element name="NUM_CNS" type="xs:string" minOccurs="0" />
<xs:element name="NUM_PRONTUARIO" type="xs:string" minOccurs="0" />
<xs:element name="CD_RACA" type="xs:string" minOccurs="0" />
<xs:element name="COD_ETNIA" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
</NewDataSet>

b. Cancelamento

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

<NewDataSet>
<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Mensagem"
msdata:UseCurrentLocale="true">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="Mensagem">
<xs:complexType>
<xs:sequence>
<xs:element name="TIPO_EXAME" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_EXECUTANTE" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_EXAME_HOR" type="xs:string" minOccurs="0" />
<xs:element name="COD_PACIENTE" type="xs:string" minOccurs="0" />
<xs:element name="ID_MOTIVO" type="xs:string" minOccurs="0" />
 Integração Módulo de Regulação Página
Ambulatorial 32
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

<xs:element name="COD_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />

<xs:element name="NOME_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="CNES_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_USUARIO_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="DT_ULTIMA_ATUALIZ" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
</NewDataSet>

c. Transferência

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

<NewDataSet>
<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Mensagem"
msdata:UseCurrentLocale="true">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="Mensagem">
<xs:complexType>
<xs:sequence>
<xs:element name="TIPO_EXAME" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_EXECUTANTE" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_EXAME_HOR_ORIGEM" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_EXAME_HOR" type="xs:string" minOccurs="0" />
<xs:element name="ID_AGE_EXAME" type="xs:string" minOccurs="0" />
<xs:element name="COD_DIA" type="xs:string" minOccurs="0" />
<xs:element name="DATA_AGENDA" type="xs:string" minOccurs="0" />
<xs:element name="HOR_INI" type="xs:string" minOccurs="0" />
<xs:element name="HOR_FIM" type="xs:string" minOccurs="0" />
<xs:element name="COD_PACIENTE" type="xs:string" minOccurs="0" />
<xs:element name="TIPO" type="xs:string" minOccurs="0" />
<xs:element name="ID_MOTIVO" type="xs:string" minOccurs="0" />
<xs:element name="COD_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_UNIDADE_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="NOME_USUARIO_SOLICITANTE" type="xs:string" minOccurs="0" />
<xs:element name="DT_ULTIMA_ATUALIZ" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
</NewDataSet>
 Integração Módulo de Regulação Página
Ambulatorial 33
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Integração Web Service – Recepção

Essa integração é no sentido Unidade  Cross e contemplam as recepções realizada nas consultas e
exames na unidade. Todas as mensagens recebidas são tratadas e armazenadas numa fila e
consolidadas posteriormente no portal Cross. Essa consolidação acontece diariamente as 22:00 horas.

Obs. O endereço do WebService será disponibilizado pela Administração.

Parâmetros de entrada
Campo Tipo Tamanho Formato Valores Descrição
Usuário CHAR 10 Será fornecido pela Login de
Administração Módulo acesso
de Regulação
Ambulatorial
Senha CHAR 20 Será fornecido pela Senha de
Administração Módulo acesso
de Regulação
Ambulatorial
Tipo CHAR 1 C ou E Consulta ou
Exame
CodUnidadeExec INT 11 Código Cross
da Unidade
Executante.
CodigoAgendamento INT 11 Código Cross
de
Agendamento
CodigoPaciente INT 11 Código Cross
do Paciente
Status (*) CHAR 1 (P) Presente Status da
 Integração Módulo de Regulação Página
Ambulatorial 34
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

(T) Teleconsulta recepção

(A) Ausente
(D) Desistente
(I) Dispensado

Alta (**) CHAR 1 (S)im (N)ão Alta do

Paciente
Falta_Médica(****) CHAR 1 (S)im (N)ão Falta Médica
NomeUnidade CHAR 60 Nome da
Unidade
NomeUsuarioAcao CHAR 60 Nome do
usuário
DtAtualizacao DATE DD/MM/YYYY Data da
HH:MM:SS Recepção

NumeroProntuario INT 11 Número do

prontuário do
paciente
CodigoMotivo INT 11 Código motivo
CodUnidadeOrigem INT 11 Código Cross
da Unidade
Origem
(opcional)
CodigoMotivoAlta INT 11 Código do
Motivo da
Alta. (Vide
tabela abaixo
Código alta
recepção)
JustificativaAlta(***) CHAR 120 Justificativa
da Alta

(*) Para Status D ou I, é obrigatório informar um código de motivo. Esse código deverá seguir a lista de
motivos desistente (Status = D) e dispensado (Status = I). Vide abaixo a tabela lista de motivos.

Dispensado
ID_MOTIVO DESCRIÇÂO STATUS
60 RFI – Recurso Físico Indisponível I
61 FRH – Falta de Recurso Humano I
62 SP – Sem Preparo I
63 ME – Marcação Errada I
64 SE – Sem Encaminhamento I
65 SA – Sem Acompanhante I
66 SD – Sem Documento I
 Integração Módulo de Regulação Página
Ambulatorial 35
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

70 IRE – Impossibilidade de Realizar o I

Exame
71 PA – Paciente Atrasado I
72 EI – Encaminhamento Incorreto I
73 SEO – Sem Exames Obrigatórios I
94 NRC – Não Realizará a Cirurgia I
Onde I = Dispensado
Desistente
ID_MOTIVO DESCRIÇÂO STATUS
67 EV – Evadiu-se D
68 DA – Demora no Atendimento D
69 FOB – Fobia D
95 NRC – Não Realizará a Cirurgia D
Onde D=Desistente

(**) É opcional o preenchimento de uma justificativa no campo JustificativaAlta para Alta = “S” ou “N”.
(***) Caso o código do motivo de alta informado for igual a 101 (Outros) será obrigatório fornecer uma
justificativa no campo JustificativaAlta
(****) Campo não utilizado.

Código Alta Recepção

ID_MOTIVO_ALTA DESCRIÇÂO ALTA

98 CR - Cirurgia realizada S
99 SIC_- Sem indicação cirúrgica S
100 TF - Tratamento finalizado S
101 Outros (Justificar)* S
 Integração Módulo de Regulação Página
Ambulatorial 36
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Exemplos

Exemplo de um código em PHP

Segue um exemplo de uma página em PHP referente ao processo de recebimento do xml (http post).
<?php
// Recebe o xml mensagem do Módulo de Regulação Ambulatorial via POST
$Mensagem = $_POST[msg];

// Carrega o xml
$doc = new DOMDocument();
$doc->loadXML($Mensagem);

// Grava o xml para log interno

$doc->save(“msg.xml”);

// Trata o tipo da mensagem (Consulta / Exame)

$tipo = $doc->getElementsByTagName('Consulta) ->item (0);

If (is_null($tipo)) {

//Agendamento
$operacao = $doc->getElementsByTagName('Agendamento) ->item (0);

If (is_null($operacao)) {

// Conforme item Estrutura de msg de envio tratar cada nó do xml

$dadosgerais = $doc->getElementsByTagName('DADOSGERAIS’) ->item (0);
$profissional = $doc->getElementsByTagName('PROFISSIONAL’) ->item (0);

// ....

// Realizar o processamento interno

// Caso processamento interno ok

// O Módulo de Regulação Ambulatorial ira entender que a msg foi executado com sucesso.
$codigoretorno = ‘S’;
$descricao = “”;

//Caso processamento interno n ok

// O Módulo de Regulação Ambulatorial devera reter a msg na fila para posterior execução;
$codigoretorno = ‘N’;
$descricao = “Descrição do erro”;

//Conforme xml Estrutura de mensagem de recebimento retornar o xml

$retorno = new DOMDocument();
 Integração Módulo de Regulação Página
Ambulatorial 37
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

$xml = "<? xml version='1.0' encoding='iso-8859-1'?>";

$xml = $xml. “<RETORNO>”;
$xml = $xml. “<CODIGORETORNO> “. $codigoretorno. </CODIGORETORNO>”;
$xml = $xml. “<DESCRICAO>”. $descricao. “</DESCRICAO>”;
$xml = $xml. < /RETORNO>”;

Return $retorno->saveXML ();

}

//Cancelamento
$operacao = $doc->getElementsByTagName('Cancelamento’) ->item (0);

If (is_null($operacao)) {
// Conforme item Estrutura de msg de envio tratar cada nó do xml
$dadosgerais = $doc->getElementsByTagName('DADOSGERAIS’) ->item (0);
// Tratar mesma rotina do Agendamento

//Transferência
$operacao = $doc->getElementsByTagName('Transferencia’) ->item (0);

If (is_null($operacao)) {
// Conforme item Estrutura de msg de envio tratar cada nó do xml
$dadosgerais = $doc->getElementsByTagName('DADOSGERAIS’) ->item (0);
// Tratar mesma rotina do Agendamento

// Trata o tipo da mensagem (Consulta / Exame)

$tipo = $doc->getElementsByTagName(‘Exame’) ->item(0);

If (is_null($tipo)) {

//Agendamento
$operacao = $doc->getElementsByTagName('Agendamento’) ->item (0);

If (is_null($operacao)) {

// Conforme item Estrutura de msg de envio tratar cada nó do xml

$dadosgerais = $doc->getElementsByTagName('DADOSGERAIS’) ->item (0);
$profissional = $doc->getElementsByTagName('PROFISSIONAL’) ->item (0);

// ....
 Integração Módulo de Regulação Página
Ambulatorial 38
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

// Realizar o processamento interno

// Caso processamento interno ok

// O Módulo de Regulação Ambulatorial ira entender que a msg foi executado com sucesso.
$codigoretorno = ‘S’;
$descricao = “”;

//Caso processamento interno n ok

// O Módulo de Regulação Ambulatorial devera reter a msg na fila para posterior execução;
$codigoretorno = ‘N’;
$descricao = “Descrição do erro”;

//Conforme xml Estrutura de mensagem de recebimento retornar o xml

$retorno = new DOMDocument ();
$xml = "<? xml version='1.0' encoding='iso-8859-1'?>";
$xml = $xml. “<RETORNO>”;
$xml = $xml. “<CODIGORETORNO> “. $codigoretorno. </CODIGORETORNO>”;
$xml = $xml. “<DESCRICAO>”. $descricao. “</DESCRICAO>”;
$xml = $xml. < /RETORNO>”;

Return $retorno->saveXML ();

}

//Cancelamento
$operacao = $doc->getElementsByTagName('Cancelamento’) ->item (0);

If (is_null($operacao)) {
// Conforme item Estrutura de msg de envio tratar cada nó do xml
$dadosgerais = $doc->getElementsByTagName('DADOSGERAIS’) ->item (0);
/ Tratar mesma rotina do Agendamento

//Transferencia
$operacao = $doc->getElementsByTagName('Transferencia’) ->item (0);

If (is_null($operacao)) {
// Conforme item Estrutura de msg de envio tratar cada nó do xml
$dadosgerais = $doc->getElementsByTagName('DADOSGERAIS’) ->item (0);

// Tratar mesma rotina do Agendamento

}
}

?>
 Integração Módulo de Regulação Página
Ambulatorial 39
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Exemplo conteúdo de um arquivo CSV

Tipo de integração: Operação sob demanda

Nomenclatura do arquivo: UEC_YYYYMMDD.CSV

C;A;DG:54660;DG:323;DG:56;DG:Agenda
teste;DG:907;DG:Cardiologia;DG:5;DG:20;DG:05:00:00;DG:05:30:00;DG:P;DG:0;PF:58962;PF:5000326;
PF:SLG;PF:Jose da Silva
Cordeiro;PR:598202;PR:E10;PR:Protocolo;DS:6356;DS:Heliopolis;DS:13413513;DS:Rita de Cassia;DS:2009-
05-05 05:00:00;PC:56235;PC:Maria das Graças;PC:F;PC:1975-09-
09;PC:38293029;PC:87890988721;PC:Maria do Carmo;PC:Geraldo Jose;PC:Rua 13 de
maio;PC:531;PC:Capao Redondo;PC:São Paulo;PC:SP;PC:0983-093;PC:11;PC:;PC:;PC:8722-
9090;PC:11;PC:;PC:;PC:celdj@uol.com.br;PC:;PC:;PC:; PC:45898464;PC:65232121;PC:1;PC:

Conteúdo Exemplo Descrição

C Consulta
A Agendamento Normal e Extra
DG:54660 Código da unidade Executantes
DG:323 Código do agendamento / horário
DG:56 Código da Agenda
DG: Agenda teste Nome da Agenda
DG:907 Código da Especialidade
DG: Cardiologia Nome da Especialidade
DG:5 Código do dia da semana, onde 0 é Domingo e 6 é Sábado
DG:20 Dia da consulta
DG:05:00:00 Hora de início da consulta
DG:05:30:00 Hora final da consulta
DG:P Tipo do agendamento (P - 1a consulta / R - Retorno)
DG:0 Motivo do agendamento (Normal / Extra). 0-Agendamento
normal / 1-Extra - Pedido do médico / 2-Extra - Troca de
paciente / 3-Extra - Carta Datada / 4-Extra - Filipeta Datada / 5-
Extra - Paciente Internado
PF:58962 Código do Profissional no Módulo de Regulação Ambulatorial
PF:5000326 Número do registro do profissional em seu conselho regional
PF:SLG Sigla do Conselho regional do profissional
PF: José da Silva Cordeiro Nome do Profissional
PR: 598202 Código do protocolo escolhido no agendamento
PR:E10 Código CID 10 do protocolo escolhido
PR:Protocolo Nome do Protocolo escolhido
DS:6356 Código CROSS da unidade que agendou
DS:Heliopolis Nome da unidade que agendou
DS:13413513 CNES da unidade que agendou
DS: Rita de Cassia Nome do usuário que agendou
DS:2009-05-05 05:00:00 Data e hora do agendamento
PC:56235 Código CROSS do Paciente
 Integração Módulo de Regulação Página
Ambulatorial 40
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

PC:Maria das Graças Nome do paciente agendado

PC:F Sexo. M (masculino), F (feminino), I (indeterminado)
PC:1975-09-09 Data de nascimento do paciente
PC:38293029 RG do Paciente
PC:87890988721 CPF do Paciente
PC:Maria do Carmo Nome da mãe do paciente
PC:Geraldo Jose Nome do pai do paciente
PC:Rua 13 de maio Endereço do paciente sem número
PC:531 Número do endereço do paciente
PC:Capao Redondo Bairro do paciente
PC:São Paulo Município do Paciente
PC:SP Estado do Paciente
PC:0983-093 CEP do Paciente
PC:11 DDD do Telefone residencial
PC: Número do telefone residencial
PC: DDD do celular
PC:8722-9090 Número do celular
PC:11 DDD do telefone comercial
PC: Número do telefone comercial
PC: Ramal do telefone comercial
PC:celdj@uol.com.br e-mail do paciente
PC: Nome do contato do telefone para recados
PC: DDD do telefone do contado
PC: Número do telefone do contato
PC:45898464 Cartão Nacional de Saúde
PC:65232121 Prontuários do paciente na unidade executante
PC:1 Código da Raça
PC: Código da Etnia
 Integração Módulo de Regulação Página
Ambulatorial 41
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Tipo de integração: Operação sob demanda

Nomenclatura do arquivo: UEC_YYYYMMDD.CSV

C;T;DG:3256;DG:323;DG:56;DG:907;DG:878;DG:Pediatria;DG:3;DG:2009-05-
05;DG:05:30:00;DG:06:00:00;DG:32;DG:P;DG:0;DG:SLG;PF:8975268;PF:365984;PF:AGG;PF:Thiago
Guimarães;US: 567214;US:Heliopolis;US:Rita de Cassia;US:2009-10-10 04:00:00

Conteúdo Exemplo Descrição

C Consulta
T Transferência
DG:3256 Código da Unidade Executante
DG:323 Código do agendamento / horário de origem
DG:56 Código do agendamento / horário de destino
DG:907 Código da Agenda de destino
DG:878 Código da Especialidade
DG: Pediatria Nome da Especialidade
DG:3 Código do dia da semana, onde 0 é Domingo e 6 é Sábado
DG:2009-05-05 Dia da consulta
DG:05:30:00 Hora de início da consulta
DG:06:00:00 Hora final da consulta
DG:32 Código CROSS do Paciente
DG:P Tipo do agendamento (P - 1a consulta / R - Retorno)
DG:0 0 - Agendamento Normal
DG:SLG Código do protocolo escolhido no agendamento
PF:8975268 Código do Profissional no Módulo de Regulação Ambulatorial
PF:365984 Número do registro do profissional em seu conselho regional
PF:AGG Sigla do Conselho regional do profissional
PF:Thiago Guimarães Nome do Profissional
US: 567214 Código CROSS da unidade que realizou a transferência
US:Heliopolis Nome da unidade do usuário que realizou a transferência
US:Rita de Cassia Nome do usuário que realizou a transferência
US:2009-10-10 04:00:00 Data e hora da ação
 Integração Módulo de Regulação Página
Ambulatorial 42
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Tipo de integração: Operação sob demanda

Nomenclatura do arquivo: UEC_YYYYMMDD.CSV

C;C;DG:3256;DG:323;DG:56;DG:907;DG:878;US:567214;US:Heliopolis;US:Rita de Cassia;US:2009-10-
10 04:00:00

Conteúdo Exemplo Descrição

C Consulta
C Cancelamento
DG:3256 Código da Unidade Executante
DG:323 Código do agendamento / horário de destino
DG:56 Código CROSS do Paciente
DG:P Tipo do agendamento (P - 1a consulta / R - Retorno)
DG:1 1-Marcação errada / 2-Paciente ligou desmarcando / 3-Paciente faleceu
/ 4-Transferência para outra data / 5-Impossibilidade de confirmação
com o paciente / 6-Troca de paciente
US:567214 Código CROSS da unidade que realizou a transferência
US:Heliopolis Nome da unidade do usuário que realizou a transferência
US:Rita de Cassia Nome do usuário que realizou a transferência
US:2009-10-10 04:00:00 Data e hora do agendamento

Tipo de integração: Operação sob demanda

Nomenclatura do arquivo: UEE_YYYYMMDD.CSV

E;A;DG:54660;DG:323;DG:56;DG:Agenda1;DG:1;DG:Recurso1;DG:5;DG:5;DG:05:00:00;DG:05:30:00;DG:;DG:0;
DP:32332;DP:9878795;DP:SPP;DP:Profissional1;DP:131423;DP:Espec1;DE:58962;DE:5000326;DE:Abreugrafia;DE:IME
;DS:89566;DS:Heliopolis;DS:5687932568;DS:Rita de Cássia;DS:2009-08-08 05:00:00;PC:589624;PC:Paula de
Assis;PC:F;PC:1978-05-05;PC:58965852;PC:06365698698;PC:Benedita de Assis;PC:Benedito de Assis;PC:Rua
Vergueiro;PC:85;PC:Vila Mariana;PC:São Paulo;PC:SP;PC:05633-000;PC:11;PC:56-
9898;PC:11;PC:9865565;PC:11;PC:8059-9855;PC:85;PC:trhdd@terra.com.br;PC:Maria;PC:11;PC:5265-
8952;PC:45898464;PC:65232121;PC:2;PC:

Conteúdo Exemplo Descrição

E Exame
A Agendamento Normal e Extra
DG:54660 Código da Unidade Executante
DG:323 Código do agendamento / horário
DG:56 Código da Agenda
DG:Agenda1 Nome da Agenda
DG:1 Código do Recurso associado à agenda (sala,
equipamento, etc.)
DG:Recurso1 Nome do Recurso
DG:5 Código do dia da semana, onde 0 é Domingo e 6 é Sábado
DG:5 Dia da EXAME
 Integração Módulo de Regulação Página
Ambulatorial 43
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

DG:05:00:00 Hora de início da EXAME

DG:05:30:00 Hora final da EXAME
DG: Em branco
DG:0 Motivo do agendamento (Normal / Extra). 0-Agendamento
normal / 1-Extra - Pedido do médico / 2-Extra - Troca de
paciente / 3-Extra - Carta Datada / 4-Extra - Filipeta Datada
/ 5-Extra - Paciente Internado
DP:32332 Código do Profissional no Módulo de Regulação
Ambulatorial
DP:9878795 Número do registro do profissional em seu conselho
regional
DP:SPP Sigla do Conselho regional do profissional
DP:Profissional1 Nome do Profissional
DP:131423 Código da Especialidade
DP:Espec1 Nome da Especialidade
DE:58962 Código do Exame no Módulo de Regulação Ambulatorial
DE:5000326 Código original do Exame
DE:Abreugrafia Descrição do exame
DE:IME Tabela utilizada
DS:89566 Código CROSS da unidade que agendou
DS:Heliopolis Nome da unidade que agendou
DS:5687932568 CNES da unidade que agendou
DS:Rita de Cassia Nome do usuário que agendou
DS:2009-08-08 05:00:00 Data e hora do agendamento
PC:589624 Código CROSS do Paciente
PC:Paula de Assis Nome do paciente agendado
PC:F Sexo. M (masculino), F (feminino), I (indeterminado)
PC:1978-05-05 Data de nascimento do paciente
PC:58965852 RG do Paciente
PC:06365698698 CPF do Paciente
PC:Benedita de Assis Nome da mãe do paciente
PC:Benedito de Assis Nome do pai do paciente
PC:Rua Vergueiro Endereço do paciente sem número
PC:85 Número do endereço do paciente
PC:Vila Mariana Bairro do paciente
PC:São Paulo Município do Paciente
PC:SP Estado do Paciente
PC:05633-000 CEP do Paciente
PC:11 DDD do Telefone residencial
PC:56-9898 Número do telefone residencial
PC:11 DDD do celular
PC:9865565 Número do celular
PC:11 DDD do telefone comercial
PC:8059-9855 Número do telefone comercial
 Integração Módulo de Regulação Página
Ambulatorial 44
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

PC:85 Ramal do telefone comercial

PC:trhdd@terra.com.br e-mail do paciente
PC:Maria Nome do contato do telefone para recados
PC:11 DDD do telefone do contato
PC:5265-8952 Número do telefone do contato
PC:45898464 Cartão Nacional de Saúde
PC:65232121 Prontuários do paciente na unidade executante
PC:2 Código da raça
PC: Código da Etnia
 Integração Módulo de Regulação Página
Ambulatorial 45
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Tipo de integração: Operação sob demanda

Nomenclatura do arquivo: UEE_YYYYMMDD.CSV

E;T;DG:3256;DG:323;DG:56;DG:907;DG:5;DG:20;DG:15:00:00;DG:15:30:00;DG:854564;DG:I;DG:0;US:
567214;US:Heliopolis;US:Rita de Cassia;US:2009-10-10 04:00:00

Conteúdo Exemplo Descrição

E Exame
T Transferência
DG:3256 Código da Unidade Executante
DG:323 Código do agendamento / horário de origem
DG:56 Código do agendamento / horário de destino
DG:907 Código da Agenda de destino
DG:5 Código do dia da semana, onde 0 é Domingo e 6 é Sábado
DG:20 Dia da EXAME
DG:15:00:00 Hora de início da EXAME
DG:15:30:00 Hora final da EXAME
DG:854564 Código CROSS do Paciente
DG:I Tipo do agendamento (I - Interno/ E - Externo)
DG:0 0 - Agendamento Normal
US: 567214 Código CROSS da unidade que realizou a transferência
US:Heliopolis Nome da unidade do usuário que realizou a transferência
US:Rita de Cassia Nome do usuário que realizou a transferência
US:2009-10-10 04:00:00 Data e hora da ação

Tipo de integração: Operação sob demanda

Nomenclatura do arquivo: UEE_YYYYMMDD.CSV

E;C;DG:3256;DG:323;DG:56;DG:2;US:567214;US:Heliopolis;US:Rita de Cassia;US:2009-10-10
04:00:00

Conteúdo Exemplo Descrição

E Exame
C Cancelamento
DG:3256 Código da Unidade Executante
DG:323 Código do agendamento / horário de destino
DG:56 Código CROSS do Paciente
DG:2 1-Marcação errada / 2-Paciente ligou desmarcando / 3-Paciente faleceu
/ 4-Transferência para outra data / 5-Impossibilidade de confirmação
com o paciente / 6-Troca de paciente
US:567214 Código CROSS da unidade que realizou a transferência
US:Heliopolis Nome da unidade do usuário que realizou a transferência
US:Rita de Cassia Nome do usuário que realizou a transferência
US:2009-10-10 04:00:00 Data e hora do agendamento
 Integração Módulo de Regulação Página
Ambulatorial 46
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Tipo de integração: Configurações das agendas

Nomenclatura do arquivo: UEC_CONF_YYYYMMDD.CSV

DG:342;DG:Geral;DG:6563;DG:0;DG:200;DG:N;DG:2011-01-01;DG:2012-01-
01;DF:67483;DF:7733223;DF:SP;DF:Jose da
Silva;DF:9030;DF:Cardiologia;CA:1;CA:09:00;CA:12:00;CA:1;CA:4;CA:10;CA:3:CA2:5

Conteúdo Exemplo Descrição

DG:342 Código da Agenda
DG:Geral Nome da Agenda
DG:6563 Código da Unidade Executante
DG:0 Idade mínima do paciente. (0 = sem restrição)
DG:200 Idade máxima do paciente. (200 = sem restrição)
DG:N Indica se a agenda está bloqueada ou não. (S=agenda
bloqueada / N=agenda liberada)
DG:2011-01-01 Data de Início da Agenda
DG:2012-01-01 Data Final da Agenda
DF:67483 Código do Profissional no CROSS
DF:7733223 Número do registro do profissional em seu conselho
regional
DF:SP Sigla do Conselho regional do profissional
DF:Jose da Silva Nome do Profissional
DF:9030 Código da Especialidade
DF:Cardiologia Nome da Especialidade
CA:1 Código do dia da semana (0 = Domingo / 1 = Segunda / 2 =
Terça ... / 6 = Sábado)
CA:09:00 Horário de Início da agenda no dia
CA:12:00 Horário de término da agenda no dia
CA:1 Intervalo entre a realização das consultas. Duração da
consulta.
CA:4 Percentual de primeiras consultas para o dia, nesta
agenda
CA:10 Percentual de retornos para o dia, nesta agenda
CA:3 Número de primeiras consultas para o dia, nesta agenda
CA:5 Números de retornos para o dia, nesta agenda
 Integração Módulo de Regulação Página
Ambulatorial 47
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Tipo de integração: Protocolo das agendas – Consulta

Nomenclatura do arquivo: UEC_PROT_YYYYMMDD.CSV

DG:56474;DG:A893;DG:1

Conteúdo Exemplo Descrição

DG:56474 Código CROSS do protocolo
DG:A893 Código CID 10 do protocolo
DG:1 Código da Agenda

Tipo de integração: Horários das agendas

Nomenclatura do arquivo: UEC_HOR_YYYYMMDD.CSV

DG:56474;DG:12837;DG:1;DG:07:00:00;DG:34522;DG:P; DG:; DG:N; DG:2; DG:S

Conteúdo Exemplo Descrição

DG:56474 Código da Agenda
DG:12837 Código do agendamento / horário
DG:1 Dia da consulta
DG:07:00:00 Hora de início da consulta
DG:34522 Código CROSS do paciente
DG:P Status da Recepção: P - Presente / A - Ausente / D - Desistente
DG: Flag de falta médica(branco)
DG:N Flag de alta do paciente
DG:2 Motivo do cancelamento. Ver lista de motivo
DG:S Indica se o horário está bloqueado ou não. (S=agenda bloqueado / N =
liberado)

Tipo de integração: Configurações das agendas

Nomenclatura do arquivo: UEE_CONF_YYYYMMDD.CSV

DG:342;DG:Geral;DG:6563;DG:0;DG:200;DG:N;DG:2011-01-01;DG:2012-01-
01;DR:3434;DR:Radiologia;DR:1;DR:0;DF:67483;DF:7733223;DF:SP;DF:Jose da
Silva;DF:9030;DF:Cardiologia;CA:1;CA:09:00;CA:12:00

Conteúdo Exemplo Descrição

DG:342 Código da Agenda
DG:Geral Nome da Agenda
DG:6563 Código da Unidade Executante
DG:0 Idade mínima do paciente. (0 = sem restrição)
DG:200 Idade máxima do paciente. (200 = sem restrição)
DG:N Indica se a agenda está bloqueada ou não. (S=agenda
bloqueada / N=agenda liberada)
DG:2011-01-01 Data de Início da Agenda
DG:2012-01-01 Data Final da Agenda
 Integração Módulo de Regulação Página
Ambulatorial 48
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

DR:3434 Código do Recurso associado à agenda (sala,

equipamento)
DR:Radiologia Nome do recurso
DR:1 Intervalo entre a realização dos exames. Duração do
exame.
DR:0 Peso máximo do paciente. (0=sem restrição)
DF:67483 Código do Profissional no CROSS
DF:7733223 Número do registro do profissional em seu conselho
regional
DF:SP Sigla do Conselho regional do profissional
DF:Jose da Silva Nome do Profissional
DF:9030 Código da Especialidade
DF:Cardiologia Nome da Especialidade
CA:1 Código do dia da semana (0 = Domingo / 1 = Segunda / 2
= Terça ... / 6 = Sábado)
CA:09:00 Horário de Início da agenda no dia
CA:12:00 Horário de término da agenda no dia

Tipo de integração: Protocolo das agendas – Exame

Nomenclatura do arquivo: UEE_PROT_YYYYMMDD.CSV

DG:A893;DG:123;DG:Radiografia;DG:5313

Conteúdo Exemplo Descrição

DG:56474 Código da Agenda
DG:A893 Código do Exame no CROSS
DG:123 Código original do Exame
DG:Radiografia Descrição do exame
DG:5313 Tabela utilizada
 Integração Módulo de Regulação Página
Ambulatorial 49
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Tipo de integração: Horários das agendas

Nomenclatura do arquivo: UEE_HOR_YYYYMMDD.CSV

DG:3251;DG:64612;DG:2;DG:10:00:00;DG:3453;DG:Jose da Silva;DG:P;DG:;DG:S;DG:2;DG:N

Conteúdo Exemplo Descrição

DG:3251 Código da Agenda
DG:64612 Código do agendamento / horário
DG:2 Dia da consulta
DG:10:00:00 Hora de início da consulta
DG:3453 Código CROSS do paciente
DG:P Status da Recepção: P - Presente / A - Ausente / D - Desistente
DG: Flag de falta médica (em branco)
DG:S Flag de alta do paciente
DG:2 Motivo do cancelamento. Ver lista de motivo
DG:N Indica se o horário está bloqueado ou não. (S=agenda bloqueado / N =
liberado)

Tipo de integração: CNS dos Pacientes

Nomenclatura do arquivo: UE_CNS_YYYYMMDD.CSV

DG:56474; DG:Katia da Silva; DG:493829182

Conteúdo Exemplo Descrição

DG:56474 Código CROSS do paciente
DG:Katia da Silva Nome do paciente
DG:493829182 Cartão Nacional de Saúde

Tabelas auxiliares

Lista de Motivos

Cancelamento

ID_MOTIVO NOME_MOTIVO
1 Marcação errada
2 Paciente ligou desmarcando
3 Paciente faleceu
4 Transferência para outra data
5 Impossibilidade de confirmação com o paciente
6 Troca de paciente
8 Cancelado após recebimento de Torpedo
 Integração Módulo de Regulação Página
Ambulatorial 50
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

9 Cancelado pessoalmente
10 Cancelado via ligação realizada
11 Tratamento em outro serviço

Normal/Extra
ID_MOTIVO NOME_MOTIVO
1 Solicitação médica
2 Troca de paciente
3 Carta datada
4 Filipeta datada
5 Paciente Internado
6 Paciente pós-operatório
7 Cirurgia Suspensa
8 Encaixe do dia
9 Utilização de horário ocioso

Transferência
ID_MOTIVO NOME_MOTIVO
1 Licença do profissional
2 Férias do profissional
3 Equipamento quebrado
4 Solicitação do paciente
5 Desligamento do profissional
6 Alteração de agenda
7 Falta médica

Código de Raças
COD_RAÇA RAÇA
1 Branca
2 Preta
3 Amarela
4 Parda
5 Indígena
9 Sem informação
 Integração Módulo de Regulação Página
Ambulatorial 51
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

Código de Etnias

COD_ETNIA ETNIA
1 ACONA (WAKONAS, NACONAS, JAKONA, ACORANES)
2 AIKANA (AIKANA, MASSAKA, TUBARAO)
3 AJURU
4 AKUNSU (AKUNT'SU)
5 A M A N AY E
6 A M O N D AWA
7 ANAMBE
8 APARAI (APALAI)
9 APIAKA (APIACA)
10 APINAYE (APINAJE/APINAIE/APINAGE)
11 APURINA (APORINA, IPURINA, IPURINA, IPURINAN)
12 ARANA (ARACUAI DO VALE DO JEQUITINHONHA)
13 ARAPASO (ARAPACO)
14 ARARA DE RONDONIA (KARO, URUCU, URUKU)
15 ARARA DO ACRE (SHAWANAUA, AMAWAKA)
16 ARARA DO ARIPUANA (ARARA DO
BEIRADAO/ARIPUANA)
17 ARARA DO PARA (UKARAGMA, UKARAMMA)
18 ARAWETE (ARAUETE)
19 ARIKAPU (ARICAPU, ARIKAPO, MASUBI, MAXUBI)
20 ARIKEM (ARIQUEN, ARIQUEME, ARIKEME)
21 ARIKOSE (ARICOBE)
22 ARUA
23 ARUAK (ARAWAK)
24 ASHANINKA (KAMPA)
25 ASURINI DO TOCANTINS (AKUAWA/AKWAWA)
26 ASURINI DO XINGU (AWAETE)
27 ATIKUM (ATICUM)
28 AVA - C A N O E I R O
29 AWETI (AUETI/AUETO)
30 BAKAIRI (KURA, BACAIRI)
31 BANAWA YAFI (BANAWA, BANAWA-JAFI)
32 BANIWA (BANIUA, BANIVA, WALIMANAI, WAKUENAI)
33 BARA (WAIPINOMAKA)
34 BARASANA (HANERA)
35 BARE
36 BORORO (BOE)
37 BOTOCUDO (GEREN)
38 CANOE
39 C A S S U PA
40 CHAMACOCO
41 CHIQUITANO (XIQUITANO)
42 CIKIYANA (SIKIANA)
 Integração Módulo de Regulação Página
Ambulatorial 52
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

43 CINTA LARGA (MATETAMAE)

44 COLUMBIARA (CORUMBIARA)
45 DENI
46 DESANA (DESANA, DESANO, DESSANO,
WIRA,UMUKOMASA)
47 DIAHUI (JAHOI, JAHUI, DIARROI)
48 ENAWENE-NAWE (SALUMA)
49 FULNI-O
50 GALIBI (GALIBI DO OIAPOQUE, KARINHA)
51 GALIBI MARWORNO (GALIBI DO UACA, ARUA)
52 GAVIAO DE RONDONIA (DIGUT)
53 GAVIAO KRIKATEJE
54 GAVIAO PARKATEJE (PARKATEJE)
55 GAVIAO PUKOBIE (PUKOBIE, PYKOPJE, GAVIAO
DOMARANHAO)
56 GUAJA (AWA, AVA)
57 GUAJAJARA (TENETEHARA)
58 GUARANI KAIOWA (PAI TAVYTERA)
59 GUARANI M'BYA
60 GUARANI NANDEVA (AVAKATUETE, CHIRIPA,
NHANDEWA, AVA GUARANI)
61 G U ATO
62 HIMARIMA (HIMERIMA)
63 INGARIKO (INGARICO, AKAWAIO, KAPON)
64 IRANXE (IRANTXE)
65 ISSE
66 JABOTI (JABUTI, KIPIU, YABYTI)
67 JAMAMADI (YAMAMADI, DJEOROMITXI)
68 J A R AWA R A
69 JIRIPANCO (JERIPANCO, GERIPANCO)
70 JUMA (YUMA)
71 JURUNA
72 JURUTI (YURITI)
73 KAAPOR (URUBU-KAAPOR, KA'APOR, KAAPORTE)
74 KADIWEU (CADUVEO, CADIUEU)
75 KAIABI (CAIABI, KAYABI)
76 KAIMBE (CAIMBE)
77 KAINGANG (CAINGANGUE)
78 KAIXANA (CAIXANA)
79 KALABASSA (CALABASSA, CALABACAS)
80 KALANCO
81 KALAPALO (CALAPALO)
82 KAMAYURA (CAMAIURA, KAMAIURA)
83 KAMBA (CAMBA)
84 KAMBEBA (CAMBEBA, OMAGUA)
85 KAMBIWA (CAMBIUA)
86 KAMBIWA PIPIPA (PIPIPA)
 Integração Módulo de Regulação Página
Ambulatorial 53
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

87 KAMPE
88 KANAMANTI (KANAMATI, CANAMANTI)
89 KANAMARI (CANAMARI, KANAMARY, TUKUNA)
90 KANELA APANIEKRA (CANELA)
91 KANELA RANKOKAMEKRA (CANELA)
92 KANINDE
93 KANOE (CANOE)
94 KANTARURE (CANTARURE)
95 KAPINAWA (CAPINAUA)
96 KARAJA (CARAJA)
97 KARAJA/JAVAE (JAVAE)
98 KARAJA/XAMBIOA (KARAJA DO NORTE)
99 KARAPANA (CARAPANA, MUTEAMASA,
UKOPINOPONA)
100 KARAPOTO (CARAPOTO)
101 KARIPUNA (CARIPUNA)
102 KARIPUNA DO AMAPA (CARIPUNA)
103 KARIRI (CARIRI)
104 KARIRI-XOCO (CARIRI-CHOCO)
105 KARITIANA (CARITIANA)
106 KATAWIXI (KATAUIXI,KATAWIN, KATAWISI, CATA U I C
HI)
107 KATUENA (CATUENA, KATWENA)
108 KATUKINA (PEDA DJAPA)
109 KATUKINA DO ACRE
110 KAXARARI (CAXARARI)
111 KAXINAWA (HUNI-KUIN, CASHINAUA, CAXINAUA)
112 KAXIXO
113 KAXUYANA (CAXUIANA)
114 KAYAPO (CAIAPO)
115 KAYAPO KARARAO (KARARAO)
116 KAYAPO TXUKAHAMAE (TXUKAHAMAE)
117 KAYAPO XICRIM (XIKRIN)
118 KAYUISANA (CAIXANA, CAUIXANA, KAIXANA)
119 KINIKINAWA (GUAN, KOINUKOEN, KINIKINAO)
120 KIRIRI
121 KOCAMA (COCAMA, KOKAMA)
122 K O K U I R E G AT E J E
123 KORUBO
124 KRAHO (CRAO, KRAO)
125 KREJE (KRENYE)
126 KRENAK (BORUN, CRENAQUE)
127 KRIKATI (KRINKATI)
128 KUBEO (CUBEO, COBEWA, KUBEWA, PAMIWA,
CUBEU)
129 KUIKURO (KUIKURU, CUICURO)
130 KUJUBIM (KUYUBI, CUJUBIM)
 Integração Módulo de Regulação Página
Ambulatorial 54
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

131 KULINA PANO (CULINA)

132 KULINA/MADIHA (CULINA, MADIJA, MADIHA)
133 KURIPAKO (CURIPACO, CURRIPACO, CORIPACO, WA
KUENAI)
134 KURUAIA (CURUAIA)
135 KWAZA (COAIA, KOAIA)
136 MACHINERI (MANCHINERI, MANXINERI)
137 MACURAP (MAKURAP)
138 MAKU DOW (DOW)
139 MAKU HUPDA (HUPDA)
140 MAKU NADEB (NADEB)
141 MAKU YUHUPDE (YUHUPDE)
142 MAKUNA (MACUNA, YEBA-MASA)
143 MAKUXI (MACUXI, MACHUSI, PEMON)
144 MARIMAM (MARIMA)
145 MARUBO
146 M AT I P U
147 M AT I S
148 MATSE (MAYORUNA)
149 MAXAKALI (MAXACALI)
150 MAYA (MAYA)
151 M AY TA P U
152 MEHINAKO (MEINAKU, MEINACU)
153 MEKEN (MEQUEM, MEKHEM, MICHENS)
154 MENKY (MYKY, MUNKU, MENKI, MYNKY)
155 MIRANHA (MIRANHA, MIRANA)
156 MIRITI TAPUIA (MIRITI-TAPUYA, BUIA-TAPUYA)
157 MUNDURUKU (MUNDURUCU)
158 MURA
159 NAHUKWA (NAFUQUA)
160 NAMBIKWARA DO CAMPO (HALOTESU,
KITHAULU,WAKALITESU, SAWENTES, MANDUKA)
161 NAMBIKWARA DO NORTE (NEGAROTE, MAMAINDE,
LATUNDE, SABANE E MANDUKA, TAWANDE)
162 NAMBIKWARA DO SUL (WASUSU,
HAHAINTESU,ALANTESU, WAIKISU, ALAKETESU,
WASUSU, SARARE)
163 NARAVUTE (NARUVOTO)
164 NAWA (NAUA)
165 NUKINI (NUQUINI, NUKUINI)
166 OFAIE (OFAYE-XAVANTE)
167 ORO WIN
168 PAIAKU (JENIPAPO-KANINDE)
169 PAKAA NOVA (WARI, PACAAS NOVOS)
170 PALIKUR (AUKWAYENE, AUKUYENE, PALIKU'ENE)
171 PANARA (KRENHAKARORE, KRENAKORE,
KRENAKARORE)
 Integração Módulo de Regulação Página
Ambulatorial 55
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

172 PANKARARE (PANCARARE)

173 PANKARARU (PANCARARU)
174 PANKARARU KALANKO (KALANKO)
175 PANKARARU KARUAZU (KARUAZU)
176 PANKARU (PANCARU)
177 PARAKANA (PARACANA, APITEREWA, AWAETE)
178 PARECI (PARESI, HALITI)
179 PA R I N T I N T I N
180 PATAMONA (KAPON)
181 PATA X O
182 PATAXO HA-HA-HAE
183 PAUMARI (PALMARI)
184 PA U M E L E N H O
185 PIRAHA (MURA PIRAHA)
186 PIRATUAPUIA (PIRATAPUYA, PIRATAPUYO,
PIRATAPUYA, WAIKANA)
187 P I TA G U A R I
188 POTIGUARA
189 POYANAWA (POIANAUA)
190 RIKBAKTSA (CANOEIROS, ERIGPAKTSA)
191 SAKURABIAT (MEKENS, SAKIRABIAP, SAKIRABIAR)
192 SATERE-MAWE (SATERE-MAUE)
193 SHANENAWA (KATUKINA)
194 SIRIANO (SIRIA-MASA)
195 SURIANA
196 SURUI DE RONDONIA (PAITER)
197 SURUI DO PARA (AIKEWARA)
198 SUYA (SUIA/KISEDJE)
199 TAPAYUNA (BEICO-DE-PAU)
200 TA P E B A
201 TAPIRAPE (TAPI'IRAPE)
202 TAPUIA (TAPUIA-XAVANTE, TAPUIO)
203 TARIANO (TARIANA, TALIASERI)
204 TAUREPANG (TAULIPANG, PEMON, AREKUNA,
PAGEYN)
205 TEMBE
206 TENHARIM
207 TERENA
208 TICUNA (TIKUNA, TUKUNA, MAGUTA)
209 TINGUI BOTO
210 TIRIYO EWARHUYANA (TIRIYO, TRIO, TARONA, YAWI,
PIANOKOTO)
211 TIRIYO KAH'YANA (TIRIYO, TRIO, TARONA, YAWI,P I A
N O K O TO )
212 TIRIYO TSIKUYANA (TIRIYO, TRIO, TARONA, YAWI,P I A
N O K O TO )
213 TO R A
 Integração Módulo de Regulação Página
Ambulatorial 56
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

214 TREMEMBE
215 TRUKA
216 TRUMAI
217 TSOHOM DJAPA (TSUNHUM-DJAPA)
218 TUKANO (TUCANO, YE'PA-MASA, DASEA)
219 TUMBALALA
220 T U N AYA N A
221 T U PA R I
222 TUPINAMBA
223 TUPINIQUIM
224 T U R I WA R A
225 TUXA
226 TUYUKA (TUIUCA, DOKAPUARA,
UTAPINOMAKAPHONA)
227 TXIKAO (TXICAO, IKPENG)
228 UMUTINA (OMOTINA, BARBADOS)
229 URU-EU-WAU-WAU (URUEU-UAU-UAU, URUPAIN, U R
U PA )
230 WAI WAI HIXKARYANA (HIXKARYANA)
231 WAI WAI KARAFAWYANA (KARAFAWYANA, KARAPAW
YA N A )
232 WAI WAI XEREU (XEREU)
233 WAI WAI KATUENA (KATUENA)
234 WAI WAI MAWAYANA (MAWAYANA)
235 WAIAPI (WAYAMPI, OYAMPI, WAYAPY, )
236 WAIMIRI ATROARI (KINA)
237 WANANO (UANANO, WANANA)
238 WAPIXANA (UAPIXANA, VAPIDIANA, WAPISIANA,WA P I
SHANA)
239 WAREKENA (UAREQUENA, WEREKENA)
240 WA S S U
241 WAURA (UAURA, WAUJA)
242 WAYANA (WAIANA, UAIANA)
243 WITOTO (UITOTO, HUITOTO)
244 XAKRIABA (XACRIABA)
245 XAVANTE (A'UWE, AKWE, AWEN, AKWEN)
246 XERENTE (AKWE, AWEN, AKWEN)
247 X E TA
248 XIPAIA (SHIPAYA, XIPAYA)
249 XOKLENG (SHOKLENG, XOCLENG)
250 XOKO (XOCO, CHOCO)
251 XUKURU (XUCURU)
252 XUKURU KARIRI (XUCURU-KARIRI)
253 YA I P I YA N A
254 YAMINAWA (JAMINAWA, IAMINAWA)
255 YANOMAMI NINAM (IANOMAMI, IANOAMA, XIRIANA)
256 YANOMAMI SANUMA (IANOMAMI, IANOAMA, XIRIANA)
 Integração Módulo de Regulação Página
Ambulatorial 57
Objetivo Revisão Data:
Documentação 4.2 17/09/2020
Técnica

257 YANOMAMI YANOMAM (IANOMAMI, IANOAMA,

XIRIANA)
258 YAWALAPITI (IAUALAPITI)
259 YAWANAWA (IAUANAUA)
260 YEKUANA (MAIONGON, YE'KUANA, YEKWANA, M AY O
NGONG)
261 YUDJA (JURUNA, YURUNA)
262 ZO'E (POTURU)
263 ZORO (PAGEYN)
264 ZURUAHA (SOROWAHA, SURUWAHA)