Prescrição Eletrónica Médica - spms.min-saude.ptspms.min-saude.pt/wp-content/uploads/2012/12/PEM... · pedido e da resposta. Exemplo do XML relativo ao elemento Security

1 de 84

SPMS Servios Partilhados do Ministrio da Sade, EPE

NUIMPC 509 540 716

Av. Joo Crisstomo, n 9 3 piso | 1049-062 Lisboa | Tel.: 213 305 075 | Fax: 213 305 060

Prescrio Eletrnica Mdica

Especificao dos Servios para integrao com o

Sistema Central de Prescries

Agosto, 2015

Verso 2.0

Os direitos de autor deste trabalho pertencem SPMS e a informao nele contida confidencial.

As cpias impressas no assinadas representam verses no controladas.

Este trabalho no pode ser reproduzido ou divulgado, na ntegra ou em parte, a terceiros nem utilizado para outros fins que no aqueles para que foi fornecido sem a autorizao escrita prvia ou, se alguma parte do mesmo for fornecida por virtude de um contrato com terceiros, segundo autorizao expressa de acordo com esse contrato. Todos os outros direitos e marcas so reconhecidos.

Especificao Tcnica dos Servios de Prescrio de Medicamentos e Produtos de sade

Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0


PLATAFORMA DE INTEGRAO DA SPMS

2015.08.06.PI_SPMS_PEM_ET

Pgina 2 de 84

Verso 1.0

Controlo do Documento

Histrico de Alteraes Verso Data Autores Revisores Alteraes Aprovao

1.0 2012-12-02 SPMS SPMS Verso inical. SPMS

1.1 2013-02-20 SPMS SPMS Exemplos XML dos elementos Cabecalho e Security. SPMS

1.2 2013-03-08 SPMS SPMS Correo nos exemplos do cabealho do XML do

pedido e da resposta.

Exemplo do XML relativo ao elemento Security.

SPMS

1.3 2013-05-07 SPMS SPMS Correes ortogrficas. Correes de incoerncia de

tipos de dados.

Correo na especificao do elemento

.

Novos erros de validao da anulao da receita.

Redefinio do elemento ().

Novos cdigos de erro: 100002027008 e

100002028015.

SPMS

1.4 2013-05-21 SPMS SPMS Introduo do cdigo de erro 100002021012. Regra

de validao do cabealho da receita j

implementada mas cdigo de erro no se encontrava

especificado.

Alterao da obrigatoriedade para S do elemento

.

SPMS

1.5 2013-07-17 SPMS SPMS Eliminao dos erros de validao (pg. 45): (a)

100002027004 (Uma Receita apenas pode ter um

medicamento por Nome Comercial); (b)

100002027008 (A prescrio de medicamentos por

nome comercial e com justificao tcnica devem ser

isolados em receita nica)

SPMS

1.6 2013-11-20 SPMS SPMS Novos erros de validao: a) 100002021013; b)

100002022006; c) 100002027008; d) 100002030005;

e) 100002021014.

Alterao e novos erros de validao: seco 5.5.

Alterao tabela Tipos de Documentos.

Alterao tabela Exemplos de entidades da EFREST

Acordos bilaterais.

Actualizao da lista de entidades financeiras do

domnio EFRPT.

Alterao das seces: a) 4.4; b) 4.6.5; c) 4.6.7.2; d)

7.13.

Alterao da imagem Fig. 24 - Estrutura

ReceitaBodyOutput.

Novo anexo: 7.13 Especialidades Mdicas.

SPMS


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 3 de 84

Verso 1.0

Alterao da tabela Tabela 46 Cdigos das

mensagens de retorno.

1.7 2013-12-19 SPMS SPMS Alterao da Tabela 53 Entidades Financeiras

EFREST, aplicveis a migrantes a abrigo de acordos

internacionais com Portugal: alterao da associao

dos tipos de documento para as entidades: a) 935618

(DEE); b) 935619 (CEDGS); c) 935620 (CEDGS); d)

935621 (CEDGS); e) 935622 (CEDGS); f) 935623

(CEDGS); g) 935624 (SDD); h) 935625 (SDD); i) 935626

(DCS); j) 935627 (SCSNS), k) 935628 (CIP); l) 935612

(PTBR13).

Alterao da Tabela 54 Tipos de documento: novos

tipos de documento: a) DCS (Declarao

Comprovativa da Situao); b) CEDGS (Credencial

Emitida pela DGS); c) DEE Declarao Emitida Pela

Embaixada); d) SCSNS (Carto de Seguro); e) SDD

(Sem documento de direito); f) CIP (Carto de

Identificao pessoal); g) PTBR13 (Formulrio - PT/BR

13).

SPMS

1.8 2015-06-23 SPMS SPMS Adequao s normas resultantes da portaria

224/2015 - Alterao da dimenso do campo

identificador do elemento ReceitaBodyOutput

SPMS

Lista de Distribuio Nome Email Responsabilidade

Fornecedores de Software de Prescrio eletrnica

Documentos Relacionados Ref Ttulo

NormasTecnicasSW_2015 Normas tcnicas relativas aos softwares de prescrio de medicamentos e produtos de

sade, SPMS


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 4 de 84

Verso 1.0

Outros Documentos Relevantes Ref. Ttulo

NormasPrescricao_2015 Normas tcnicas relativas prescrio de medicamentos e produtos de sade, INFARMED e

ACSS

ManualInfomed Manual de utilizao da base de dados de medicamentos (Infomed), INFARMED

http://www.infarmed.pt/portal/page/portal/INFARMED/MEDICAMENTOS_USO_HUMANO/PRESCRICAO_DISPENSA_E_UTILIZACAO/PRESCRICAO_ELECTRONICA_MEDICAMENTOS/Manual_Cedencia_Informacao.doc


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 5 de 84

Verso 1.0

Contedo

1 INTRODUO .......................................................................................................................... 9

1.1 OBJETIVOS ........................................................................................................................................ 9

1.2 ENQUADRAMENTO ............................................................................................................................. 9

2 ACRNIMOS, TERMOS E DEFINIES ..................................................................................... 10

2.1 ACRNIMOS.................................................................................................................................... 10

2.2 TERMOS E DEFINIES ....................................................................................................................... 10

3 MODELO DE DADOS CANNICO ............................................................................................. 12

3.1 CABEALHO DA MENSAGEM (CABECALHOTYPE) ....................................................................................... 12

Entidade (EntidadeType) .............................................................................................................. 14

Chave da Entidade (ChaveEntidadeType) ..................................................................................... 14

Cdigo Genrico (CodigoGenricoType) ......................................................................................... 14

3.2 UTENTE (UTENTETYPE) ...................................................................................................................... 15

3.3 SUBSISTEMA RESPONSVEL (ENTIDADERESPONSAVELTYPE E CARTAOTYPE) .................................................... 15

3.4 ENTIDADE (ENTIDADETYPE) ................................................................................................................ 17

3.5 REGIME ESPECIAL DE COMPARTIPAO (REGIMECOMPARTICIPACAOTYPE) ..................................................... 17

3.6 PROFISSIONAL (PROFISSIONALTYPE) ...................................................................................................... 18

3.7 CDIGO (CODIGOTYPE) ..................................................................................................................... 18

3.8 ANULAO (ANULACAOTYPE) ............................................................................................................. 19

3.9 MEDICAMENTO (MEDICAMENTOTYPE) .................................................................................................. 19

3.10 DIPLOMAS (DIPLOMASTYPE E DIPLOMATYPE) ......................................................................................... 20

3.11 PRESTAO (PRESTACAOTYPE) ............................................................................................................ 21

