Integração Diários

Os direitos de autor deste trabalho pertencem à SPMS e a informação nele contida é confidencial.

Este trabalho não pode ser reproduzido ou divulgado, na íntegra ou em parte, a terceiros nem utilizado para outros fins que não
aqueles para que foi fornecido sem a autorização escrita prévia ou, se alguma parte do mesmo for fornecida por virtude de um
contrato com terceiros, segundo autorização expressa de acordo com esse contrato. Todos os outros direitos e marcas são
reconhecidos.

As cópias impressas não assinadas representam versões não controladas.

 Data 27 / 03 / 2017
SClínico Ref.ª SClínico_Diarios
Integração Diarios
Versão 0.2

Índice
1. Controlo do Documento 3
1.1 Histórico de Alterações 3
2. Enquadramento 3
2.1 Descrição técnica 3
3. Inserção de um diário 3
3.1 Função f_insert_diario: 4
4. Atualização de um diário 4
4.1 Função f_update_diario: 4
5. Remoção de um diário 5
5.1 Função f_delete_diario: 5
6. Validação das operações sobre os diários 6
7. Histórico das operações 7
7.1 Tabela de consulta diarios_in: 7
8. Notas finais 8

Índice de tabelas
Tabela 1 – Histórico de alterações 3
Tabela 2 – Function f_insert_diario 4
Tabela 3 – Function f_update_diario 5
Tabela 4 – Function f_delete_diario 6
Tabela 5 – Table diarios_in 8

2 de 8
SPMS – Serviços Partilhados do Ministério da Saúde, EPE
NUIMPC 509 540 716
Av. João Crisóstomo, nº 9 – 3º piso | 1049-062 Lisboa | Tel.: 213 305 075 | Fax: 213 305 060
 Data 27 / 03 / 2017
SClínico Ref.ª SClínico_Diarios
Integração Diarios
Versão 0.2

1. CONTROLO DO DOCUMENTO

1.1 HISTÓRICO DE ALTERAÇÕES

Novos
Versão Data Autor(es) Revisor(es) Alterações
desenvolvimentos
SClínico_Diarios 17 Jan 2017 Gisela Costa

SClínico_Diarios_v0.2 27 Mar 2017 Francisco Lima Criação de uma

tabela de log.
Validações da
confidencialidade
e do aditamento.
Alteração do script
para SONHO v1.
TABELA 1 – HISTÓRICO DE ALTERAÇÕES

2. ENQUADRAMENTO
Este documento descreve o desenvolvimento que possibilita a integração dos diários. Os diários podem ser
inseridos, atualizados e/ou eliminados para utilizadores cujo perfil seja médico ou enfermeiro, mediante regras de
integração bem-definidas. Dependendo da instituição, a integração pode ser válida para os seguintes módulos:
consulta externa, hospital de dia, urgência, internamento e/ou bloco operatório.

2.1 DESCRIÇÃO TÉCNICA

Para disponibilizar a informação referente aos diários é fornecido o package pk_sclinico_api_diario. Este package
contém as funções de inserção de um diário, atualização de um diário (update normal ou aditamento) e eliminação
de um diário. Também contém uma função de validação das regras de integração dos diários no SClínico, que em
caso de erro aborta a operação escolhida e reporta o erro à aplicação externa. Essa validação é automática no caso
das integrações com o SONHO v1, contudo, no caso do SONHO v2 as operações sobre os diários devem ser
precedidas pela função de validação. Para terminar, é também fornecida a tabela diarios_in. Esta tabela cria um
log daqueles que são os parâmetros enviados em cada operação e a sua consulta deve ser efectuada para
compreender qualquer tipo de erro que esteja a ocorrer no envio de informação para o SClínico.

3. INSERÇÃO DE UM DIÁRIO
Para inserir um diário novo deve ser utilizada a função f_insert_diario. Esta operação é precedida pela função de
validação, que em caso de erro aborta a operação.

3 de 8
SPMS – Serviços Partilhados do Ministério da Saúde, EPE
NUIMPC 509 540 716
Av. João Crisóstomo, nº 9 – 3º piso | 1049-062 Lisboa | Tel.: 213 305 075 | Fax: 213 305 060
 Data 27 / 03 / 2017
SClínico Ref.ª SClínico_Diarios
Integração Diarios
Versão 0.2

3.1 FUNÇÃO F_INSERT_DIARIO:

Tipo de Entrada/Saída Valores
Argumentos Descrição
dados possíveis
I_NUM_SEQUENCIAL NUMBER Número sequencial do utente Entrada 305144
I_NUM_EPISODIO NUMBER Número do episódio médico Entrada 97000002
I_MODULO VARCHAR2 Módulo do episódio Entrada ‘INT’, ‘URG’,
‘CON’, ‘HDI’,
‘BLO’
I_NUM_FUNCIONARIO NUMBER Número do funcionário Entrada 63911
I_GRUPO_FUNCIONAL NUMBER Grupo funcional do funcionário Entrada 4, 5
I_COD_ESPECIALIDADE NUMBER Especialidade do episódio Entrada 10001
I_DATA DATE Data de criação do diário Entrada 24/03/2017
I_HORA NUMBER Hora de criação do diário Entrada 50000
I_DIARIO LONG Conteúdo do diário Entrada ‘Exemplo de
diário’
I_CONFIDENCIAL VARCHAR2 Confidencialidade do diário Entrada ‘S’, ‘N’
I_PLAYER_IN VARCHAR2 Identificação do integrador Entrada ‘IUCARE’
O_ID_DIARIO NUMBER Output do ID do diário introduzido Saída -
O_ID_ERROR VARCHAR2 Output do ID de erro Saída -
O_MSG_ERROR VARCHAR2 Output da mensagem de erro Saída -
TABELA 2 – FUNCTION F_INSERT_DIARIO

4. ATUALIZAÇÃO DE UM DIÁRIO
Para atualizar um diário deve ser utilizada a função f_update_diario. A atualização do diário pode ser de dois tipos:
atualização ou aditamento. Esta operação é precedida pela função de validação, que em caso de erro aborta a
operação.

4.1 FUNÇÃO F_UPDATE_DIARIO:

Tipo de Entrada/Saída Valores
Argumentos Descrição
dados possíveis
I_NUM_SEQUENCIAL NUMBER Número sequencial do utente Entrada 305144
I_NUM_EPISODIO NUMBER Número do episódio médico Entrada 97000002
I_MODULO VARCHAR2 Módulo do episódio Entrada ‘INT’, ‘URG’,
‘CON’, ‘HDI’,
‘BLO’
I_NUM_FUNCIONARIO NUMBER Número do funcionário Entrada 63911
I_GRUPO_FUNCIONAL NUMBER Grupo funcional do funcionário Entrada 4, 5

4 de 8
SPMS – Serviços Partilhados do Ministério da Saúde, EPE
NUIMPC 509 540 716
Av. João Crisóstomo, nº 9 – 3º piso | 1049-062 Lisboa | Tel.: 213 305 075 | Fax: 213 305 060
 Data 27 / 03 / 2017
SClínico Ref.ª SClínico_Diarios
Integração Diarios
Versão 0.2

I_COD_ESPECIALIDADE NUMBER Especialidade do episódio Entrada 10001

I_DATA DATE Data de criação do diário Entrada 24/03/2017
I_HORA NUMBER Hora de criação do diário Entrada 50000
I_DATA_R DATE Data de alteração do diário Entrada 24/03/2017
I_HORA_R NUMBER Hora de alteração do diário Entrada 50000
I_DIARIO LONG Conteúdo do diário Entrada ‘Exemplo de
diário’
I_CONFIDENCIAL VARCHAR2 Confidencialidade do diário Entrada ‘S’, ‘N’
I_PLAYER_IN VARCHAR2 Identificação do integrador Entrada ‘ICUCARE’
I_ADITAMENTO VARCHAR2 Identificação do aditamento Entrada ‘S’, ‘N’
O_ID_DIARIO NUMBER Output do ID do diário introduzido Saída -
O_ID_ERROR VARCHAR2 Output do ID de erro Saída -
O_MSG_ERROR VARCHAR2 Output da mensagem de erro Saída -
TABELA 3 – FUNCTION F_UPDATE_DIARIO

5. REMOÇÃO DE UM DIÁRIO
Para eliminar um diário novo deve ser utilizada a função f_delete_diario. Esta operação é precedida pela função de
validação, que em caso de erro aborta a operação.

5.1 FUNÇÃO F_DELETE_DIARIO:

Tipo de Valores
Argumentos Descrição Entrada/Saída
dados possíveis
I_NUM_SEQUENCIAL NUMBER Número sequencial do utente Entrada 305144
I_NUM_EPISODIO NUMBER Número do episódio médico Entrada 97000002
I_MODULO VARCHAR2 Módulo do episódio Entrada ‘INT’, ‘URG’,
‘CON’, ‘HDI’,
‘BLO’
I_NUM_FUNCIONARIO NUMBER Número do funcionário Entrada 63911
I_GRUPO_FUNCIONAL NUMBER Grupo funcional do funcionário Entrada 4, 5
I_COD_ESPECIALIDADE NUMBER Especialidade do episódio Entrada 10001
I_DATA DATE Data de criação do diário Entrada 24/03/2017
I_HORA NUMBER Hora de criação do diário Entrada 50000
I_DATA_R DATE Data de alteração do diário Entrada 24/03/2017
I_HORA_R NUMBER Hora de alteração do diário Entrada 50000
I_PLAYER_IN VARCHAR2 Identificação do integrador Entrada ‘ICUCARE’
O_ID_DIARIO NUMBER Output do ID do diário introduzido Saída -

