Especificação Técnica ACSS

Transcrição

1 Especificação Técnica ACSS ET.ACSS 19:2010 ACSS Plataforma de Integração Receita Modelo de dados Canónico ICS DESCRITORES Informática médica; software; especificação técnica; sistema de saúde; serviço de saúde; Serviço Nacional de Saúde; documento electrónico; comunicação de dados; dados médicos; base de dados; registo de dados; sistema de informação Data de Aprovação pela ACSS ELABORAÇÃO UONCSTI EDIÇÃO Novembro de 2010 PREÇO ACSS reprodução proibida

2 Índice PREÂMBULO OBJECTIVO E CAMPO DE APLICAÇÃO REFERÊNCIAS REFERÊNCIAS LEGAIS REFERÊNCIAS BIBLIOGRÁFICAS ACRÓNIMOS, TERMOS E DEFINIÇÕES ACRÓNIMOS ESPECIFICAÇÃO DO MODELO DE DADOS ESTRUTURA DE DADOS ReceitaType CabecalhoReceitaType ListaLinhasReceitaType LinhaReceitaType MedicamentoType AnulacaoType FiltrosPesquisaType REPRESENTAÇÃO GRÁFICA ReceitaType CabecalhoReceitaType ListaLinhasReceitaType LinhaReceitaType MedicamentoType AnulacaoType FiltrosPesquisaType DEFINIÇÃO DO SCHEMA XML Página 2 de 27

3 Preâmbulo Esta especificação técnica descreve a Estrutura de Receita do Modelo de Dados Canónico da Plataforma de Integração da ACSS. As estruturas de dados integrantes do Modelo de Dados Canónico da Plataforma de Integração da ACSS estão definidas em formato XSD (definição de schema XML), e disponíveis na Gateway de Serviços da Plataforma de Integração da ACSS. Estas estruturas são usadas pelo Serviço de Registo de Prescrição de Medicamentos na Base de Dados Nacional de Prescrições. O Modelo de Dados Canónico da Receita da Plataforma de Integração da ACSS representa a estrutura da receita electrónica, que está organizada por cabeçalho e por linhas da receita, de acordo com os conteúdos da prescrição de medicamentos. O cabeçalho incorpora informação relativa a onde, por quem e a quem é prescrita uma receita, tendo em conta o local de prescrição, o profissional responsável pela prescrição e o utente a quem é prescrito. As linhas da receita representam os medicamentos prescritos, que são identificados ou pelo seu nº de embalagem (único) ou pela indicação da substância activa, fórmula farmacêutica, dosagem e tamanho da embalagem. O Modelo de Dados Canónico contempla ainda aspectos relacionados com benefícios dos utentes, quer a nível do regime especial de comparticipação do utente, quer a nível de comparticipações especial de medicamentos por patologia. O texto do projecto de especificação técnica foi submetido à apreciação da Comissão Técnica de Normalização da ACSS e foi aprovado como ET.ACSS 19:2010, em Página 3 de 27

4 1 Objectivo e campo de aplicação Esta especificação técnica tem por objectivo documentar a Estrutura de Receita do Modelo de Dados Canónico da Plataforma de Integração da ACSS. O Modelo de Dados Canónico da Plataforma de Integração da ACSS foi concebido com vista a fornecer uma linguagem comum aos sistemas de informação da ACSS que disponibilizem informação via Web Service, bem como às demais entidades que interajam com os mesmos. Esta especificação inclui a descrição e representação gráfica da estrutura de dados e a definição do schema XML Página 4 de 27

5 2 Referências Esta especificação técnica contém referências, implícitas ou explícitas, a outras publicações. Essas referências serão indicadas ao longo do texto, sendo as publicações enumeradas a seguir. Só poderão ser consideradas eventuais emendas ou revisões de publicações referidas, com indicação de data, quando incorporadas em emenda ou revisão desta especificação técnica. No caso de publicações referidas sem indicação de data, considera-se a última edição da mesma, incluindo emendas. 2.1 Referências legais Despacho nº. 3956/2010, de 4 de Março: Despacho n.º 7330/2003, de 15 de Abril; 2.2 Referências bibliográficas ACSS Plataforma de Integração Autenticação e Autorização de Serviços Página 5 de 27

6 3 Acrónimos, termos e definições 3.1 Acrónimos Sigla ACSS DTD WSDL XML Definição Administração Central do Sistema de Saúde, I.P. Data Type Definition Web Services Description Language extensible Markup Language Página 6 de 27