3.12 FORMATO DAS DATAS ........................................................................................................................ 22

4 SERVIOS DE REGISTO DE PRESCRIO DE MEDICAMENTOS ................................................... 23

4.1 SERVIO DE REGISTO DE PRESCRIES MATERIALIZADAS ............................................................................ 23

Operao online .......................................................................................................................... 23

Operao offline .......................................................................................................................... 24

Especificao tcnica do servio ................................................................................................... 25

4.2 SERVIO DE REGISTO DE PRESCRIES DESMATERIALIZADAS RECEITA SEM PAPEL ........................................... 36

Operao online .......................................................................................................................... 37

Especificao tcnica do servio ................................................................................................... 37

Estruturas de Dados de Entrada ................................................................................................... 38

Estruturas de Dados de Sada ....................................................................................................... 48

Mensagens de Retorno ................................................................................................................ 51

Codigo Matriz - QR Code .............................................................................................................. 56

4.3 REGRAS DOS SERVIOS ....................................................................................................................... 57

Nmero da Receita ...................................................................................................................... 57


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 6 de 84

Verso 1.0

Local de Prescrio ...................................................................................................................... 57

Prescritor ..................................................................................................................................... 57

Utente ......................................................................................................................................... 58

Regime Comparticipao Especial de Medicamentos.................................................................... 58

Entidade Financeira Responsvel ................................................................................................. 59

Linha da Receita de Medicamentos .............................................................................................. 59

Cdigos de Acesso e Dispensa e Cdigo de Direito de Opo ........................................................ 60

Anulao da receita de Medicamentos ......................................................................................... 60

Recomendaes aos Softwares de Prescrio ............................................................................... 61

5 SERVIO DE CONSULTA DE PRESCRIES DE MEDICAMENTOS ................................................ 62

5.1 REQUISITOS OPERACIONAIS ................................................................................................................. 62

5.2 OPERAES PESQUISA ....................................................................................................................... 62

5.3 ESPECIFICAO TCNICA DO SERVIO .................................................................................................... 62

Estrutura de dados de entrada ..................................................................................................... 63

Estrutura de dados de sada ......................................................................................................... 64

5.4 REGRAS E VALIDAES ....................................................................................................................... 71

5.5 MENSAGENS DE RETORNO .................................................................................................................. 73

6 SEGURANA NOS SERVIOS ................................................................................................... 75

7 ANEXOS ................................................................................................................................ 76

7.1 ESTADO DA RECEITA .......................................................................................................................... 76

7.2 TIPO DE RECEITA .............................................................................................................................. 76

7.3 TIPO DE LINHA DA RECEITA ................................................................................................................. 77

7.4 ANULAO DE RECEITA ...................................................................................................................... 77

7.5 DOMNIOS DE ENTIDADES ................................................................................................................... 77

7.6 ENTIDADES FINANCEIRAS DO DOMNIO EFRPT ........................................................................................ 78

7.7 ENTIDADES FINANCEIRAS DO DOMNIO EFREST EXEMPLOS DE ENTIDADES APLICVEIS A CIDADOS MIGRANTES DO

ESPAO EUROPEU (CARTO EUROPEU SEGURO DE DOENA) .......................................................................................... 79

7.8 ENTIDADES FINANCEIRAS DO DOMNIO EFREST, APLICVEIS A MIGRANTES AO ABRIGO DE ACORDOS INTERNACIONAIS

COM PORTUGAL .................................................................................................................................................. 79

7.9 TIPOS DE DOCUMENTOS ..................................................................................................................... 80

7.10 ORDENS DE PROFISSIONAIS ................................................................................................................. 80

7.11 EXCEES ....................................................................................................................................... 80

7.12 BENEFCIOS ..................................................................................................................................... 81

7.13 PRODUTOS DIETTICOS ...................................................................................................................... 81

7.14 ESPECIALIDADES MDICAS .................................................................................................................. 81

7.15 EXEMPLOS DE XML .......................................................................................................................... 83


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 7 de 84

Verso 1.0

ndice de tabelas

1 - Acrnimos ........................................................................................................................................................ 10 2 - Termos e definies ......................................................................................................................................... 11 Tabela 3 CabecalhoType .................................................................................................................................... 13 Tabela 4 - EntidadeType ........................................................................................................................................ 14 Tabela 5 - ChaveEntidadeType .............................................................................................................................. 14 Tabela 6 CodigoGenericoType ........................................................................................................................... 14 Tabela 7 - UtenteType ........................................................................................................................................... 15 Tabela 8 - EntidadeResponsavelType .................................................................................................................... 16 Tabela 9 CartoType .......................................................................................................................................... 16 Tabela 10 EntidadeType ..................................................................................................................................... 17 Tabela 11 RegimeComparticipacaoType ............................................................................................................ 17 Especialidade do Profissional. Consultar Circular Normativa n.35 de 2011 - ACSS, relativamente classificao de Especialidade Mdica (1 nvel Lista de Categorias) (cf Tabela 12 Lista de especialidades mdicas) ........ 18 Tabela 13 ProfissionalType................................................................................................................................. 18 Tabela 14 - CodigoType ......................................................................................................................................... 19 Tabela 15 - AnulacaoType ..................................................................................................................................... 19 Tabela 16 MedicamentoType ............................................................................................................................. 20 Tabela 17 - DiplomasType ..................................................................................................................................... 20 Tabela 18 - DiplomaType ...................................................................................................................................... 21 Tabela 19 PrestacaoType ................................................................................................................................... 21 Tabela 20 - RegistoPrescricaoMedicamentosProcessRequestType ...................................................................... 25 Tabela 21 - RegistoPrescricaoMedicamentosMessageBody ................................................................................. 26 Tabela 22 - ReceitaType ........................................................................................................................................ 26 Tabela 23 ReceitaType ....................................................................................................................................... 26 Tabela 24 - CabecalhoReceitaType ....................................................................................................................... 28 Tabela 25 - ListaLinhaReceitaType ........................................................................................................................ 29 Tabela 26 - ListaLinhaReceitaType ........................................................................................................................ 30 Tabela 27 - RegistoPrescricaoMedicamentosProcessResponseType.................................................................... 30 Tabela 28 - RegistoPrescricaoMedicamentosMessageBodyOutput ..................................................................... 30 Tabela 29 - ReceitasBodyOutput ........................................................................................................................... 31 Tabela 30 - ReceitaBodyOutput ............................................................................................................................ 32 Tabela 31 - Resultados .......................................................................................................................................... 32 Tabela 32 Resultado ........................................................................................................................................... 32 Tabela 33 Mensagens de retorno ...................................................................................................................... 32 Tabela 34 - Cdigo das mensagens de retorno ..................................................................................................... 36 Tabela 35 - RegistoPrescricaoMedicamentosProcessRequestType ...................................................................... 38 Tabela 36 - RegistoPrescricaoMedicamentosMessageBody ................................................................................. 38 Tabela 37 ReceitaType ....................................................................................................................................... 39 Tabela 38 - CabecalhoReceitaType ....................................................................................................................... 42 Tabela 39 - SignatureType ..................................................................................................................................... 43 Tabela 40 - SignedInfoType ................................................................................................................................... 44 Tabela 41 - ReferenceType.................................................................................................................................... 44 Tabela 42 - KeyInfoType ........................................................................................................................................ 45 Tabela 43 - X509DataType .................................................................................................................................... 46 Tabela 44 - ListaLinhaReceitaType ........................................................................................................................ 46 Tabela 45 - ListaLinhaReceitaType ........................................................................................................................ 48 Tabela 46 - RegistoPrescricaoMedicamentosProcessResponseType.................................................................... 48 Tabela 47 - RegistoPrescricaoMedicamentosMessageBodyOutput ..................................................................... 49 Tabela 48 - ReceitasBodyOutput ........................................................................................................................... 49 Tabela 49 ReceitaBodyOutput ........................................................................................................................... 50 Tabela 50 - LinhasReceitaBodyOutput .................................................................................................................. 50


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 8 de 84