5 de 8
SPMS – Serviços Partilhados do Ministério da Saúde, EPE
NUIMPC 509 540 716
Av. João Crisóstomo, nº 9 – 3º piso | 1049-062 Lisboa | Tel.: 213 305 075 | Fax: 213 305 060
 Data 27 / 03 / 2017
SClínico Ref.ª SClínico_Diarios
Integração Diarios
Versão 0.2

O_ID_ERROR VARCHAR2 Output do ID de erro Saída -

O_MSG_ERROR VARCHAR2 Output da mensagem de erro Saída -
TABELA 4 – FUNCTION F_DELETE_DIARIO

6. VALIDAÇÃO DAS OPERAÇÕES SOBRE OS DIÁRIOS

Tal como é referido anteriormente, a execução de qualquer uma das operações é precedida por uma função de
validação. Esta função permite despistar uma série de erros comuns na integração com o SClínico, devolvendo desta
feita um output de erro que deve ser consultado na tabela triagem_in de forma a evitar erros no futuro. De seguida
são listadas as várias validações que são efectuadas por esta função, sendo as mesmas executadas por esta ordem:

1. Apenas são válidas integrações de diários para os seguintes módulos: Consulta externa (i_modulo => CON),
Hospital de dia (i_modulo => HDI), Urgência (i_modulo => URG), Internamento (i_modulo => INT);
2. Identificador do integrador deve ser sempre preenchida (i_player_in);
3. Valores válidos para i_grupo_funcional:
3.1 4 – Enfermeiro;
3.2 5 – Médico;
4. Para a operação de criação e atualização do diário, o conteúdo do diário tem de estar preenchido (i_diario não
pode ser null);
5. Valores válidos para i_confidencial:
5.1 ‘S’ – Confidêncial;
5.2 ‘N’ – Não confidêncial;
6. A data e hora do diário não pode ser nula, não pode ser superior à data atual, nem inferior à data do episódio
(i_data, i_hora);
7. Validações realizadas para a operação de criação de diário (i_tipo_operacao => 'I'):
7.1 Verifica confidencialidade do diário enviado (não pode ser enviado a null);
7.2 Não pode existir diários com a mesma data e hora, para aquele módulo e aquele episódio (i_data, i_hora);
7.3 Validações realizadas para o módulo de Urgência e Hospital de dia (i_modulo => 'URG', 'HDI'):
7.3.1 Só pode existir um diário confidêncial por episódio;
7.3.2 Um médico ou enfermeiro pode inserir um novo diário até x dias após a data de alta (número de dias
definido em sys_parametros_sc – 119);
7.4 Validações realizadas para o módulo da Consulta externa (i_modulo => 'CON'):
7.4.1 Só pode existir um diário confidêncial e um diário não confidêncial por episódio;
7.4.2 Um médico ou enfermeiro só pode criar um novo diário até a data de alta;
7.5 Validações realizadas para o módulo de (i_modulo => 'INT'):
7.5.1 Um médico ou enfermeiro só pode criar um novo diário até a data de alta;
8. Validações realizadas para a operação de atualização de um diário (i_tipo_operacao => 'U'):
8.1 Verifica confidencialidade do diário (não pode ser enviado a null);
8.2 Verifica indicação de aditamento do diário (não pode ser enviado a null);
8.3 Deve ser enviado o módulo, episódio, data e hora do diário para que o diário a atualizar seja identificado
(i_modulo, i_num_episodio, i_data, i_hora);
8.4 Se o diário possuí aditamentos fica fechado para atualizações, apenas aditamentos são permitidos;

6 de 8
SPMS – Serviços Partilhados do Ministério da Saúde, EPE
NUIMPC 509 540 716
Av. João Crisóstomo, nº 9 – 3º piso | 1049-062 Lisboa | Tel.: 213 305 075 | Fax: 213 305 060
 Data 27 / 03 / 2017
SClínico Ref.ª SClínico_Diarios
Integração Diarios
Versão 0.2