7 4 Especificação do modelo de dados 4.1 Estrutura de dados ReceitaType Elemento Tipo Descrição CabecalhoReceita er:cabecalhoreceitatype Cabeçalho da receita ListaLinhasReceita er:listalinhasreceitatype Items da receita FiltrosPesquisa er:filtrospesquisatype Filtros de pesquisa CabecalhoReceitaType Elemento Tipo Descrição Id Numérico Identificador interno da receita NumeroReceita Texto Número da receita NumeroLinhas Numérico Número de Linhas da Receita Renovavel Texto Se a receita é renovável (S/N) NumeroVias Numérico Número de vias da receita Data Data Data da receita ValorTotal Numérico Valor total de receita Comparticipacao Numérico Valor total de comparticipação Utente eu:utentetype Dados do utente SubsistemaResponsavel eu:entidaderesponsaveltype Subsistema responsável pela receita. Valores válidos para o domínio da EntidadeType: Código entidade: '935601', '999999', ;CodigoGenericoType: Valor do Código = 'ERES','EPUB'; Domínio do Código = 'ENRE' ou CodigoGenericoType: Valor do Código = 'ENTEST','ENPAC'; Domínio do Código = 'MIGA_INSEST' Página 7 de 27

8 Elemento Tipo Descrição RegimeComparticipacao Texto Se a receita foi prescrita com um regime de comparticipação (S/N) Profissional ep:profissionaltype Médico que prescreve a receita LocalPrescricao ee:entidadetype Local de prescrição da receita. Valores válidos para o domínio da EntidadeType: CodigoGenericoType: Valor do Código = 'LPRE'; Domínio do Código = 'USAU' Anulacao er:anulacaotype Dados da anulação Estado ec:codigogenericotype Estado da receita. Valores válidos para o CodigoGenericoType: Valor do Código = 'EM','PE','AN','DP','DI'; Domínio do Código = 'ESTR' TipoReceita ec:codigogenericotype Tipo da receita. Valores válidos para o CodigoGenericoType: Valor do Código = 'RN','MDB','MDT','MM', OUT ; Domínio do Código = 'TREC' Observacoes Texto Observações à receita ListaLinhasReceitaType Elemento Tipo Descrição LinhaReceita er:linhareceitatype Linha da receita LinhaReceitaType Elemento Tipo Descrição Id Numérico Identificador interno do item da receita NumeroLinha Numérico Número da linha da receita Medicamento er:medicamentotype Identificação do medicamento Página 8 de 27

9 Elemento Tipo Descrição SubstituivelGenerico Texto Se o medicamento é substituível por genérico (S/N) Posologia Texto Posologia do medicamento Quantidade Numérico Quantidade prescrita Diploma Texto Diploma associado ao medicamento. Decreto de Lei que permite aceder ao regime especial de comparticipação de medicamentos PrecoPVP Numérico Preço do medicamento ValorComparticipacao Numérico Valor da comparticipação DiferencaUtente Numérico (Negativo) Diferença de preço para o utente do medicamento mais barato em relação ao medicamento prescrito / (Positivo) Foi prescrito o mais barato DiferencaSNS Numérico Diferença de preço para o SNS do medicamento mais barato em relação ao medicamento prescrito Dispensa Texto Forma de dispensa do medicamento EstadoItem ec:codigogenericotype Estado do item da receita. Valores válidos para o domínio do CodigoGenericoType: 'EITR' DescricaoDispensa Texto Descriçao da forma de dispensa do medicamento Valores: 0 - DCI, 1 - MED, 2 - AIM MedicamentoType Elemento Tipo Descrição Codigo Texto Código da embalagem do medicamento. Se estiver preenchido, Tipo de prescrição = M - por medicamento Descricao Texto Descrição da embalagem do medicamento. Se estiver preenchido, Tipo de prescrição = T - texto livre Página 9 de 27

10 Elemento Tipo Descrição TitularAIM Texto Titular de Autorização de Introdução no Mercado do medicaemnto SubstanciaActiva Texto Substância activa do medicamento. Se estiver preenchido, Tipo de prescrição = S - por substância activa FormaFarmaceutica Texto Forma farmacêutica do medicamento Embalagem Texto Tipo de embalagem do medicamento Dosagem Texto Dosagem do medicamento AnulacaoType Elemento Tipo Descrição Anulado Texto Se o item da receita está anulado (S/N) DataAnulacao Data Data da Anulação MotivoAnulacao ec:codigogenericotype Motivo da Anulação. Valores válidos para o domínio do CodigoGenericoType: 'AREC' FiltrosPesquisaType Elemento Tipo Descrição DataRegistoPrescricaoDe Data Intervalo de datas de registo da prescrição para efeitos de pesquisa DataRegistoPrescricaoA Data Intervalo de datas de registo da prescrição para efeitos de pesquisa Página 10 de 27

11 4.2 Representação gráfica ReceitaType Página 11 de 27

12 4.2.2 CabecalhoReceitaType Página 12 de 27

13 4.2.3 ListaLinhasReceitaType Página 13 de 27

14 4.2.4 LinhaReceitaType Página 14 de 27