Verso 1.0

Tabela 51 - LinhaReceita ....................................................................................................................................... 51 Tabela 52 - Resultados .......................................................................................................................................... 51 Tabela 53 - Resultado ............................................................................................................................................ 51 Tabela 54 Mensagens de retorno ...................................................................................................................... 51 Tabela 55 - Cdigo das mensagens de retorno ..................................................................................................... 55 Tabela 56 - ConsultaHistPrescicaoRequestType ................................................................................................... 63 Tabela 57 ConsultaHistPrescricaoCorpoType .................................................................................................... 64 Tabela 58 - Utente................................................................................................................................................. 64 Tabela 59 ConsultaHistPrescricaoResponse ....................................................................................................... 64 Tabela 60 Corpo ................................................................................................................................................. 65 Tabela 61 - ListaMensagensType .......................................................................................................................... 65 Tabela 62 Receita ............................................................................................................................................... 65 Tabela 63 ReceitaType ....................................................................................................................................... 66 Tabela 64 - CabecalhoReceitaType ....................................................................................................................... 68 Tabela 65 - ListaLinhaReceitaType ........................................................................................................................ 69 Tabela 66 - ListaLinhaReceitaType ........................................................................................................................ 70 Tabela 67 - PrestacaoType .................................................................................................................................... 71 Tabela 68 Tipos de Pesquisas ............................................................................................................................. 73 Tabela 69 Mensagens de retorno ...................................................................................................................... 73 Tabela 70 Cdigos das mensagens de retorno ................................................................................................... 74 Tabela 71 - Estados da Receita .............................................................................................................................. 76 Tabela 72 - Tipos de receita .................................................................................................................................. 76 Tabela 73 - Tipos de receita .................................................................................................................................. 77 Tabela 74 - Motivos de anulao da receita de medicamentos ........................................................................... 77 Tabela 75- Domnios de entidades ........................................................................................................................ 78 Tabela 76 - Lista da EFRPT ..................................................................................................................................... 78 Tabela 77 Exemplos de entidades da EFREST Espao Europeu ....................................................................... 79 Tabela 78 Entidades Financeiras EFREST, aplicveis a migrantes a abrigo de acordos internacionais com Portugal. .............................................................................................................................................................................. 79 Tabela 79 Tipos de documento. ......................................................................................................................... 80 Tabela 80 - Ordens de Profissionais ...................................................................................................................... 80 Tabela 81 - Excees ............................................................................................................................................. 81 Tabela 82 - Benefcios ........................................................................................................................................... 81 Tabela 83 Lista de especialidades mdicas. ....................................................................................................... 83 Tabela 84 - Exemplo de um XML do elemento Cabecalho de um web-service request. ...................................... 84 Tabela 85 - Exemplo de um XML do elemento Cabecalho de um web-service response. .................................... 84 Tabela 86 - Exemplo de um XML do elemento Security. ...................................................................................... 84


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 9 de 84

Verso 1.0

1 Introduo

1.1 Objetivos

O presente documento tem como objetivo a especificao tcnica dos servios de prescrio para

integrao com as aplicaes de prescrio de medicamentos e produtos de sade, tendo em conta a

sua adaptao aos novos requisitos da Lei n11/2012 de 8 de Maro, da Portaria 224/2015 de 27 de

julho e do despacho n. 11254/2013 que estabelece o regime jurdico a que obedecem as novas regras

de prescrio de medicamentos, e que define uma nova abordagem prescrio de medicamentos:

por DCI, por via eletrnica e sustentada por normas de orientao clnica.

Este documento deve ser lido conjuntamente com o documento Normas tcnicas relativas aos

softwares de prescrio de medicamentos e produtos de sade, NormasTecnicasSW_2015, para

que se estabeleam requisitos completos relativos aos softwares de prescrio.

1.2 Enquadramento

Este documento especifica o interface com o sistema central de prescries disponibilizado na

Plataforma de Integrao da SPMS, a utilizar pelos Softwares de prescrio para integrao como

sistema central de prescries. A integrao tem de ser efetuada em modo Online, de carater

obrigatrio. A utilizao do modo offline s dever ser utilizado nas situaes excecionais por falha do

sistema. As receitas emitidas em modo offline no so consideradas receitas eletrnicas.

O documento comea por definir o modelo de dados cannico utilizado nos servios de prescrio, e

de seguida descreve os servios de prescrio disponveis:

Servio de Registo da receita de medicamentos

o Operao Online

o Operao offline

Servio de Registo da receita de medicamentos Receita Sem Papel

o Operao Online

Servio de Consulta de Prescries de Medicamentos

Em anexo encontram-se os domnios de valores utilizados neste modelo de comunicao.


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 10 de 84

Verso 1.0

2 Acrnimos, termos e definies

2.1 Acrnimos

Sigla Definio

AIM Autorizao de Introduo no Mercado

BDNP Base de Dados Nacional de Prescries

CCF Centro de Conferncia de Faturas

DCI Denominao comum internacional

GH Grupo homogneo

PMU Preo mdio unitrio

PVP Preo de venda ao pblico

PVSNS Valor da comparticipao do SNS

PVU Valor pago pelo utente

RG Regime geral

EFR Entidade Financeira Responsvel

RNU Registo Nacional de Utentes

CNPRP Centro Nacional de Proteo Riscos Profissionais

RECM Regime Especial de Comparticipao de Medicamentos

RSP Receita Sem Papel

1 - Acrnimos

2.2 Termos e Definies

Termo Definio

Entidade Especificao de uma unidade orgnica, associada prestao de cuidados de

sade. Esta entidade poder ter vrios atributos associados.

Profissional de sade Pessoa legalmente habilitada a prescrever, dispensar ou administrar

medicamentos, designadamente, mdicos, mdicos dentistas, mdicos

veterinrios, odontologistas ou farmacuticos;

Este profissional poder ter vrios atributos associados.

Utente Especificao de uma pessoa que usufrui dos servios do SNS. Este utente poder

ter vrios atributos associados.

Receita Especificao de uma receita de medicamentos.


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 11 de 84

Verso 1.0

Termo Definio

Local de

prescrio

Estabelecimento de sade ou outro centro de responsabilidade onde so

prestados cuidados de sade a utentes

Nmero do utente Nmero nacional que identifica univocamente o utente nos Servios de Sade,

garantido pelo RNU.

Prescritor Prestador de cuidados de sade habilitado a prescrever medicamentos

Entidade financeira

responsvel

Entidade responsvel pelo pagamento dos encargos decorrentes da prestao de

cuidados de sade a um utente.

2 - Termos e definies


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 12 de 84

Verso 1.0

3 Modelo de Dados Cannico

Neste captulo so descritas as estruturas do modelo de dados da Plataforma de Integrao da SPMS

que se aplicam no mbito da prescrio de Medicamentos, e referenciadas e reutilizadas nos servios

de prescrio, designadamente:

Cabecalho da Mensagem.

Utente;

Profissional;

Entidade;

3.1 Cabealho da Mensagem (CabecalhoType)

Todos os servios disponibilizados pela SPMS possuem um segmento de cabealho que nos pedidos e

respostas dos mesmos. Este cabealho utilizado para a transferncia de informao de auditoria e

controlo dos pedidos, tais como origens e destinos da mensagem, identificadores, operao invocada.