8.5 Um médico ou enfermeiro só pode atualizar um diário criado por ele, caso pretenda alterar um diário de
outro utilizador, deve realizar um aditamento;
8.6 Um médico apenas pode fazer um aditamento num diário de outro médico;
8.7 Um enfermeiro apenas pode fazer um aditamento num diário de outro enfermeiro;
8.8 Validações realizadas para o módulo de Urgência (i_modulo => 'URG'):
8.8.1 Um médico ou enfermeiro só pode editar um diário dentro do número de horas defenido pelo
parâmetro 133 (sys_parametros_sc).
8.9 Validações realizadas para o módulo da Consulta externa e Hospital de dia (i_modulo => 'CON', 'HDI'):
8.9.1 Um médico ou enfermeiro pode atualizar um diário até x dias após a data de criação (número de dias
definido em sys_parametros_sc – 119);
8.10 Validações realizadas para o módulo de internamento (i_modulo => 'INT'):
8.10.1 Um médico ou enfermeiro só pode editar um diário até x dias após a data de alta (número de dias
definido em sys_parametros_sc – 119);
9. Validações realizadas para a operação de eliminação de um diário (i_tipo_operacao => 'D'):
9.1 Deve ser enviado o módulo, episódio, data e hora do diário para que o diário a eliminar seja identificado
(i_modulo, i_num_episodio, i_data, i_hora);
9.2 Se o diário possuí aditamentos fica fechado para atualizações, apenas aditamentos são permitidos;
9.3 Um diário apenas pode ser eliminado pelo médico ou enfermeiro que o criou, para outros utilizadores
apenas aditamentos são permitidos;
9.4 Um médico ou enfermeiro pode remover um diário até x dias após a data de alta (número de dias definido
em sys_parametros_sc – 119);

7. HISTÓRICO DAS OPERAÇÕES

A nossa proposta para o interface que integra a informação de um diário registado através de aplicações externas
no workflow do SClínico passa pela utilização das diversas operações presentes no package pk_sclinico_api_diario.
No entanto, para o caso da integração com o SONHO v1 é possível consultar o histórico das operações efectuadas e
o output dessas mesmas operações através da utilização da tabela diarios_in.

7.1 TABELA DE CONSULTA DIARIOS_IN:

Tipo de Entrada/Saída Valores
Argumentos Descrição
dados possíveis
ID_DIARIO NUMBER ID do diário Saída -
NUM_SEQUENCIAL NUMBER Número sequencial do utente Entrada 305144
NUM_EPISODIO NUMBER Número do episódio médico Entrada 97000002
MODULO VARCHAR2 Módulo do episódio Entrada ‘INT’, ‘URG’,
‘CON’, ‘HDI’,
‘BLO’
NUM_FUNCIONARIO NUMBER Número do funcionário Entrada 63911
GRUPO_FUNCIONAL NUMBER Grupo funcional do funcionário Entrada 4, 5
COD_ESPECIALIDADE NUMBER Especialidade do episódio Entrada 10001
7 de 8
SPMS – Serviços Partilhados do Ministério da Saúde, EPE
NUIMPC 509 540 716
Av. João Crisóstomo, nº 9 – 3º piso | 1049-062 Lisboa | Tel.: 213 305 075 | Fax: 213 305 060
 Data 27 / 03 / 2017
SClínico Ref.ª SClínico_Diarios
Integração Diarios
Versão 0.2

DTA_DIARIO DATE Data de criação do diário Entrada 24/03/2017

HORA_DIARIO NUMBER Hora de criação do diário Entrada 50000
DTA_ALTERACAO_DIARIO DATE Data de alteração do diário Entrada 24/03/2017
HORA_ALTERACAO_DIARIO NUMBER Hora de alteração do diário Entrada 50000
CONTEUDO LONG Conteúdo do diário Entrada ‘Exemplo de
diário’
CONFIDENCIALIDADE VARCHAR2 Confidencialidade do diário Entrada ‘S’, ‘N’
INTEGRADOR VARCHAR2 Identificação do integrador Entrada ‘ICUCARE’
ADITAMENTO VARCHAR2 Identificação do aditamento Entrada ‘S’, ‘N’
OPERAÇÃO CHAR Output do operação enviada. Saída -
ESTADO VARCHAR2 Output da operação. Retorna I – Saída -
Insert, U – Update, D – Delete ou E
– Error.
ERRO VARCHAR2 Output da mensagem de erro Saída -
DTA_REGISTO DATE Output da data de registo Saída -
TABELA 5 – TABLE DIARIOS_IN

8. NOTAS FINAIS
Este package apenas deve ser disponibilizado internamente para o caso da utilização do SONHO v2. Neste caso as
funções f_insert_diario, f_update_diario e f_delete_diario não são precedidas de forma automática pela função de
validação, pelo que se não tiver em atenção este pormenor podem ser criadas inconsistências na base de dados.

8 de 8
SPMS – Serviços Partilhados do Ministério da Saúde, EPE
NUIMPC 509 540 716
Av. João Crisóstomo, nº 9 – 3º piso | 1049-062 Lisboa | Tel.: 213 305 075 | Fax: 213 305 060