15 4.2.5 MedicamentoType Página 15 de 27

16 4.2.6 AnulacaoType Página 16 de 27

17 4.2.7 FiltrosPesquisaType Página 17 de 27

18 5 Definição do schema XML <?xml version="1.0" encoding="utf-8"?> <xsd:schema xmlns:xsd=" xmlns:er=" xmlns:ep=" xmlns:eu=" xmlns:ec=" xmlns:ee=" targetnamespace=" elementformdefault="qualified"> <xsd:import schemalocation="../201001/estruturaprofissional.xsd" namespace=" <xsd:import schemalocation="../201001/estruturautente.xsd" namespace=" <xsd:import schemalocation="../201001/estruturacodigo.xsd" namespace=" <xsd:import schemalocation="../201001/estruturaentidade.xsd" namespace=" <xsd:element name="receita" type="er:receitatype"/> <xsd:complextype name="receitatype"> Definição de receita <xsd:sequence> <xsd:element name="cabecalhoreceita" type="er:cabecalhoreceitatype" nillable="false" minoccurs="0" maxoccurs="1"> Cabeçalho da receita <xsd:element name="listalinhasreceita" type="er:listalinhasreceitatype" nillable="false" minoccurs="0" maxoccurs="1"> Items da receita <xsd:element name="filtrospesquisa" type="er:filtrospesquisatype" nillable="false" minoccurs="0" maxoccurs="1"> Filtros de pesquisa Página 18 de 27

19 </xsd:sequence> </xsd:complextype> <xsd:complextype name="cabecalhoreceitatype"> O cabeçalho da receita representa o conjunto de dados que identificam uma receita <xsd:sequence> <xsd:element name="id" type="xsd:decimal" nillable="false" minoccurs="0" maxoccurs="1"> Identificador interno da receita <xsd:element name="numeroreceita" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Número da receita <xsd:element name="numerolinhas" type="xsd:int" nillable="false" minoccurs="0" maxoccurs="1"> Número de Linhas da Receita <xsd:element name="renovavel" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Se a receita é renovável (S/N) <xsd:element name="numerovias" type="xsd:int" nillable="false" minoccurs="0" maxoccurs="1"> Número de vias da receita <xsd:element name="data" type="xsd:datetime" nillable="false" minoccurs="0" maxoccurs="1"> Página 19 de 27

20 Data da receita <xsd:element name="valortotal" type="xsd:decimal" nillable="false" minoccurs="0" maxoccurs="1"> Valor total de receita <xsd:element name="comparticipacao" type="xsd:decimal" nillable="false" minoccurs="0" maxoccurs="1"> Valor total de comparticipação <xsd:element name="utente" type="eu:utentetype" nillable="false" minoccurs="0" maxoccurs="1"> Dados do utente <xsd:element name="subsistemaresponsavel" type="eu:entidaderesponsaveltype" nillable="false" minoccurs="0" maxoccurs="1"> Subsistema responsável pela receita. Valores válidos para o domínio da EntidadeType: Código entidade: '935601', '999999', '930003';CodigoGenericoType: Valor do Código = 'ERES','EPUB'; Domínio do Código = 'ENRE' ou CodigoGenericoType: Valor do Código = 'ENTEST','ENPAC'; Domínio do Código = 'MIGA_INSEST' <xsd:element name="regimecomparticipacao" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Se a receita foi prescrita com um regime de comparticipação (S/N) <xsd:element name="profissional" type="ep:profissionaltype" nillable="false" minoccurs="0" maxoccurs="1"> Médico que prescreve a receita Página 20 de 27

21 <xsd:element name="localprescricao" type="ee:entidadetype" nillable="false" minoccurs="0" maxoccurs="1"> Local de prescrição da receita. Valores válidos para o domínio da EntidadeType: CodigoGenericoType: Valor do Código = 'LPRE'; Domínio do Código = 'USAU' <xsd:element name="anulacao" type="er:anulacaotype" nillable="false" minoccurs="0" maxoccurs="1"> Dados da anulação <xsd:element name="estado" type="ec:codigogenericotype" nillable="false" minoccurs="0" maxoccurs="1"> Estado da receita. Valores válidos para o CodigoGenericoType: Valor do Código = 'EM','PE','AN','DP','DI'; Domínio do Código = 'ESTR' <xsd:element name="tiporeceita" type="ec:codigogenericotype" nillable="false" minoccurs="0" maxoccurs="1"> Tipo da receita. Valores válidos para o CodigoGenericoType: Valor do Código = 'RN','MDB','MDT','MM','OUT'; Domínio do Código = 'TREC' <xsd:element name="observacoes" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Observações à receita </xsd:sequence> </xsd:complextype> <xsd:complextype name="listalinhasreceitatype"> Página 21 de 27