Fig. 1 - Estrutura CabecalhoType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 13 de 84

Verso 1.0

Elemento Descrio Tipo

De Entidade Origem do Pedido EntidadeType

Para Entidade destino do Pedido EntidadeType

Principal

Indicao se a mensagem principal ou secundria. Considera-se principal um pedido iniciador e principal de um processo de negcio, secundria uma invocao utilizada na execuo dum processo de negcio.

Texto (10)

Tipo Tipo da Mensagem CodigoGenericoType

Operacao Operao a invocar CodigoGenericoType

EnviadoEm Data do Envio da mensagem DateTime

ActivadoEm Data em que a mensagem foi ativada DateTime

ChavePedido Chave nica identificadora da mensagem Texto (40)

ChavePedidoRelacionado Chave nica identificadora da mensagem originria da mensagem atual

Texto (40)

Tabela 3 CabecalhoType

Nos servios de Dispensa referidos neste documento deve ser considerado a utilizao dos seguintes

campos deste segmento:

Enviado Em Data de envio da mensagem

Activado Em Data do processamento da mensagem (Timestamp da mensagem)

Chave Pedido Chave nica do pedido

Chave Pedido Relacionado (Caso aplicvel) Chave nica do pedido que deu origem

mensagem actual (Resposta)

Todos os restantes campos so de preenchimento facultativo at indicao contrria.


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 14 de 84

Verso 1.0

Entidade (EntidadeType)

Fig. 2 - Estrutura EntidadeType


Chave Chave identificadora da entidade int:ChaveEntidadeType

Tipo Tipo da Entidade int:CodigoGenericoType

Nome Nome da Entidade Texto (50)

Tabela 4 - EntidadeType

Chave da Entidade (ChaveEntidadeType)


Id Identificador da Chave Texto (20)

Cifra Cdigo da Chave int:CodigoGenericoType

Tabela 5 - ChaveEntidadeType

Cdigo Genrico (CodigoGenricoType)


Codigo Cdigo Genrico Texto (50)

Descricao Descrio do Cdigo Genrico Texto (100)

Tabela 6 CodigoGenericoType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 15 de 84

Verso 1.0

3.2 Utente (UtenteType)

Fig. 3 - Estrutura UtenteType

Campo Descrio Tipo Obrigatrio

NumeroSNS Numero SNS do Utente Numrico (9) N

NomeCompleto Nome completo do Utente Texto (160) N

DataNascimento Data de Nascimento do Utente DateTime N

Sexo Sexo do Utente (M-Masc; F-Fem) Texto (1) N

PaisNaturalidade Pas de onde o Utente Natural, cf norma ISO 3166-1, alpha 2,

Texto (2) N

PaisNacionalidade Nacionalidade do Utente, cf norma ISO 3166-1, alpha 2,

Texto (2) N

Contacto Contacto telefnico do utente Texto (20) N

Tabela 7 - UtenteType

3.3 Subsistema Responsvel (EntidadeResponsavelType e CartaoType)


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 16 de 84

Verso 1.0

Fig. 4 - Estrutura EntidadeResponsavelType


Entidade Estrutura de dados que carateriza a Entidade responsvel pelo utente

EntidadeType S

NumeroBeneficiario Nmero de beneficirio do utente que o identifica perante a entidade financeira responsvel

Texto (20) S

DataEmissao Data emisso do carto de beneficirio / Documento de direito

DateTime N

DataValidade Data de validade do carto de beneficirio / documento de direito

DateTime N

DataInicio Data de inicio de validade do carto de beneficirio/ documento de direito

DateTime N

Cartao Estrutura de dados que carateriza o documento de direito do utente,aplicvel a utentes migrantes

CartaoType N

Tabela 8 - EntidadeResponsavelType


Numero Nmero do documento de direito Texto (20) N

Tipo Tipo de Documento de Direito. Ver Tabela 79 Tipos de documento. .

Texto (50) N

Pais Pas emissor do Documento de Direito, cf norma ISO 3166-1, alpha 2,

Texto (2) N

Tabela 9 CartoType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 17 de 84

Verso 1.0

3.4 Entidade (EntidadeType)

Fig. 5 - Estrutura EntidadeType


Codigo

Cdigo da Entidade Financeira Responsvel pela comparticipao de medicamentos (cf Tabela 76 - Lista da EFRPT; Tabela 77 Exemplos de entidades da EFREST Espao Europeu)

Texto (50) S

Designacao Designao da entidade Financeira Texto (400) N

DominioEntidade Identificao do Domnio da Entidade (cf Tabela 75- Domnios de entidades)

Texto (20) N

PaisEntidade Pas da Entidade, cf norma ISO 3166-1, alpha 2, Texto (2) N

Tabela 10 EntidadeType

3.5 Regime Especial de Compartipao (RegimeComparticipacaoType)

Fig. 6 - Estrutura ListaLinhaReceitaType


Tipo

Tipo do Regime de Comparticipao de Medicamentos (R RECM para pensionistas; O Outros regimes especiais)

Texto (1) S

Codigo Cdigo do Regime de Comparticipao (cf Tabela 82 - Benefcios)

Texto (10) S

Tabela 11 RegimeComparticipacaoType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 18 de 84

Verso 1.0

3.6 Profissional (ProfissionalType)

Fig. 7 - Estrutura ProfissionalType


NumCedula Nmero da cdula Profissional Numrico (10)

S

Ordem Cdigo da Ordem do Profissional (cf Tabela 80 - Ordens de Profissionais)

Texto (2) S

NomeClinico Nome Clinico do Profissional Texto (40) N

Especialidade

Especialidade do Profissional. Consultar Circular Normativa n.35 de 2011 - ACSS, relativamente classificao de Especialidade Mdica (1 nvel Lista de Categorias) (cf Tabela 12 Lista de especialidades mdicas)

CodigoType N

Contacto Contacto do Profissional Texto (30) N

Tabela 13 ProfissionalType

3.7 Cdigo (CodigoType)

Fig. 8 - Estrutura CodigoType


ID Identificador do Cdigo Inteiro N


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 19 de 84

Verso 1.0


Codigo Cdigo Texto (50) N

Descricao Descrio do cdigo Texto (400) N

Tabela 14 - CodigoType

3.8 Anulao (AnulacaoType)

Fig. 9 - Estrutura AnulacaoType


Anulado Indica se a receita anulada ou no (S/N) Texto (1) S

DataAnulacao Data da anulao da receita DateTime N

MotivoAnulacao Motivo da anulao da receita, (ver Tabela 74 - Motivos de anulao da receita de medicamentos)

Texto (50) N

Tabela 15 - AnulacaoType

3.9 Medicamento (MedicamentoType)

Fig. 10 - Estrutura MedicamentoType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 20 de 84

Verso 1.0


CN_PEM Cdigo Nacional de Prescrio de Medicamentos por DCI, cf informao constante base de dados do Infarmed

Nmero(8) N

NumRegisto N de registo da embalagem de medicamentos atribudo pelo Infarmed (atributo EMB.N_REGISTO)

Nmerico (10) N

Descricao Nome do medicamento/produto quando prescrito em texto livre (Manipulados, Dietticos, alergnios,outros produtos)

Texto (400) N

SubstanciaActiva

Substncia ativa do Medicamento, cf informao constante na tabela DCIPT da base de dados do Infarmed (atributo DCIPT. DCIPT_ID)

Nmero(4) N

FormaFarmaceutica

Forma farmacutica do medicamento, cf informao constante na tabela FORM_FARM da base de dados do Infarmed (atributo FORM_FARM. FORM_FARM_ID)

Nmero(4) N

Embalagem Caraterizao de Embalagem do Medicamento, cf informao constante na tabela EMB da base de dados do Infarmed (atributo EMB.DESCR)

Texto (400) N

Dosagem Dosagem do medicamento, cf informao constante na tabela MED da base de dados do Infarmed (atributo MED.dosagem)

Texto (30) N

Tabela 16 MedicamentoType

3.10 Diplomas (DiplomasType e DiplomaType)

Fig. 11 - Estrutura DiplomasType


Diploma

Diploma legal que confere comparticipao especial a esse medicamento cf informao constante na tabela DIPLOMA da base de dados do Infarmed

DiplomaType N

Tabela 17 - DiplomasType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 21 de 84

Verso 1.0


Codigo Cdigo do Diploma Texto(5) N

Diploma Descritivo do diploma legal Texto(400) N

Tabela 18 - DiplomaType

3.11 Prestao (PrestacaoType)

Fig. 12 - Estrutura PrestacaoType


Medicamento

Estrutura de dados com a caraterizao do Medicamento que foi Dispensado na farmcia (aplicvel caso dispensa eletrnica)

MedicamentoType N

Farmacia Estrutura de dados com a identificao da Farmcia onde a prestao foi efetuada

EntidadeType N

DataPrestacao Data da prestao DateTime N

Preco_PVP Preo de venda ao pblico do Medicamento Dispensado em cntimos.

Numrico(9) N

Comparticipacao Taxa de Comparticipao do SNS do Medicamento Dispensado

Numrico(3) N

Tabela 19 PrestacaoType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 22 de 84

Verso 1.0

3.12 Formato das datas

Todos os itens que representam datas so do tipo DateTime, isto , incluem Horas, Minutos e Segundos

e respeitam o modelo W3 de XML para o formato DateTime. Recomenda-se que seja enviado o Tempo

Universal Coordenado (UTC) com o respectivo fuso horrio (Time zone).

O formato de qualquer parmetro ou campo que represente uma data YYYY-MM-DDThh:mm:ss em

que:

YYYY representa o ano;

MM representa o ms;

DD representa o dia;

T o separador entre a parte que representa a data e a que representa a hora;

hh representa a hora no formato 24h;

mm representa o minuto;

ss representa o segundo;

Exemplos:

1. 2011-01-21T13:49:48+00:00

2. 2012-04-02T21:24:23-01:00 (caso do Arquiplago dos Aores)


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 23 de 84

Verso 1.0

4 Servios de Registo de Prescrio de Medicamentos

Este captulo especificam tecnicamente os servios de registo da receita de medicamentos

disponibilizados pela Plataforma de Integrao da SPMS.

Estes servios so responsveis pelo seguinte:

validao dos elementos da receita, nomeadamente prescritor, local de prescrio, utente e

respetivos benefcios e outros elementos da receita;

garantir a conformidade da receita com as regras de prescrio;

registo da receita de medicamentos no sistema central de prescries;

registo da anulao da receita no sistema centra de prescries, quando preenchidos os

elementos da anulao.

A integrao com este servio dever ser efetuada no modo online, antes da emisso da receita, dado

que o nmero da receita e respetivos cdigos de acesso para dispensa na farmcia so devolvidos

como resposta, em caso de sucesso e devero ser impressos na receita, no caso da receita

materializada, e respetivo Guia de Tratamento.

4.1 Servio de Registo de Prescries Materializadas

Neste captulo so apresentadas as operaes que o servio de registo de prescries disponibiliza.

Operao online

Operao que depreende que a chamada ao servio feita no instante em que o mdico pretende

emitir a receita. A aplicao invoca o servio e espera pela resposta para emitir a receita de

medicamentos, garantindo que a mesma validada e registada no sistema central de prescries.

Neste caso devolvido como resposta o n nico da receita, gerado centralmente, e os cdigos de

acesso e dispensa e de direito de opo para dispensa eletrnica na farmcia.

No pedido dever ser tomado em considerao que os seguintes campos no devem ser preenchidos,

excepto na situao de se tratar de uma anulao, porque vo ser devolvidos pelo sistema central:

O Nmero de Receita

O campo Data da Receita


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 24 de 84

Verso 1.0

No pedido dever ser tomado em considerao que os seguintes campos, apesar de no serem

obrigatrios no modelo de dados cannico, devem ser enviados:

O Nmero de Receita Local: Este idenficador dever ser nico por receita renovvel ou no

renovvel.

Na resposta deve ser tomado em considerao que vo ser devolvidos os seguintes campos a utilizar

na impresso do Guia de Tratamento:

Nmero da Receita

Data da Receita

Cdigo de Acesso e Dispensa da Receita

Cdigo do Direito de Opo do Utente sobre a Receita

Operao offline

Operao a invocar para receitas em que, no momento da sua prescrio, existe uma falncia tcnica

do sistema: o sistema central no se encontra disponvel ou falha de comunicaes. Esta operao ter

o mesmo comportamento que a Online, no entanto no gerado nem devolvida informao de

Numero de Receita e dos cdigos de acesso e dispensa e de direito de opo, que so de

responsabilidade exclusiva do processo Online.

As receitas geradas neste modo no so consideradas receitas eletrnicas.

Na invocao desta operao devero ser preenchidos os campos:

Nmero de Receita Dever ser enviado o nmero da receita gerado a nvel local segundo as

normas definidas para o campo, e que foi impresso na receita e Guia Teraputico;

Nmero de Receita Local Dever ser enviado o nmero da receita local (identificador local

da receita). No mtodo offline este identificador dever ser nico por receita e por cada via;

Data da Receita Dever ser colocada a data e hora local na altura da emisso da Receita, e

que foi impresso na receita;

Na resposta no sero devolvidos os cdigos de acesso para dispensa eletrnica, nomeadamente o

Cdigo de acesso e dispensa e de direito de opo, pois estes perdem o seu objetivo depois de

impresso o Guia Teraputico:


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 25 de 84

Verso 1.0

Especificao tcnica do servio

Esta seco visa apresentar as caractersticas do servio em causa, os parmetros de entrada e sada,

o tipo de dados e restries. indicado tambm os resultados possveis, tanto os resultados de sucesso

como os resultados de erro.

Estruturas de Dados de Entrada

4.1.3.1.1 RegistoPrescricaoMedicamentosProcessRequestType

Fig. 13 - Estrutura RegistoPrescricaoMedicamentosProcessRequestType

Esta estrutura de dados de dados representa o modelo de dados da uma receita de medicamentos,

dividida em duas reas:

Cabealho da receita: contm informao sobre a origem da receita, o local de prescrio, o

prescritor responsvel pela emisso da receita, o utente ao qual a receita foi prescrita e

informao adicional de caracterizao da receita

Linhas da receita: contm informao sobre os medicamentos prescritos

Elemento Tipo Descrio

Cabecalho int:CabecalhoType

Cabealho do Pedido.

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 3 CabecalhoType)

Corpo rpm:RegistoPrescricaoMedicamentosMessageBody Corpo do Pedido

Tabela 20 - RegistoPrescricaoMedicamentosProcessRequestType

4.1.3.1.2 RegistoPrescricaoMedicamentosMessageBody

Fig. 14 - Estrutura RegistoPrescricaoMedicamentosMessageBody


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 26 de 84

Verso 1.0


Receitas rpm:ListaReceitasBody Lista de Receitas a Registar

Tabela 21 - RegistoPrescricaoMedicamentosMessageBody


Receita er:ReceitaType Receitas a Registar

Tabela 22 - ReceitaType

4.1.3.1.3 ReceitaType





informao adicional de caracterizao da receita;

Linhas da receita; contm informao sobre os medicamentos prescritos.