22 Lista dos items da receita <xsd:sequence> <xsd:element name="linhareceita" type="er:linhareceitatype" nillable="false" maxoccurs="4" minoccurs="0"> Linha da receita </xsd:sequence> </xsd:complextype> <xsd:complextype name="linhareceitatype"> Definição de item de receita <xsd:sequence> <xsd:element name="id" type="xsd:decimal" nillable="false" minoccurs="0" maxoccurs="1"> Identificador interno do item da receita <xsd:element name="numerolinha" type="xsd:int" nillable="false" minoccurs="0" maxoccurs="1"> Número da linha da receita <xsd:element name="medicamento" type="er:medicamentotype" nillable="false" minoccurs="0" maxoccurs="1"> Identificação do medicamento <xsd:element name="substituivelgenerico" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Se o medicamento é substituível por genérico (S/N) Página 22 de 27

23 <xsd:element name="posologia" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Posologia do medicamento <xsd:element name="quantidade" type="xsd:int" nillable="false" minoccurs="0" maxoccurs="1"> Quantidade prescrita <xsd:element name="diploma" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Diploma associado ao medicamento. Decreto de Lei que permite aceder ao regime especial de comparticipação de medicamentos <xsd:element name="precopvp" type="xsd:decimal" nillable="false" minoccurs="0" maxoccurs="1"> Preço do medicamento <xsd:element name="valorcomparticipacao" type="xsd:decimal" nillable="false" minoccurs="0" maxoccurs="1"> Valor da comparticipação <xsd:element name="diferencautente" type="xsd:decimal" nillable="false" minoccurs="0" maxoccurs="1"> (Negativo) Diferença de preço para o utente do medicamento mais barato em relação ao medicamento prescrito / (Positivo) Foi prescrito o mais barato <xsd:element name="diferencasns" type="xsd:decimal" nillable="false" minoccurs="0" maxoccurs="1"> Diferença de preço para o SNS do medicamento mais barato em relação ao medicamento prescrito Página 23 de 27

24 <xsd:element name="dispensa" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Forma de dispensa do medicamento <! DCI 1 - MED 2 - AIM--> <xsd:element name="estadoitem" type="ec:codigogenericotype" nillable="false" minoccurs="0" maxoccurs="1"> Estado do item da receita. Valores válidos para o domínio do CodigoGenericoType: 'EITR' <xsd:element name="descricaodispensa" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Descriçao da forma de dispensa do medicamento Valores: 0 - DCI, 1 - MED, 2 - AIM </xsd:sequence> </xsd:complextype> <xsd:complextype name="medicamentotype"> Definição do medicamento <xsd:sequence> <xsd:element name="codigo" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Código da embalagem do medicamento. Se estiver preenchido, Tipo de prescrição = M - por medicamento <xsd:element name="descricao" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Descrição da embalagem do medicamento. Página 24 de 27

25 Se estiver preenchido, Tipo de prescrição = T - texto livre <xsd:element name="titularaim" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Titular de Autorização de Introdução no Mercado do medicamento <xsd:element name="substanciaactiva" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Substância activa do medicamento. Se estiver preenchido, Tipo de prescrição = S - por substância activa <xsd:element name="formafarmaceutica" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Forma farmacêutica do medicamento <xsd:element name="embalagem" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Tipo de embalagem do medicamento <xsd:element name="dosagem" type="xsd:string" nillable="false" minoccurs="0" maxoccurs="1"> Dosagem do medicamento </xsd:sequence> </xsd:complextype> <xsd:complextype name="anulacaotype"> Definição de anulação da receita <xsd:sequence> <xsd:element name="anulado" nillable="false" minoccurs="0" maxoccurs="1"> Página 25 de 27

26 Se o item da receita está anulado (S/N) <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:enumeration value="s"/> <xsd:enumeration value="n"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="dataanulacao" type="xsd:datetime" nillable="false" minoccurs="0" maxoccurs="1"> Data da Anulação <xsd:element name="motivoanulacao" type="ec:codigogenericotype" nillable="false" minoccurs="0" maxoccurs="1"> Motivo da Anulação. Valores válidos para o domínio do CodigoGenericoType: 'AREC' </xsd:sequence> </xsd:complextype> <xsd:complextype name="filtrospesquisatype"> Definição dos filtros de pesquisa, para efeitos de pesquisa de receitas <xsd:sequence> <xsd:element name="dataregistoprescricaode" type="xsd:datetime" minoccurs="0" maxoccurs="1" nillable="false"> Intervalo de datas de registo da prescrição para efeitos de pesquisa <xsd:element name="dataregistoprescricaoa" type="xsd:datetime" minoccurs="0" maxoccurs="1" nillable="false"> Página 26 de 27

27 Intervalo de datas de registo da prescrição para efeitos de pesquisa </xsd:sequence> </xsd:complextype> Página 27 de 27