Fig. 15 - Estrutura ReceitaType


CabecalhoReceita er:CabecalhoReceitaType Informao do cabealho da receita registar.

ListaLinhasReceita er:ListaLinhasReceitaType Informao das linhas de receita registar.

Tabela 23 ReceitaType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 27 de 84

Verso 1.0

4.1.3.1.4 CabecalhoReceitaType

Fig. 16 - Estrutura CabecalhoReceitaType

Elemento Tipo Descrio Obrigatrio

Id Numrico Identificador interno.

Este elemento no deve ser usado. N

NumeroReceita Texto (20) Numero da receita N

NumeroReceitaLocal Texto (19) Numero da receita local S

Renovavel Texto (1) Indicao se a receita renovvel S

NumeroVias Numrico (1) Numero de vias da receita S


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 28 de 84

Verso 1.0


Data DateTime Data da receita N

Utente eu:UtenteType

Informao do utente

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 7 - UtenteType)

S

SubsistemaResponsavel er:EntidadeResponsavelType

Informao do subsistema responsvel

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 8 - EntidadeResponsavelType)

S

RegimeComparticipao RegimeComparticipacaoType

Regime de comparticipao

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 11 RegimeComparticipacaoType)

S

Profissional ep:ProfissionalType

Informao do mdico prescritor

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 12 ProfissionalType)

S

LocalPrescricao ee:EntidadeType

Informao do local de prescrio

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 10 EntidadeType)

S

Anulacao er:AnulacaoType

Informao sobre a anulao da receita

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 14 - AnulacaoType)

N

Estado Estado da Receita Texto (2) N

TipoReceita Tipo da receita Texto (3) S

Tabela 24 - CabecalhoReceitaType

4.1.3.1.5 ListaLinhasReceitaType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 29 de 84

Verso 1.0



LinhaReceitaType Conjunto de Linhas da Receita LinhaReceitaType N

Tabela 25 - ListaLinhaReceitaType

4.1.3.1.6 LinhaReceitaType

Fig. 18 - Estrutura LinhaReceitaType

Campo Tipo Descrio Obrigatrio

NumeroLinha Nmerico (2) Nmero da Linha da receita S

Medicamento

MedicamentoType Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 15 MedicamentoType)

Estrutura de dados que carateriza o Medicamento ou produto prescrito

S

Posologia Texto (500) Posologia relacionada com o medicamento

N

Quantidade Nmerico (1) Quantidade prescrita do medicamento

S

Diplomas

DiplomasType Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 16 - DiplomasType)

Lista de Diplomas legais que confere comparticipao especial a esse medicamento, cf informao constante na tabela DIPLOMA da base de dados do Infarmed

N


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 30 de 84

Verso 1.0

Campo Tipo Descrio Obrigatrio

Excecao Texto (1)

Identificador da Exceo, na situao de prescrio por nome comercial com obrigatoriedade de justificao tcnica. Ver Tabela 81 - Excees.

N


Estruturas de Dados de Sada

4.1.3.2.1 RegistoPrescricaoMedicamentosProcessResponseType

Fig. 19 - Estrutura RegistoPrescricaoMedicamentosProcessResponseType


Cabecalho int:CabecalhoType Cabealho da Resposta.

Corpo rpm:RegistoPrescricaoMedicamentosMessageBodyOutput Corpo da Resposta

Tabela 27 - RegistoPrescricaoMedicamentosProcessResponseType

4.1.3.2.2 RegistoPrescricaoMedicamentosMessageBodyOutput

Fig. 20 - Estrutura RegistoPrescricaoMedicamentosMessageBodyOutput


Receitas rpm:ReceitasBodyOutput Lista de Receitas de Resposta

Tabela 28 - RegistoPrescricaoMedicamentosMessageBodyOutput

4.1.3.2.3 ReceitasBodyOutput


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 31 de 84

Verso 1.0


Receita rpm:ReceitaBodyOutput Informao do resultado do processamento de Receitas

Tabela 29 - ReceitasBodyOutput

4.1.3.2.4 ReceitaBodyOutput

Fig. 21 - Estrutura ReceitaBodyOutput


Identificador Texto (100) Identificador nico da Receita

NumeroReceitaLocal Texto (20) Identificador interno da Receita originado pela aplicao origem

NumeroReceita Texto (19) Nmero nico da Receita gerado pelo sistema central

PinReceita Texto (20) Cdigo de acesso para utilizao no mbito da dispensa

PinDireitoOpcao Texto (20) Cdigo do Direito de Opo do Utente no mbito da dispensa

DataReceita DateTime Data da Receita gerada centralmente

NumVia Numrico (1) Nmero da Via no caso de ser uma receita renovvel

Resultados Resultados Conjunto de mensagens de resultado


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 32 de 84

Verso 1.0

Tabela 30 - ReceitaBodyOutput

Resultados


Resultado Resultado Informao de 1 resultado do processamento

Tabela 31 - Resultados

4.1.3.3.1 Resultado


Codigo Texto (50) Cdigo do Resultado.

Descricao Texto (400) Descrio do Resultado

Segmento Texto (20) Zona da Mensagem a que o resultado diz respeito. Ex.: Receita, Cabecalho, Linha 1, etc

Tabela 32 Resultado

Mensagens de Retorno

O servio de Registo de Prescries de Medicamentos retorna 3 tipos de mensagens:

Tipo Ao

Sucesso Receita registada/anulada com sucesso

Erro Erro tcnico na validao da receita

No Conforme Aceita a receita e devolve cdigo de cdigo/informao incorreta ou insuficiente

Tabela 33 Mensagens de retorno

Verificando-se a mensagem de retorno Sucesso, a mesma contm o nmero da receita enviada, os

Cdigos, e a data a utilizar no guia de tratamento.

Com o cdigo de erro, no Cabecalho: ChavePedido retornado um identificador do pedido de registo

no sistema central de prescries (GUID) que deve ser usado posteriormente, para identificao do

mesmo.

As mensagens devolvidas pelo servio e respetivos cdigos so as seguintes:


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 33 de 84

Verso 1.0

Cdigo Descrio Tipo

100002010001 Receita registada com sucesso Sucesso

100002010002 Receita anulada com sucesso Sucesso

Mensagens referentes a Cabealho

100002021001 Nmero da receita duplicado No Conforme

100002021002 Nmero da receita duplicado com local de prescrio distinto No Conforme

100002021003 Nmero da receita local duplicado No Conforme

100002021004 Nmero de receita invlido No Conforme

100002021005 Receita renovvel e nmero de vias invlido No Conforme

100002021006 Tipo de prescrio invlida No Conforme

100002021007 Regime de Comparticipao Invlido No Conforme

100002021008 Utente no tem identificado no RNU o Regime de Comparticipao aplicado na receita

No Conforme

100002021009 Data da Receita invlida (aplicvel ao envio das receitas em modo offline)

No Conforme

100002021010 Indicao de Receita Renovvel invlida No Conforme

100002021011 Nmero de vias invlido No Conforme

100002021012 Nmero de receita local de preenchimento obrigatrio No Conforme

100002021013 O nmero de receita no pode ser enviado no mtodo online No Conforme

100002021014 Cdigo do pas invlido. No Conforme

100002021015 Tipo de prescrio no suportado pelo servio No Conforme

Mensagens referentes a Utente

100002022001 Utente no encontrado No Conforme

100002022002 Mais do que um Utente encontrado No Conforme

100002022003 Erro na Informao do Utente No Conforme

100002022004 Nmero de Utente Invlido No Conforme

100002022005 Utente Falecido No Conforme


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 34 de 84

Verso 1.0

Cdigo Descrio Tipo

100002022006 Entidade Responsvel obriga ao preenchimento do Numero SNS do Utente

No Conforme

Mensagens referentes a Subsistema Responsvel

100002023001 A entidade responsvel no existente, de acordo com tabela fornecida

No Conforme

100002023002 Nmero de Beneficirio obrigatrio para esta entidade No Conforme

100002023003 Dados insuficientes para carto CESD No Conforme

100002023004 Nmero de Beneficirio Invlido No Conforme

100002023005 Informao do Documento de direito de preenchimento obrigatrio para a entidade responsvel

No Conforme

100002023006 A entidade Responsvel identificada no est abrangida pelo documento de direito

No Conforme

100002023007 Nmero de documento de direito obrigatrio para a entidade responsvel

No Conforme

Mensagens referentes a Prescritor

100002024001 O mdico no est identificado na Plataforma Central No Conforme

100002024002 Profissional no est preenchido No Conforme

100002024003 Erro na Informao do Profissional No Conforme

100002024004 Especialidade Medica Invlida, de acordo com a normativa publicada pela ACSS

No Conforme

100002024005 Especialidade do prescritor no lhe permite aplicar a legislao utilizada

No Conforme

Mensagens referentes a Local Prescrio

100002025001 O local de prescrio no est identificado na Plataforma Central

No Conforme

100002025002 Local de prescrio no est preenchido No Conforme

100002025003 Erro na Informao do Local de Prescrio No Conforme

100002025004 O local de prescrio no est autorizado a prescrever Medicamentos Dietticos.

No Conforme

Mensagens referentes a Anulao


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 35 de 84

Verso 1.0

Cdigo Descrio Tipo

100002026001 A Receita no pode ser anulada - Nmero da receita ainda no existe

No Conforme

100002026002 A Receita no pode ser anulada - ultrapassou o prazo de 30 dias

No Conforme

100002026003 A Receita no pode ser anulada - mdico diferente No Conforme

100002026004 A Receita no pode ser anulada - motivo de anulao no existe

No Conforme

100002026005 A Receita no pode ser anulada - j se encontra anulada No Conforme

100002026006 A Receita no pode ser anulada - o utente diferente No Conforme

100002026007 A Receita no pode ser anulada - no existe indicao de anulao

No Conforme

100002026008 Motivo de anulao no est preenchido No Conforme

100002026009 A Receita no pode ser anulada - j se encontra dispensada No Conforme

100002026010 A Receita no pode ser anulada - data de anulao invlida No Conforme

Mensagens referentes a Linhas

100002027001 Quantidade invlida ou no verifica regras de prescrio por receita/linha

No Conforme

100002027002 Receita Renovvel com medicamentos sem ser de longa durao

No Conforme

100002027003 Tipo de Receita Invlido para o(s) medicamento(s) prescritos No Conforme

100002027006 No possvel ter vrias linhas com o mesmo Medicamento No Conforme

100002027007 O Nmero de Linhas Invlido No Conforme

100002027008 Diploma duplicado na mesma linha do medicamento. No Conforme

Mensagens referentes a Medicamentos

100002028001 N de registo de medicamento no existente / cdigo CNPEM no existente

No Conforme

100002028002 Substncia ativa no existe No Conforme

100002028003 Forma teraputica no existe No Conforme

100002028004 Os dados do medicamento no esto corretos No Conforme


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 36 de 84

Verso 1.0

Cdigo Descrio Tipo

100002028005 Legislao no aplicvel, de acordo com a tabela DIPLOMA do Infarmed

No Conforme

100002028006 Erro na Informao do Medicamento No Conforme

100002028007 Prescrio por nome comercial invlida No Conforme

100002028008 Exceo invlida, de acordo com as justificaes tcnicas possveis

No Conforme

100002028009 Medicamento no pertence lista de medicamentos com margem ou ndice teraputico estreito publicada pelo INFARMED

No Conforme

100002028010 Medicamento Unidose s pode ser prescrito por Nome Comercial

No Conforme

100002028011 O Medicamento no pode ser prescrito em receita renovvel No Conforme

100002028012 Medicamento no pode ser prescrito em Receita Especial No Conforme

100002028013 Prescrio por DCI requer o envio de caractersticas do Medicamento

No Conforme

100002028014 Caractersticas do Medicamento invlidas para DCI prescrito No Conforme

100002028015 A prescrio por DCI no requer justificao tcnica No Conforme

Mensagens referentes a questes Tcnicas

100002029098 Erro Desconhecido No Conforme

100002029099 Erro de No Conformidade com as Regras de Prescrio No Conforme

100002030001 Operao no autorizada Erro

100002030002 Erro Tcnico Erro

100002030003 Autenticao Invlida Erro

100002030004 Entidade sem permisses para invocar o servio Erro

100002030005 Estrutura da mensagem incorreta Erro

Tabela 34 - Cdigo das mensagens de retorno

4.2 Servio de Registo de Prescries Desmaterializadas Receita Sem

Papel

Neste captulo so apresentadas as operaes que o servio disponibiliza.


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 37 de 84

Verso 1.0

Operao online

O servio de registo de prescries desmaterializadas apenas disponibiliza este tipo de operao. Este

tipo de operao depreende que a chamada ao servio feita no instante em que o mdico pretende

emitir a receita. A aplicao invoca o servio e espera pela resposta para emitir o Guia de Tratamento,

garantindo que a receita validada e registada no sistema central de prescries. Neste caso

devolvido como resposta o n nico da receita, gerado centralmente, e os cdigos de acesso e dispensa

e de direito de opo para dispensa eletrnica na farmcia na situao de comparticipao pelo SNS.

No pedido dever ser tomado em considerao que os seguintes campos no devem ser preenchidos,

excepto na situao de se tratar de uma anulao, porque vo ser devolvidos pelo sistema central:

O Nmero de Receita

O campo Data da Receita

No pedido dever ser tomado em considerao que os seguintes campos, apesar de no serem

obrigatrios no modelo de dados cannico, devem ser enviados:

O Nmero de Receita Local: Este idenficador dever ser nico por receita.

Na resposta deve ser tomado em considerao que vo ser devolvidos os seguintes campos a utilizar

no Guia de Tratamento:

Nmero da Receita;

Data da Receita;

Cdigo de Acesso e Dispensa da receita;

Cdigo do Direito de Opo do Utente sobre a Receita;

Cdigos Matriz para permitir a dispensa offline de receitas.

Especificao tcnica do servio

Esta seco visa apresentar as caractersticas do servio em causa, os parmetros de entrada e sada,

o tipo de dados e restries. indicado tambm os resultados possveis, tanto os resultados de sucesso

como os resultados de erro.


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 38 de 84

Verso 1.0

Estruturas de Dados de Entrada

RegistoPrescricaoMedicamentosRSPProcessRequestType

Fig. 22 - Estrutura RegistoPrescricaoMedicamentosRSPProcessRequestType


Cabecalho int:CabecalhoType Cabealho do Pedido.

Corpo rpm:RegistoPrescricaoMedicamentosMessageBody Corpo do Pedido

Tabela 35 - RegistoPrescricaoMedicamentosProcessRequestType

RegistoPrescricaoMedicamentosMessageBody

Fig. 23 - Estrutura RegistoPrescricaoMedicamentosMessageBody


Receitas rpm:ListaReceitasBody Lista de Receitas a Registar

Tabela 36 - RegistoPrescricaoMedicamentosMessageBody

ReceitaType





informao adicional de caracterizao da receita;

Linhas da receita: contm informao sobre os medicamentos prescritos.


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 39 de 84

Verso 1.0



CabecalhoReceita er:CabecalhoReceitaType Informao do cabealho da receita registar.

ListaLinhasReceita er:ListaLinhasReceitaType Informao das linhas de receita registar.

Signature ds:SignatureType Informao refere assinatura digital a registar.

Tabela 37 ReceitaType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 40 de 84

Verso 1.0

CabecalhoReceitaType


Elemento Descrio Tipo Obrigatoriedade

Id Identificador da Receita

Identificador interno.

Este elemento no deve ser usado.

N

NumeroReceita Nmero da receita Numero da receita N


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 41 de 84

Verso 1.0


NumeroReceitaLocal Nmero da receita atribudo pelo sistema de prescrio

Numero da receita local S

Renovavel Indica se a receita renovvel (S/N)

Indicao se a receita renovvel

S

NumeroVias Nmero de vias da receita Numero de vias da receita S

Data Data de emisso da receita Data da receita S

Utente Dados do utente

Informao do utente

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 7 - UtenteType)

S

SubsistemaResponsavel Subsistema responsvel pela receita

Informao do subsistema responsvel

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 8 - EntidadeResponsavelType)

S

RegimeComparticipacao

Conjunto de Regimes Especiais de Comparticipacao de Medicamentos

Regime de comparticipao

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 11 RegimeComparticipacaoType)

S

Profissional Mdico que prescreve a receita

Informao do mdico prescritor

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 12 ProfissionalType)

S

LocalPrescricao Local de prescrio da receita

Informao do local de prescrio

Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 10 EntidadeType)

S

Anulacao Dados da anulao Informao sobre a anulao da receita

S


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 42 de 84

Verso 1.0


Para mais informao da estrutura consultar Modelo de Dados Cannico associado (Tabela 14 - AnulacaoType)

Estado Estado da Receita Texto (2) N

TipoReceita Tipo da receita Texto (3) S

QCert Base64Binary

Informao do certificado adicional

Este elemento no deve ser usado.

N

Tabela 38 - CabecalhoReceitaType

SignatureType

Neste subcaptulo apenas elencada a informao obrigatria a preencher e a enviar para os servios

centrais.

Fig. 26 - Estrutura SignatureType


SignedInfo SignedInfoType Estrutura que contm o algoritmo de normalizao, o algoritmo da assinatura e uma ou mais referncias

S


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 43 de 84

Verso 1.0


SignatureValue Texto Elemento que contem o valor da assinatura Digital codigicado em Base64

S

KeyInfo KeyInfoType Estrutura que contem os certificados que permitem validar a assinatura

S

Tabela 39 - SignatureType

SignedInfoType

Fig. 27 - Estrutura SignedInfoType


CanonicalizationMethod XMLElement

Elemento que contm o algoritmo de normalizao no atributo Algorithm. O valor a enviar neste atributo poder ser por exemplo "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"

S

SignatureMethod XMLElement

Elemento que contm o algoritmo da assinatura no atributo Algorithm. O valor a enviar neste atributo poder ser por exemplo: " http://www.w3.org/2000/09/xmldsig#rsa-sha1"

S


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 44 de 84

Verso 1.0


Reference ReferenceType Estrutura onde especificado o algoritmo de digest usado e o valor, do documento a assinar.

S

Tabela 40 - SignedInfoType

ReferenceType

Fig. 28 - Estrutura ReferenceType


DigestMethod XMLElement

Elemento que contm o algoritmo da funo hash que ser utilizado no documento XML da receita a ser assinado. O valor a enviar neste atributo poder ser por exemplo: " http://www.w3.org/2000/09/xmldsig#sha1"

S

DigestValue Texto Resultado da funo de hash do documento XML da Receita em Base64

S

Tabela 41 - ReferenceType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 45 de 84

Verso 1.0

KeyInfoType

Fig. 29 - Estrutura KeyInfoType


X509Data X509Data

Elemento que contem uma lista ordenada dos certificados usados para validar a receita. Na primeira posio (0) enviado o certificado pblico que contm a chave pblica da assinatura. Na segunda posio (1) enviado o certificado SubCA do certificado de chave pblica (Presente tanto no Carto do Cidado como na cdula Profissional da Ordem dos Mdicos).

S

Tabela 42 - KeyInfoType


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 46 de 84

Verso 1.0

X509Data

Fig. 30 - Estrutura X509DataType


X509Certificate Certificado codificado em Base64 Texto S

Tabela 43 - X509DataType

ListaLinhasReceitaType



LinhaReceitaType Conjunto de Linhas da Receita LinhaReceitaType N



Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 47 de 84

Verso 1.0

LinhaReceitaType

Fig. 32 - Estrutura LinhaReceitaType


NumeroLinha Nmerico (2) Nmero da Linha da receita S

Medicamento

MedicamentoType

Estrutura de dados que carateriza o Medicamento ou produto prescrito.

Para mais informao da estrutura consultar Modelo de Dados Cannico associado.

S

Posologia Texto (500) Posologia relacionada com o medicamento N

Quantidade Nmerico (1) Quantidade prescrita do medicamento S

Diplomas DiplomasType

Lista de Diplomas legais que confere comparticipao especial a esse medicamento, cf informao constante na tabela DIPLOMA da base de dados do Infarmed

Para mais informao da estrutura consultar Modelo de Dados Cannico associado.

N


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 48 de 84

Verso 1.0


Excecao Texto (1)

Identificador da Exceo, na situao de prescrio por nome comercial com obrigatoriedade de justificao tcnica (cf Tabela 81 - Excees)

N

LinhaRenovavel Texto (1) Indicao se o medicamento se destina a tratamento prolongado (S/N)

S

EstadoLinha Texto (2) Identificao do estado da linha.

No deve ser utilizado. N

TipoLinhaMedicamento Texto (4) Tipo de prescrio da linha da receita (cf Tabela 72 - Motivos de anulao da receita de medicamentos)

S

QRPresc Base64

Cdigo matriz

Ver subcaptulo 4.2.6 referente explicao do cdigo matriz QRPresc

N


Estruturas de Dados de Sada

RegistoPrescricaoMedicamentosRSPProcessResponseType

Fig. 33 - Estrutura RegistoPrescricaoMedicamentosRSPProcessResponseType


Cabecalho int:CabecalhoType Cabealho da Resposta.

Corpo rpm:RegistoPrescricaoMedicamentosMessageBodyOutput Corpo da Resposta

Tabela 46 - RegistoPrescricaoMedicamentosProcessResponseType

RegistoPrescricaoMedicamentosMessageBodyOutput

Fig. 34 - Estrutura RegistoPrescricaoMedicamentosMessageBodyOutput


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0




Pgina 49 de 84

Verso 1.0


Receitas rpm:ReceitasBodyOutput Lista de Receitas de Resposta

Tabela 47 - RegistoPrescricaoMedicamentosMessageBodyOutput

ReceitasBodyOutput


Receita rpm:ReceitaBodyOutput Informao do resultado do processamento de Receitas

Tabela 48 - ReceitasBodyOutput

ReceitaBodyOutput

Fig. 35 - Estrutura ReceitaBodyOutput


Identificador Texto (130) Identificador nico da Receita

NumeroReceitaLocal Texto (20) Identificador interno da Receita originado pela aplicao origem

NumeroReceita Texto (19) Nmero nico da Receita gerado pelo sistema central


Data:

Ref.

Verso:

06-08-2015

PI_SPMS_PEM_ET

2.0



2015.08.06.PI_SPMS_PE

Documents

Prescrição Eletrónica Médica - spms.min-saude.ptspms.min-saude.pt/wp-content/uploads/2012/12/PEM... · pedido e da resposta. Exemplo do XML relativo ao elemento Security