Especificação Técnica Serviços de Prestação

Transcrição

1 Especificaçã Técnica Serviçs de Prestaçã Este trabalh nã pde ser reprduzid u divulgad, na íntegra u em parte, a terceirs nem utilizad para utrs fins que nã aqueles para que fi frnecid sem a autrizaçã escrita prévia u, se alguma parte d mesm fr frnecida pr virtude de um cntrat cm terceirs, segund autrizaçã expressa de acrd cm esse cntrat. Tds s utrs direits e marcas sã recnhecids. Os direits de autr deste trabalh pertencem à SPMS e a infrmaçã nele cntida é cnfidencial. As cópias impressas nã assinadas representam versões nã cntrladas.

2 Históric de alterações Cntrl d dcument Versã Data Autres Revisres Alterações Aprvaçã SPMS Versã inicial SPMS SPMS Passagem d cnsentiment para cabeçalh da requisiçã. Isençã taxa passu para item da requisiçã. Mudança ds critéris de pesquisa d serviç Pesquisa Prestaçã SPMS Adiçã d nv serviç anula prestaçã. Remçã ds serviçs cativaçã e reagendament. Alteraçã ds XSDs ds serviçs de prestaçã. Adiçã de camp brigatóri a serviç pesquisa prestaçã SPMS Adiçã de restriçã ns serviçs de agendament, efetivaçã e pesquisa prestaçã (durante perid transitóri). Adiçã d serviç cnsulta agendaments cancelads. Remçã d serviç Regist de Resultads SPMS Retirada referência a camp ChavePedidRelacinad cm send um camp brigatóri n request ds serviçs. Crreçã d tip de dads CnsultaAgendamentsCanceladsInputType (adiçã d camp DataInici ). Crreções relativas a us d camp EntidadeSNS ns serviçs de agendament e efetivaçã. Refrç d us ds critéris n serviç de pesquisa de prestaçã (sã mutuamente exclusivs mas pel mens um deve ser usad). Identificad retrn d tken n serviç de efectivaçã cm cndicinal (retrnad apenas n cas de sucess). SPMS Adicinad capítul cm descriçã d cnteúd d QR Cde para interpretaçã pels sistemas. SPMS SPMS SPMS SPMS SPMS 2 de 90

3 Lista de distribuiçã Nme Respnsabilidade Dcuments relacinads Refª Títul Outrs dcuments relevantes Ref. Títul 3 de 90

4 Cnteúd 1 Intrduçã Objetiv Enquadrament Acrónims, terms e definições Acrónims Terms e definições Mdel de dads canónic Mdel de dads canónic - Prestaçã Mdel de dads canónic - Pesquisa Mdel de dads canónic - Anulaçã Mdel de dads canónic - CnsultaAgendamentsCancelads Estruturas CabecalhType ListaPrestacaMSPInputType PrestacaMSPOutputType MSPPesquisaInputType MSPPesquisaOutputType MSPAnulacaPrestacaInputType MSPAnulacaPrestacaOutputType CnsultaAgendamentsCanceladsInputType CnsultaAgendamentsCanceladsOutputType Frmat das datas Serviç de recusa Parâmetrs de entrada Parâmetrs de saída Mensagens de retrn d serviç de recusa Serviç de agendament Parâmetrs de entrada Parâmetrs de saída Mensagens de retrn d serviç de agendament Serviç de efectivaçã Parâmetrs de entrada Parâmetrs de saída Mensagens de retrn d serviç de efectivaçã Serviç de pesquisa prestaçã de 90

5 7.1 Parâmetrs de entrada Parâmetrs de saída Mensagens de retrn d serviç de pesquisa prestaçã Serviç de anulaçã de prestaçã Parâmetrs de entrada Parâmetrs de saída Mensagens de retrn d serviç de anulaçã de prestações Serviç de cnsulta de agendaments cancelads Parâmetrs de entrada Parâmetrs de saída Mensagens de retrn d serviç de cnsulta de agendaments cancelads QR Cdes Cmpsiçã d QR Cde Prcess de leitura d QR Cde Exempl de códig para interpretaçã d QR Cde Anexs Dmínis de entidades Entidades financeiras d dmíni EFRPT Entidades financeiras d dmíni EFREST exempls de entidades aplicáveis a cidadãs migrantes d espaç eurpeu (Cartã Eurpeu Segur de Dença) Entidades financeiras d dmíni EFREST, aplicáveis a migrantes a abrig de acrds internacinais cm Prtugal Estads pssíveis assciads a um MCDT Lateralidades assciadas a um MCDT Prduts assciads a um MCDT Mtivs de anulaçã de um MCDT/Requisiçã de 90

6 1 Intrduçã 1.1 Objetiv O presente dcument tem cm bjetiv a especificaçã técnica ds serviçs de prestaçã para integraçã cm as aplicações de prestaçã de Meis Cmplementares de Diagnóstic e Terapêutica (MCDT). 1.2 Enquadrament Este dcument especifica a interface cm sistema central de prestações de MCDT dispnibilizad na Platafrma de Integraçã da SPMS, a utilizar pels sftwares de prestaçã para integraçã cm sistema central de prestações. O dcument cmeça pr definir mdel de dads canónic utilizad ns serviçs de prestaçã, e de seguida, descreve s serviçs de prestaçã dispníveis: Recusa - Recusa de um MCDT pr parte de uma entidade prestadra SNS; Agendament Agendament (u cancelament de agendament) de um u mais MCDT; Efetivaçã Efetivaçã de um MCDT agendad; Cnsulta Agendaments Cancelads Cnsulta de cancelament de agendaments para uma entidade. Pesquisa prestaçã Cnsulta da infrmaçã de uma requisiçã e respectivs MCDT. Anula prestaçã Anula uma prestaçã de um u mais MCDT. Em anex encntram-se s dmínis de valres utilizads neste mdel de cmunicaçã. 6 de 90

7 2 Acrónims, terms e definições 2.1 Acrónims Sigla BDNR EFR MCDT RNU SOAP SNS XSD XML Definiçã Base de Dads Nacinal de Requisições Entidade Financeira Respnsável Meis Cmplementares de Diagnóstic e Terapêutica Regist Nacinal de Utentes Simple Object Access Prtcl Sistema Nacinal de Saúde XML Schema Definitin extensible Markup Language Tabela 1 Descriçã de acrónims. 7 de 90

8 2.2 Terms e definições Term Entidade Definiçã Especificaçã de uma unidade rgânica, assciada à prestaçã de cuidads de saúde. Esta entidade pderá ter váris atributs assciads. Pessa legalmente habilitada a prescrever, dispensar u administrar medicaments, Prfissinal de saúde designadamente, médics, médics dentistas, médics veterináris, dntlgistas u farmacêutics; Este prfissinal pderá ter váris atributs assciads. Utente Requisiçã MCDT Lcal de prescriçã Lcal de prestaçã Númer d utente Prescritr Entidade financeira respnsável Entidade prestadra SNS Entidade prestadra cnvencinada Especificaçã de uma pessa que usufrui ds serviçs d SNS. Este utente pderá ter váris atributs assciads. Cnjunt de MCDT assciads a um utente. Meis cmplementares de diagnóstic e terapêutica. Estabeleciment de saúde u utr centr de respnsabilidade nde sã prestads cuidads de saúde a utentes. Estabeleciment de saúde u utr centr de respnsabilidade nde sã efetivads s MCDT. Númer nacinal que identifica univcamente utente ns Serviçs de Saúde, garantid pel RNU. Prestadr de cuidads de saúde habilitad a prescrever requisições de MCDT. Entidade respnsável pel pagament ds encargs decrrentes da prestaçã de cuidads de saúde a um utente. Prestadr de cuidads de saúde d SNS. Prestadr de cuidads de saúde privad que, em articulaçã cm SNS, celebra cntrat de adesã cm bjetiv de prestaçã de cuidads de saúde. Tabela 2 Descriçã ds terms e definições. 8 de 90

9 3 Mdel de dads canónic Neste capítul sã descritas as estruturas d mdel de dads da platafrma de integraçã da SPMS que se aplicam n âmbit da prestaçã e pesquisa de MCDT. A frma de preenchiment destas estruturas depende d serviç a invcar, nã só a nível d cnteúd ds camps, mas também relativamente à sua brigatriedade. Cnsante serviç, um determinad camp pderá ser cnsiderad cm: S camp brigatóri N camp nã brigatóri C cndicinal (quand a sua brigatriedade depende de utr camp) N/A nã aplicável (quand camp nã é cnsiderad para a execuçã d serviç). 3.1 Mdel de dads canónic - Prestaçã Os serviçs referentes à prestaçã seguem uma estrutura SOAP genérica e cmum, tant a nível d input cm d utput ds serviçs. A prestaçã de MCDT é efetuada após a fase de prescriçã, e tem iníci cm a necessidade de Agendar um MCDT, para realizar numa instituiçã d SNS u num prestadr cnvencinad. Os prestadres cnvencinads pderã agendar um MCDT que se encntre num estad Aguarda cativaçã (ACA), enquant que s prestadres d SNS pderã agendar um MCDT quand este se encntra num estad Aguarda agendament (AAG). Quand MCDT fr agendad ele passa para estad Agendad. Após Agendament é pssível Reagendament u a Efetivaçã de MCDT, estad n qual MCDT ficará até ser dispnibilizad Regist de resultads. Os serviçs de prestaçã sã definids pelas seguintes estruturas: Cabecalh estrutura que englba s dads técnics d pedid efetuad, cm pr exempl a atribuiçã de chaves identificativas à mensagem enviada. Crp estrutura que cntém tds s elements específics, de input u de utput, relativ as serviçs de prestaçã. 9 de 90

10 Mensagem de input: Fig. 1- Element de input ds serviçs de Prestaçã. Mensagem de utput: Fig. 2 - Element de utput ds serviçs de Prestaçã. 3.2 Mdel de dads canónic - Pesquisa O mdel canónic cnstruíd para s serviçs referentes à pesquisa de requisições/mcdt seguem uma estrutura semelhante à ds serviçs de prestaçã na medida em que, tant n input cm n utput, a mensagem é cnstituída pr um element Cabecalh e pr um element Crp : Cabecalh estrutura que englba s dads técnics d pedid efetuad, cm pr exempl a atribuiçã de chaves identificativas à mensagem enviada. Crp estrutura que cntém tds elements específics, de input u de utput, relativ as serviçs de pesquisa de prestaçã. Mensagem de input: Fig. 3 - Element de input d serviç de pesquisa. 10 de 90

11 Mensagem de utput: Fig. 4 - Element de utput d serviç de pesquisa. 3.3 Mdel de dads canónic - Anulaçã O mdel canónic cnstruíd para s serviçs referentes à anulaçã de prestações seguem uma estrutura semelhante à ds serviçs de prestaçã na medida em que, tant n input cm n utput, a mensagem é cnstituída pr um element Cabecalh e pr um element Crp : Cabecalh estrutura que englba s dads técnics d pedid efetuad, cm pr exempl a atribuiçã de chaves identificativas à mensagem enviada. Crp estrutura que cntém tds elements específics, de input u de utput, relativ as serviçs de anulaçã de prestaçã. Mensagem de input: Fig. 5 - Element de input d serviç de anulaçã. Mensagem de utput: 11 de 90

12 Fig. 6 - Element de utput d serviç de anulaçã. 3.4 Mdel de dads canónic - CnsultaAgendamentsCancelads O mdel canónic cnstruíd para s serviçs referentes à cnsulta de agendaments cancelads seguem uma estrutura semelhante à ds serviçs de prestaçã na medida em que, tant n input cm n utput, a mensagem é cnstituída pr um element Cabecalh e pr um element Crp : Cabecalh estrutura que englba s dads técnics d pedid efetuad, cm pr exempl a atribuiçã de chaves identificativas à mensagem enviada. Crp estrutura que cntém tds elements específics, de input u de utput, relativ a serviç de cnsulta de agendaments cancelads. Mensagem de input: Fig. 7 - Element de input d serviç de cnsulta. Mensagem de utput: Fig. 8 - Element de utput d serviç de cnsulta. 3.5 Estruturas 12 de 90

13 Nas secções seguintes serã descritas tdas as estruturas utilizadas ns mdels de dads canónics cnstruíds CabecalhType O element Cabecalh, d tip CabecalhType, encntra-se presente em tds s pedids e respstas ds serviçs de prestaçã e é utilizad para questões de auditria e cntrl de pedid. Nas próximas secções deste capítul serã descrits s tips que cmpõem esta estrutura. CabecalhType Fig. 5 Estrutura CabecalhType. Element Descriçã Tip Ocrrência De Para Identifica a entidade que realiza pedid Entidades a que se destinam s serviçs EntidadeType 0-1 EntidadeType 0-N 13 de 90

14 Element Descriçã Tip Ocrrência Principal Principal Text 0-1 Tip Tip de mensagem enviada CdigGenericType 0-1 Operaca Tip de peraçã a efetuar CdigGenericType 0-1 EnviadEm Data de invcaçã d serviç Datetime 1 ActivadEm Data de ativaçã da mensagem Datetime 1 ChavePedid ChavePedidRelacinad Chave identificativa d pedid efetuad a serviç Chave de pedid relacinad d pedid efetuad a serviç Text 1 Text 0-1 Tabela 3 CabecalhType. Ns serviçs de prestaçã referids neste dcument deve ser cnsiderada, de caráter brigatóri, a utilizaçã ds seguintes camps deste segment: EnviadEm: data de envi da mensagem; ActivadEm: data d prcessament da mensagem (timestamp da mensagem); ChavePedid: chave única d pedid; EntidadeType Fig. 6- Estrutura EntidadeType. 14 de 90

15 Element Descriçã Tip Ocrrência Chave Chave para identificaçã da entidade ChaveEntidadeType 0-1 Tip Tip de entidade CdigGenericType 0-1 Nme Nme de entidade Text 0-1 Tabela 4 EntidadeType. ChaveEntidadeType Element Descriçã Tip Ocrrência Id Id da entidade Text 1 Cifra Cifra da entidade CdigGenericType 1 Tabela 5 ChaveEntidadeType. CdigGenericType Fig. 7- Estrutura CdigGenericType. Element Descriçã Tip Ocrrência Cdig Códig Text 1 Descrica Descriçã d códig Text 0-1 Tabela 6 CdigGenericType. 15 de 90

16 3.5.2 ListaPrestacaMSPInputType O element Crp da mensagem de input ds serviçs, d tip ListaPrestacaMSPInputType, é cnstituíd pels elements identificads nas seguintes tabelas: ListaPrestacaMSPInputType Fig. 16- Estrutura ListaPrestacaMSPInputType. Element Descriçã Tip Ocrrência CabecalhRequisica EntidadePrestadra Prfissinal ListaMCDTPrestaca MCDTsAdicinais Element cm s dads referentes a uma requisiçã Element cm s dads referentes à entidade prestadra Estrutura crrespndente as dads d médic respnsável pela peraçã realizada sbre MCDT Lista de elements cm infrmaçã referente a um u mais MCDT Element cm s dads referentes a MCDT adicinais n mment da efetivaçã CabecalhRequisicaPrestacaType 0-1 EntidadeType 0-1 PrfissinalType 0-1 ListaMCDTPrestacaType 1 MCDTsAdicinaisType 0-1 Tabela 15 ListaPrestacaMSPInputType. 16 de 90

17 CabecalhRequisicaPrestacaType Fig Estrutura CabecalhRequisicaPrestacaType. Element Descriçã Tip Ocrrência Requisica_Numer Númer da requisiçã Text 0-1 PINAgendament PINPrestaca PIN de agendament ds MCDT da requisiçã PIN de prestaçã ds MCDT da requisiçã Text 0-1 Text 0-1 EntidadeSNS Indica se é uma entidade SNS Text 1 Tabela 16 CabecalhRequisicaPrestacaType. 17 de 90

18 EntidadeType Fig EntidadeType. Element Descriçã Tip Ocrrência Cdig Códig da entidade Text 1 Designaca Designaçã da entidade Text 0-1 DminiEntidade Dmíni da entidade Text 0-1 PaisEntidade País da entidade Text 0-1 Tabela 18 EntidadeType. 18 de 90

19 ListaMCDTPrestacaType Fig ListaMCDTPrestacaType. Element Descriçã Tip Ocrrência MCDTPrestaca Element que cntem infrmaçã relacinada cm a prestaçã ds MCDT MCDTPrestacaType 1-N Tabela 19 ListaMCDTPrestacaType. MCDTPrestacaType Fig. 23- Estrutura MCDTPrestacaType. Element Descriçã Tip Ocrrência MCDT_ID Identificadr d MCDT Numéric 1 MSPServic Estrutura cm s dads necessáris as serviçs de prestaçã sbre um MCDT MSPServicPrestacaType 1 Tabela 22 MCDTPrestacaType. 19 de 90

20 MSPServicPrestacaType Fig. 24- Estrutura MSPServicPrestacaType. Element Descriçã Tip Ocrrência Data Data assciada a serviç de prestaçã (ex. data de efetivaçã para serviç de efetivaçã) Datetime 1 Observaces Observações assciadas a serviç efetuad Text 0-1 LinkResultads Link de resultads para regist ds mesms Text 0-1 Tabela 23 MSPServicPrestacaType. MCDTsAdicinaisType Fig MCDTsAdicinaisType. Element Descriçã Tip Ocrrência MCDTs Element que cntem infrmaçã relacinada cm s MCDT adicinais ListaMCDTType 1 Signature Assinatura digital SignatureType 1 20 de 90

21 Tabela 19 MCDTsAdicinaisType. ListaMCDTType Fig ListaMCDTType. Element Descriçã Tip Ocrrência MCDT Element que cntem infrmaçã relacinada cm MCDT ItemRequisicaType 1-N Tabela 19 ListaMCDTType. 21 de 90

22 ItemRequisicaType Fig ItemRequisicaType. 22 de 90

23 Element Descriçã Tip Ocrrência MSP Infrmaçã d MCDT assciad à linha da requisiçã MSPType 0-1 IdMCDT Identificadr únic d MCDT Text 0-1 EstadMCDT Códig d estad assciad a MCDT Text 0-1 Lateralidade Lateralidade d MCDT Text 0-1 Prdut Tip de amstra d MCDT Text 0-1 NAmstras Númer de amstras a reclher Numéric 0-1 OutrMSP InfrmacaClinicaCmplem entar EntidadePrestadraRegist RequerAutrizaca IsencaTaxa Internalizar Descritiv de MCDT que nã pertença à tabela de cnvencinads Infrmaçã clínica cmplementar relevante à execuçã da linha da requisiçã Entidade definida n mment d regist para prestar MSP Indica se a requisiçã requer autrizaçã para ser realizada (S/N) Indica se MCDT é isent de taxa (S/N) Indicaçã de internalizaçã da realizaçã d MCDT (S/N) Text 0-1 Text 0-1 EntidadeType 0-1 Text 0-1 Text 0-1 Text 0-1 Prec Preç d MCDT Numéric 0-1 TaxaMderadra Taxa mderadra assciada a MCDT Numéric 0-1 Resultads Link ds resultads d MCDT Text 0-1 Reagendament Indica se huve reagendament d MCDT (S/N) Text 0-1 DataRealizaca Data de prestaçã d MCDT Datetime 0-1 ObservacesRecusa Observações de recusa de um MCDT Text 0-1 ObservacesAgendament Observações de agendament de um MCDT Text 0-1 ObservacesPrestaca Observações de prestaçã de um MCDT Text de 90

24 ObservacesResultads Observações ds resultads btids da prestaçã de um MCDT Text 0-1 MSPServics Estrutura cm s dads necessáris as serviçs cm perações a realizar sbre um MCDT (anulaçã u autrizaçã) MSPServicsType 0-1 Tabela 1 - Tip ItemRequisicaType. 24 de 90

25 SignatureType Fig. 9 Tip SignatureType. Element Descriçã Tip Ocrrência SignedInf SignedInfType 0-1 SignatureValue SignatureValueType 0-1 KeyInf KeyInfType 0-1 Object ObjectType 0-1 Tabela 2 - Tip SignatureType. 25 de 90

26 PrfissinalType Fig. 21- Estrutura PrfissinalType. Element Descriçã Tip Ocrrência NumCedula Númer de cédula d prfissinal Numéric 0-1 Ordem Códig da rdem d prfissinal Text 0-1 NmeClinic Nme d prfissinal Text 0-1 Especialidade Especialidade d prfissinal CdigType 0-1 Cntact Cntat d prfissinal Text 0-1 Tabela 20 - PrfissinalType. CdigType Fig. 22- Estrutura CdigType. Element Descriçã Tip Ocrrência Cdig Códig Text 0-1 Descrica Descriçã d códig Text 0-1 Tabela 21 - CdigType. 26 de 90

27 3.5.3 PrestacaMSPOutputType O element Crp da mensagem de Output ds serviçs, d tip PrestacaMSPOutputType, é cnstituíd pels elements identificads nas seguintes tabelas: PrestacaMSPOutputType Fig Estrutura PrestacaMSPOutputType. Element Descriçã Tip Ocrrência PrestacaMSPOutputList Tken Cnjunt de elements que representam resultad da peraçã d serviç Tken gerad aquand de uma efetivaçã/agendament PrestacaMSPOutputListType 1-N Text 0-1 Tabela 24 PrestacaMSPOutputType. PrestacaMSPOutputListType Fig. 26- Estrutura PrestacaMSPOutputListType. Element Descriçã Tip Ocrrência MCDT_ID Identificadr d MCDT a qual crrespndem as mensagens de sucess/insucess Numéric 0-1 ResultadOperaca Mensagens de sucess/insucess CdigGenericType 1-N 27 de 90

28 Tabela 25 CdigGenericType. CdigGenericType Fig. 26- Estrutura CdigGenericType. Element Descriçã Tip Ocrrência Cdig Descrica Códig da mensagem de sucess/err Descriçã da mensagem de sucess/err Text 1 Text 0-1 Tabela 25 CdigGenericType MSPPesquisaInputType MSPPesquisaInputType Fig Estrutura MSPPesquisaInputType. Element Descriçã Tip Ocrrência EntidadePrestaca Lista de dads da entidade de prestaçã EntidadeType 1 PINAgendament Pin de agendament ds MSP da requisiçã Text 1 28 de 90

29 Element Descriçã Tip Ocrrência CriterisPesquisa Lista cm pções de critéris de pesquisa CriterisPesquisaType 1 Tabela 26 MSPPesquisaInputType. CriterisPesquisaType Fig Estrutura CriterisPesquisaType. Element Descriçã Tip Ocrrência Criteri1 Critéri de pesquisa númer 1 Criteris1Type 0-1 Criteri2 Critéri de pesquisa númer 2 Criteris2Type 0-1 Tabela 27 CriterisType. Criteri1Type Fig. 29- Estrutura Criteri1Type. Element Descriçã Tip Ocrrência Utente Lista de dads d utente UtenteType 1 Tabela 28 - Criteri1Type. 29 de 90

30 UtenteType Fig. 29- Estrutura UtenteType. Element Descriçã Tip Ocrrência NumerSNS Númer de utente n SNS Numéric 0-1 NmeCmplet Nme cmplet d utente Text 0-1 DataNasciment Data de nasciment d utente Data 0-1 Sex Descriçã d sex d utente (F/M) Text 0-1 PaisNacinalidade PaisNaturalidade País crrespndente à nacinalidade d utente País crrespndente à naturalidade d utente Text 0-1 Text 0-1 CertificadCC Certificad d cartã de cidadã Text 0-1 Tabela 29 - UtenteType. 30 de 90

31 Criteri2Type Fig. 30- Estrutura Criteri2Type. Element Descriçã Tip Ocrrência NumerRequisica Identificaçã d númer de requisiçã Text 1 Tabela 29 - Criteri2Type MSPPesquisaOutputType MSPPesquisaOutputType Fig Estrutura MSPPesquisaOutputType. Element Descriçã Tip Ocrrência ResultadOperaca Element cm lista de resultads PesquisaOutputType 1-N Tabela 30 - MSPPesquisaOutputType. 31 de 90

32 PesquisaOutputType Fig Estrutura PesquisaOutputType. Element Descriçã Tip Ocrrência CdigsOperaca Element a lista de códigs e respetivas descrições de sucess/insucess da peraçã CdigsOperacesTy pe 1 ListaResultads Element cm dads referentes as resultads de pesquisa Tabela 31 - PesquisaOutputType. ListaResultadsType 0-1 CdigsOperacaType Fig. 33- Estrutura CdigsOperacaType. Element Descriçã Tip Ocrrência CdigOperaca Element cm um códig e respetiva descriçã de sucess/insucess da peraçã Tabela 32 - ListaResultadsType. CdigGenericType 1-N ListaResultadsType Fig. 34- Estrutura ListaResultadsType. 32 de 90

33 Element Descriçã Tip Ocrrência RequisicaMSP Element cm um u mais cnjunts de requisições Tabela 33 - ListaResultadsType. RequisicaType 1 RequisicaType Fig. 35- Estrutura RequisicaType. Element Descriçã Tip Ocrrência CabecalhRequisica Cabeçalh da requisiçã CabecalhRequisica Type 0-1 Utente Infrmaçã utente UtenteType 0-1 ListaItemsRequisica Lista de MCDT da requisiçã ListaItemsRequisica Type 0-1 Tabela 34 - RequisicaType. 33 de 90

34 CabecalhRequisicaType Fig. 36- Estrutura CabecalhRequisicaType. 34 de 90

35 Element Descriçã Tip Ocrrência Numer Númer da requisiçã Text 0-1 CdigRequisica Códig da requisiçã Text 0-1 Data Data da requisiçã Datetime 0-1 DataValidade Data de validade da requisiçã Datetime 0-1 NVias Númer de vias da requisiçã Numéric 0-1 SubsistemaRespnsavel Subsistema respnsável pela requisiçã EntidadeRespnsavelType 0-1 Prfissinal Médic que emite a requisiçã PrfissinalType 0-1 LcalPrescrica Entidade nde a requisiçã é emitida EntidadeType 0-1 InfrmacaClinica Infrmaçã clínica relevante para a requisiçã Text 0-1 Mdul ID SCG d módul Numéric 0-1 EpisdiID ID d episódi clínic Numéric 0-1 Cnsentiment ExameDmicili Infrmaçã acerca d cnsentiment d utente para partilha ds seus dads de saúde (S/N) Indica se exame fi realizad n dmicíli d utente Text 0-1 ExameDmiciliType 0-1 ExameUrgente Indica se exame é de execuçã urgente ExameUrgenteType 0-1 EmissaExterna Indica se a requisiçã é externa EmissaExternaType 0-1 Online Indica se requisiçã fi emitida nline Blean 0-1 PINAgendament PIN de agendament ds MCDT da requisiçã Text 0-1 PINPrestaca PIN de prestaçã ds MCDT da requisiçã Text 0-1 NtificacaRequisica Indicaçã d tip de ntificaçã a utente NtificacaRequisicaType 0-1 Tabela 35 - CabecalhRequisicaType. ExameDmiciliType 35 de 90

36 Fig. 37- Estrutura ExameDmiciliType. Element Descriçã Tip Ocrrência Dmicili Justificaca Indica se a requisiçã é realizada n dmicíli d utente (S/N) Justificaçã da realizaçã d exame n dmicíli d utente Tabela 36 - ExameDmiciliType. Text 0-1 Text 0-1 ExameUrgenteType Fig. 38- Estrutura ExameUrgenteType. Element Descriçã Tip Ocrrência Urgente Indica se a requisiçã é urgente (S/N) Text 0-1 Justificaca Justificaçã da realizaçã d(s) exame(s) cm urgência Tabela 37 - ExameUrgenteType. Text 0-1 EmissaExternaType Fig. 39- Estrutura EmissaExternaType. Element Descriçã Tip Ocrrência Externa Indica se a requisiçã é externa (S/N) Text 0-1 Tabela 38 - EmissaExternaType. 36 de 90

37 NtificacaRequisicaType Fig. 40- Estrutura NtificacaRequisicaType Element Descriçã Tip Ocrrência TipNtificaca Infrmaçã de qual tip de ntificaçã a utente Numéric 0-1 CntactNtificaca Cntat telefónic para ntificaçã Text 0-1 Ntificaca Cntat de para ntificaçã Text 0-1 Tabela 39 - NtificacaRequisicaType. ListaItemsRequisicaType Fig. 41- Estrutura ListaItemType. Element Descriçã Tip Ocrrência ItemRequisica Item MSP da requisiçã ItemRequisicaType 0-N Tabela 40 - ListaItemType. ItemRequisicaType 37 de 90

38 Fig Estrutura ItemRequisicaType Element Descriçã Tip Ocrrência MSP Infrmaçã d MCDT assciad à linha da requisiçã MSPType de 90

39 DescricaMCDT Descritiv cm tda a infrmaçã d MCDT Text 0-1 IdMCDT Identificadr únic d MCDT Text 0-1 EstadMCDT Códig d estad assciad a MCDT CdigGenericType 0-1 Lateralidade Lateralidade d MCDT CdigGenericType 0-1 Prdut Tip de amstra d MCDT CdigGenericType 0-1 NAmstras Númer de amstras a reclher Numéric 0-1 OutrMSP InfrmacaClinicaCmpleme ntar EntidadePrestadraRegist RequerAutrizaca IsencaTaxa Internalizar Descritiv de MCDT que nã pertença à tabela de cnvencinads Infrmaçã clínica cmplementar relevante à execuçã da linha da requisiçã Entidade definida n mment d regist para prestar MCDT Infrmaçã se a requisiçã requer autrizaçã para ser realizada (S/N) Infrmaçã acerca da isençã de taxa (S/N) Infrmaçã acerca da internalizaçã d MCDT (S/N) Text 0-1 Text 0-1 EntidadeType 0-1 Text 0-1 Text 0-1 Text 0-1 Resultads Regist de resultads Text 0-1 Reagendament Infrmaçã acerca d reagendament d MCDT (S/N) Text 0-1 DataRealizaca Data da realizaçã da peraçã Datetime 0-1 ObservacesRecusa Observações de recusa Text 0-1 ObservacesAgendament Observações de agendament Text 0-1 ObservacesPrestaca Observações de prestaçã Text 0-1 ObservacesResultads Observações de regist de resultads Text 0-1 Tabela 41 ItemRequisicaType 39 de 90

40 MSPType Fig. 43- Estrutura MSPType Element Descriçã Tip Ocrrência CdigMSP Códig d MCDT Text 0-1 AreaMSP Área a que pertence MCDT Text 0-1 SinnimMSP Códig d sinónim d MCDT Text 0-1 Tabela 42 - MSPType. CdigGenericType Fig. 43- Estrutura CdigGenericType Element Descriçã Tip Ocrrência Cdig Códig Text 0-1 Descrica Descriçã Text 0-1 Tabela 42 - MSPType MSPAnulacaPrestacaInputType MSPAnulacaPrestacaInputType 40 de 90

41 Fig. 44- Estrutura MSPAnulacaPrestacaInputType Element Descriçã Tip Ocrrência EntidadePrestadra Infrmaçã da entidade prestadra EntidadeType 1 Prfissinal Infrmaçã d prfissinal respnsável pela peraçã PrfissinalType 0-1 Tken Tken crrespndente à peraçã que se deseja anular (agendament/efetivaçã) Text 1 Tabela 42 - MSPAnulacaPrestacaInputType MSPAnulacaPrestacaOutputType MSPAnulacaPrestacaOutputType Fig. 44- Estrutura MSPAnulacaPrestacaOutputType Element Descriçã Tip Ocrrência ListaResultads Lista cm s resultads da peraçã MSPListOutputType 1 Tabela 42 - MSPAnulacaPrestacaOutputType. MSPListOutputType Fig. 44- Estrutura MSPListOutputType 41 de 90

42 Element Descriçã Tip Ocrrência Resultad Resultad da peraçã PrestacaMSPOutputList Type 1-N Tabela 42 - MSPListOutputType CnsultaAgendamentsCanceladsInputType CnsultaAgendamentsCanceladsInputType Fig. 44- Estrutura CnsultaAgendamentsCanceladsInputType Element Descriçã Tip Ocrrência Entidade Infrmaçã da entidade prestadra EntidadeType 1 DataInici Data de inici para pesquisa de agendaments cancelaments (em cas de nã se prentender pesquisa para dia anterir a atual) DateTime 0-1 Tabela 42 - CnsultaAgendamentsCanceladsInputType. 42 de 90

43 EntidadeType Fig EntidadeType. Element Descriçã Tip Ocrrência Cdig Códig da entidade Text 1 Designaca Designaçã da entidade Text 0-1 DminiEntidade Dmíni da entidade Text 0-1 PaisEntidade País da entidade Text 0-1 Tabela 18 EntidadeType CnsultaAgendamentsCanceladsOutputType CnsultaAgendamentsCanceladsOutputType Fig. 44- Estrutura CnsultaAgendamentsCanceladsInputType Element Descriçã Tip Ocrrência ResultadOperaca Resultad da peraçã ResultadAgendament scanceladsoutputtype 1 Tabela 42 - CnsultaAgendamentsCanceladsOuputType. ResultadAgendamentsCanceladsOutputType 43 de 90

44 Fig. 44- Estrutura ResultadAgendamentsCanceladsOutputType Element Descriçã Tip Ocrrência CdigOperaca Resultad da peraçã CdigGenericType 1 MSPListaAgendamentsC ancelads Lista cm MCDT cancelads ListaAgendamentsCance ladstype 0-1 Tabela 42 - ResultadAgendamentsCanceladsOutputType. CdigGenericType Fig. 43- Estrutura CdigGenericType Element Descriçã Tip Ocrrência Cdig Códig Text 0-1 Descrica Descriçã Text 0-1 Tabela 42 - CdigGenericType. 44 de 90

45 ListaAgendamentsCanceladsType Fig. 44- Estrutura ListaAgendamentsCanceladsType Element Descriçã Tip Ocrrência MSPAgendamentsCanc elads Estrutura cm infrmaçã d MCDT AgendamentsCancelad stype 0-N Tabela 42 - ListaAgendamentsCanceladsType. AgendamentsCanceladsType Fig. 44- Estrutura ListaAgendamentsCanceladsType Element Descriçã Tip Ocrrência Numer_Requisica Númer da requisiçã a que MCDT pertence. Text 1 MCDT_ID Identificadr únic d MCDT Text 1 Data Data d agendament Datetime 1 Tabela 42 - ListaAgendamentsCanceladsType. 45 de 90

46 3.6 Frmat das datas Tds s itens que representam datas sã d tip DateTime, ist é, incluem hras, minuts e segunds, e respeitam mdel W3 de XML para frmat DateTime. Recmenda-se que seja enviad Temp Universal Crdenad (UTC) cm respetiv fus hrári (Timezne). O frmat de qualquer parâmetr u camp que represente uma data é YYYY-MM-DDThh:mm:ss em que: YYYY representa an; MM representa mês; DD representa dia; T é separadr entre a parte que representa a data e a que representa a hra; hh representa a hra n frmat 24h; mm representa minut; ss representa segund. Exempls: T13:49:48+00:00; T21:24:23-01:00 (cas d arquipélag ds Açres). 46 de 90

47 4 Serviç de recusa Este capítul visa especificar, a nível técnic, serviç de recusa, enquadrad n âmbit da prestaçã. Este serviç permite que uma entidade prestadra SNS recuse a prestaçã de um MCDT, atualizand estad d regist para Recusad. Adicinalmente, serviç atualiza estad d MCDT para Aguarda cativaçã, permitind que MCDT pssa ser agendad pr qualquer instituiçã cnvencinada. 4.1 Parâmetrs de entrada ListaPrestacaMSPInput Camp Descriçã Tip Obrigatóri Regras CabecalhRequisica EntidadePrestadra Prfissinal ListaMCDTPrestaca Element cm s dads referentes a uma requisiçã Element cm s dads referentes à entidade prestadra Estrutura crrespndente as dads d médic respnsável pela peraçã realizada sbre MCDT Lista de elements cm infrmaçã referente a um u mais MCDT CabecalhRequisicaPres tacatype EntidadeType PrfissinalType S N/A N/A Nada a bservar. Nã cnsiderar este camp para serviç. Nã cnsiderar este camp para serviç. ListaMCDTPrestacaType S Nada a bservar. MCDTsAdicinais Element cm s dads referentes a MCDT adicinais n mment da efetivaçã MCDTsAdicinaisType N/A Nã cnsiderar este camp para serviç. Tabela 43 ListaPrestacaMSPINputType. 47 de 90

48 CabecalhRequisica Camp Descriçã Tip Obrigatóri Regras Requisica_Numer Númer de requisiçã Numéric N/A Nã cnsiderar este camp para serviç. PINAgendament PIN de agendament Text N/A Nã cnsiderar este camp para serviç. PINPrestaca PIN de prestaçã Text N/A Nã cnsiderar este camp para serviç. EntidadeSNS Indica se é uma entidade SNS Text S Deverá ser preenchid cm valr S u N. Tabela 44 CabecalhRequisicaPrestacaType. ListaMCDTPrestaca Element Descriçã Tip Obrigatóri Regras MCDTPrestaca Element que cntem infrmaçã relacinada cm a prestaçã ds MCDT MCDTPrestacaType S Só deverá pssuir um destes elements. MCDTPrestaca Camp Descriçã Tip Obrigatóri Regras MCDT_ID MSPServic Identificadr d MCDT Estrutura cm s dads necessáris as serviçs de prestaçã sbre um MCDT Numéric S Nada a bservar. MSPServicPrestaca Type S Nada a bservar. Tabela 45 MCDTPrestacaType. 48 de 90

49 MSPServic Camp Descriçã Tip Obrigatóri Regras Data Observaces LinkResultads Data assciada a serviç de prestaçã (ex. data efetivaçã para serviç de efetivaçã) Observações assciadas a serviç efetuad Link de resultads para regist ds mesms Datetime S Deverá ser igual à data atual e inferir à data de expiraçã da requisiçã. Text S Nada a bservar. Text N/A Nã cnsiderar este camp para serviç. Tabela 47 MSPServicPrestacaType. 4.2 Parâmetrs de saída Crp Camp Descriçã Tip Obrigatóri Regras PrestacaMSPOutputLi st Dads assciads a resultad da peraçã PrestacaMSPOutputListTyp e S Nada a bservar. Tken Tken assciad a uma peraçã (efetivaçã/agendament) Text N/A Nã cnsidera r este camp para serviç. Tabela 48 PrestacaMSPOutputType. PrestacaMSPOutputList Element Descriçã Tip Obrigatóri Regras MCDT_ID Identificadr d MCDT a qual crrespndem as mensagens de sucess/insucess Numéric N Nada a bservar. 49 de 90

50 Element Descriçã Tip Obrigatóri Regras ResultadOperaca Mensagens de sucess/insucess CdigGenericType S Nada a bservar. ResultadOperaca Camp Descriçã Tip Obrigatóri Regras Cdig Códig d resultad de peraçã. Text S Códig d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de recusa. Descrica Descriçã d resultad de peraçã. Text S Descriçã d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de recusa. Tabela 49 CdigGenericType. 50 de 90

51 4.3 Mensagens de retrn d serviç de recusa Códig Descriçã Tip Sucess Operaçã efetuada cm sucess. Sucess Dads da peraçã Data da peraçã inválida. Nã cnfrme Indicadr EntidadeSNS inválid para a peraçã indicada. Nã cnfrme Entidade Entidade inválida para a peraçã indicada. Nã cnfrme MCDT Códig d MCDT nã está identificad na platafrma central. Nã cnfrme Estad assciad a(s) MCDT(s) incmpatível cm a peraçã pretendida. Nã cnfrme Outrs errs Err descnhecid. Err Err de nã cnfrmidade cm as regras de prescriçã. Err Operaçã nã autrizada. Err Err técnic. Err Autenticaçã inválida. Err Entidade sem permissões para invcar serviç. Err Estrutura da mensagem incrreta. Err Tabela 50 - Mensagens de retrn d serviç de recusa. 51 de 90

52 5 Serviç de agendament Este capítul visa especificar, a nível técnic, serviç de agendament, enquadrad n âmbit da prestaçã. O serviç de agendament permite que uma entidade prestadra agende u cancele agendament de um u váris MCDT, esta distinçã é feita enviand s seguintes valres n camp peraçã: ANU Anulaçã de agendament AGE (u vazi) Agendament Relativamente a agendament/reagendament de um MCDT, este deverá encntrar-se num ds seguintes estads: Aguarda agendament AAG Aguarda cativaçã ACA Agendad AGE O regist em sistema apenas será feit n cas da entidade prestadra cnseguir prestar a área d MCDT que está a tentar agendar. Em cas de sucess, será registada a data de agendament e estad d MCDT alterad para Agendad e retrnada uma mensagem de sucess. N cas de insucess de algum ds MCDT serã retrnadas mensagens cm as razões d insucess da peraçã (cm a devida identificaçã d MCDT) e nã será registad nenhum ds MCDT desse pedid. Neste perid de transiçã, tds s MCDT de uma requisiçã têm de ser prestads na mesma entidade. Ou seja, a partir d mment em que uma entidade presta um MCDT (serviç de efetivaçã), serviç irá blquear agendament de MCDT daquela requisiçã para utras entidade. Em relaçã à anulaçã de agendament, esta só pderá ser feita em MCDT cuj estad seja AGE (Agendad). Os dads necessáris serã similares a prcess nrmal de agendament, cm excepçã d pin de agendament e as bservações, que nã serã necessáris. 52 de 90

53 5.1 Parâmetrs de entrada ListaPrestacaMSPInput Camp Descriçã Tip Obrigatóri Regras CabecalhRequisica EntidadePrestadra Prfissinal ListaMCDTPrestaca Element cm s dads referentes a uma requisiçã Element cm s dads referentes à entidade prestadra Estrutura crrespndente as dads d médic respnsável pela peraçã realizada sbre MCDT Lista de elements cm infrmaçã referente a um u mais MCDT CabecalhRequisicaPres tacatype S Nada a bservar. EntidadeType S Nada a bservar PrfissinalType N Nada a bservar ListaMCDTPrestacaType S Nada a bservar. MCDTsAdicinais Element cm s dads referentes a MCDT adicinais n mment da efetivaçã MCDTsAdicinaisType N/A Nã cnsiderar este camp para serviç. Tabela 43 ListaPrestacaMSPINputType. CabecalhRequisica Camp Descriçã Tip Obrigatóri Regras Requisica_Numer Númer de requisiçã Numéric N Nada a bservar. PINAgendament PIN de agendament Text C Deverá cnstar n cas de ser uma entidade cnvencinada. PINPrestaca PIN de prestaçã Text N/A EntidadeSNS Indica se é uma entidade SNS Nã cnsiderar este camp para serviç. Text N Nada a bservar. Tabela 44 CabecalhRequisicaPrestacaType. EntidadePrestadra 53 de 90

54 Camp Descriçã Tip Obrigatóri Regras Cdig Códig da entidade Text S Designaca DminiEntidade Designaçã da entidade Dmíni da entidade Deve estar registad na Platafrma central. Text N Nada a bservar. Text N Nada a bservar. PaisEntidade País da entidade Text N Nada a bservar. Tabela 46 EntidadeType. Prfissinal Camp Descriçã Tip Obrigatóri Regras NumCedula Ordem Númer de cédula d prfissinal Códig da rdem d prfissinal Numéric S Nada a bservar. Text S Nada a bservar. NmeClinic Nme d prfissinal Text N Nada a bservar. Especialidade Especialidade d prfissinal CdigType N Nada a bservar. Cntact Cntat d prfissinal Text N Nada a bservar. ListaMCDTPrestaca Element Descriçã Tip Ocrrência MCDTPrestaca Element que cntem infrmaçã relacinada cm a prestaçã ds MCDT MCDTPrestacaType 1-N 54 de 90

55 MCDTPrestaca Camp Descriçã Tip Obrigatóri Regras MCDT_ID MSPServic Identificadr d MCDT Estrutura cm s dads necessáris as serviçs de prestaçã sbre um MCDT Numéric S Nada a bservar. MSPServicPrestaca Type S Nada a bservar. Tabela 45 MCDTPrestacaType. MSPServic Camp Descriçã Tip Obrigatóri Regras Data Observaces LinkResultads Data assciada a serviç de prestaçã (ex. data efetivaçã para serviç de efetivaçã) Observações assciadas a serviç efetuad Link de resultads para regist ds mesms Datetime S Deverá ser igual à data atual e inferir à data de expiraçã da requisiçã. Text N Nada a bservar. Text N/A Nã cnsiderar este camp para serviç. Tabela 47 MSPServicPrestacaType. 5.2 Parâmetrs de saída Crp Camp Descriçã Tip Obrigatóri Regras PrestacaMSPOutputList Dads assciads a resultad da peraçã PrestacaMSPOutputListType S Nada a bservar. Tken Tken assciad a uma peraçã (efetivaçã) Text N Nã cnsiderar este camp para serviç. Tabela 48 PrestacaMSPOutputType. 55 de 90

56 PrestacaMSPOutputList Element Descriçã Tip Obrigatóri Regras MCDT_ID ResultadOperaca Identificadr d MCDT a qual crrespndem as mensagens de sucess/insucess Mensagens de sucess/insucess Numéric N Nada a bservar. CdigGenericType S Nada a bservar. ResultadOperaca Camp Descriçã Tip Obrigatóri Regras Cdig Códig d resultad de peraçã. Text S Códig d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de agendament. Descrica Descriçã d resultad de peraçã. Text S Descriçã d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de agendament. Tabela 49 CdigGenericType. 56 de 90

57 5.3 Mensagens de retrn d serviç de agendament Códig Descriçã Tip Sucess Operaçã efetuada cm sucess. Sucess Requisiçã Requisiçã expirada. Nã cnfrme MCDT Data da peraçã inválida. Nã cnfrme Nã é pssivel reagendar MCDT a mens de 24H da data já agendada. Nã Cnfrme Códig d MCDT nã está identificad na platafrma central. Nã cnfrme Estad assciad a(s) MCDT(s) incmpatível cm a peraçã pretendida. Nã cnfrme MCDT inválid para númer de requisiçã indicad. Nã cnfrme Entidade Entidade inválida para a peraçã indicada. Nã cnfrme A área assciada a MCDT nã é abrangida pela entidade prestadra indicada. Nã Cnfrme Prfissinal Err na infrmaçã d prfissinal. Nã cnfrme O médic nã está identificad ns sistemas centrais da SPMS. Nã cnfrme Outrs errs Err descnhecid. Err Err de nã cnfrmidade cm as regras de prescriçã. Err Operaçã nã autrizada. Err Err técnic. Err Autenticaçã inválida. Err Entidade sem permissões para invcar serviç. Err Estrutura da mensagem incrreta. Err Tabela 59 - Mensagens de retrn d serviç de agendament. 57 de 90

58 6 Serviç de efectivaçã Este capítul visa especificar, a nível técnic, serviç de efetivaçã, enquadrad n âmbit da prestaçã. O serviç permite a efetivaçã de um MCDT que se encntre num ds seguintes estads: Agendad AGE Aguarda Cativaçã ACA Aguarda Agendament AAG Neste períd de transiçã, só será pssível efetuar a prestaçã ds MCDT de uma requisiçã em uma única entidade prestadra. Na altura da efetivaçã, cas existam agendaments de MCDT da mesma requisiçã para utras entidades, serã autmaticamente cancelads. N cas de ser uma entidade cnvencinada, a entidade deverá indicar brigatriamente PIN de prestaçã e númer de requisiçã. Em cas de sucess estad d regist será atualizad para Aguarda resultads. Além diss, será retrnada uma mensagem de sucess para cada MCDT,l bem cm um tken que pderá ser utilizad n serviç de anulaçã de prestaçã. N cas de insucess, (1) nã será retrnad um tken, (2) nenhum ds MCDT será efetivad e (3) serviç irá retrnar as mensagens de err para cada um ds MCDT respnsáveis pela falha. 58 de 90

59 6.1 Parâmetrs de entrada ListaPrestacaMSPInput Camp Descriçã Tip Obrigatóri Regras CabecalhRequisica EntidadePrestadra Prfissinal ListaMCDTPrestaca Element cm s dads referentes a uma requisiçã Element cm s dads referentes à entidade prestadra Estrutura crrespndente as dads d médic respnsável pela peraçã realizada sbre MCDT Lista de elements cm infrmaçã referente a um u mais MCDT CabecalhRequisicaPres tacatype S Nada a bservar. EntidadeType S Nada a bservar.. PrfissinalType S Nada a bservar.. ListaMCDTPrestacaType S Nada a bservar. MCDTsAdicinais Element cm s dads referentes a MCDT adicinais n mment da efetivaçã MCDTsAdicinaisType N/A Nã cnsiderar este camp para serviç. Tabela 43 ListaPrestacaMSPINputType. CabecalhRequisica Camp Descriçã Tip Obrigatóri Regras Requisica_Numer Númer de requisiçã Numéric C Deverá cnstar n cas de ser uma entidade cnvencinada. PINAgendament PIN de agendament Text N/A Nã cnsiderar este camp para serviç. PINPrestaca PIN de prestaçã Text C EntidadeSNS Indica se é uma entidade SNS Deverá cnstar n cas de ser uma entidade cnvencinada. Text N Nada a bservar. Tabela 44 CabecalhRequisicaPrestacaType. 59 de 90

60 EntidadePrestadra Camp Descriçã Tip Obrigatóri Regras Cdig Códig da entidade Text S Designaca DminiEntidade Designaçã da entidade Dmíni da entidade Deve estar registad na Platafrma central. Text N Nada a bservar. Text N Nada a bservar. PaisEntidade País da entidade Text N Nada a bservar. Tabela 46 EntidadeType. Prfissinal Camp Descriçã Tip Obrigatóri Regras NumCedula Ordem Númer de cédula d prfissinal Códig da rdem d prfissinal Numéric S Nada a bservar. Text S Nada a bservar. NmeClinic Nme d prfissinal Text N Nada a bservar. Especialidade Especialidade d prfissinal CdigType N Nada a bservar. Cntact Cntat d prfissinal Text N Nada a bservar. ListaMCDTPrestaca Element Descriçã Tip Ocrrência MCDTPrestaca Element que cntem infrmaçã relacinada cm a prestaçã ds MCDT MCDTPrestacaType 1-N MCDTPrestaca Camp Descriçã Tip Obrigatóri Regras MCDT_ID Identificadr d MCDT Numéric S Nada a bservar. 60 de 90

61 Camp Descriçã Tip Obrigatóri Regras MSPServic Estrutura cm s dads necessáris as serviçs de prestaçã sbre um MCDT MSPServicPrestaca Type S Nada a bservar. Tabela 45 MCDTPrestacaType. 61 de 90

62 MSPServic Camp Descriçã Tip Obrigatóri Regras Data Observaces LinkResultads Data assciada a serviç de prestaçã (ex. data efetivaçã para serviç de efetivaçã) Observações assciadas a serviç efetuad Link de resultads para regist ds mesms Datetime S Deverá ser igual à data atual e inferir à data de expiraçã da requisiçã. Text N Nada a bservar. Text N/A Nã cnsiderar este camp para serviç. Tabela 47 MSPServicPrestacaType. 6.2 Parâmetrs de saída Crp Camp Descriçã Tip Obrigatóri Regras PrestacaMSPOutputList Dads assciads a resultad da peraçã PrestacaMSPOutputListType S Nada a bservar. Tken Tken assciad a uma peraçã (efetivaçã) Text C Tken apenas será retrnad quand pedid retrnar sucess para tds s MCDT. Tabela 48 PrestacaMSPOutputType. 62 de 90

63 PrestacaMSPOutputList Element Descriçã Tip Obrigatóri Regras MCDT_ID ResultadOperaca Identificadr d MCDT a qual crrespndem as mensagens de sucess/insucess Mensagens de sucess/insucess Numéric N Nada a bservar. CdigGenericType S Nada a bservar. ResultadOperaca Camp Descriçã Tip Obrigatóri Regras Cdig Códig d resultad de peraçã. Text S Códig d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de efetivaçã. Descrica Descriçã d resultad de peraçã. Text S Descriçã d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de efetivaçã. Tabela 49 CdigGenericType. 63 de 90

64 6.3 Mensagens de retrn d serviç de efectivaçã Códig Descriçã Tip Sucess Operaçã efetuada cm sucess. Sucess Requisiçã O númer de requisiçã nã se encntra registad na platafrma central. Nã cnfrme O PIN nã está de acrd cm númer de requisiçã indicad. Nã cnfrme Requisiçã expirada. Nã cnfrme Entidade prestadra Entidade inválida para a peraçã indicada. Nã cnfrme A área assciada a MCDT nã é abrangida pela entidade prestadra indicada. Nã cnfrme MCDT Data da peraçã inválida. Nã cnfrme Nã existem MCDTs assciads à requisiçã. Nã cnfrme Códig d MCDT nã está identificad na platafrma central. Nã cnfrme Estad assciad a(s) MCDT(s) incmpatível cm a peraçã pretendida. Nã cnfrme MCDT inválid para númer de requisiçã indicad. Nã cnfrme Utente Utente falecid. Nã cnfrme Prfissinal Err na infrmaçã d prfissinal. Nã cnfrme O médic nã está identificad ns sistemas centrais da SPMS. Nã cnfrme Outrs errs Err descnhecid. Err Err de nã cnfrmidade cm as regras de prescriçã. Err Operaçã nã autrizada. Err Err técnic. Err Autenticaçã inválida. Err Entidade sem permissões para invcar serviç. Err Estrutura da mensagem incrreta. Err Tabela 85 - Mensagens de retrn d serviç de efectivaçã. 64 de 90

65 65 de 90

66 7 Serviç de pesquisa prestaçã Este capítul visa especificar, a nível técnic, serviç de pesquisa prestaçã, enquadrad n âmbit da prestaçã. Este serviç de pesquisa prestaçã, é respnsável pr: Garantir a autrizaçã de acess à requisiçã, pr parte d utente; Permitir acess a cnteúd da requisiçã pr parte de uma entidade prestadra. O serviç irá, neste perid de transiçã, apresentar resultads acerca de uma determinada requisiçã para tdas as entidades prestadras aptas à prestaçã ds MCDT dessa requisiçã, até que um ds MCDT dessa requisiçã seja efetivad. A partir desse mment apenas a entidade que efetivu MCDT cnseguirá cnsultar a requisiçã. O códig da entidade prestadra é de carácter brigatóri cm input d serviç. De frma a garantir a autrizaçã de acess pr parte d utente, é também brigatória a apresentaçã d PIN de agendament da requisiçã, e ainda: Critéri 1: Númer de SNS d utente e certificad d cartã de cidadã; OU Critéri 2: Númer da requisiçã. O serviç apenas irá devlver infrmaçã de requisições que: Estejam dentr d praz de validade; Nã estejam anuladas; A entidade cnsiga prestar (na íntegra). Relativamente as itens assciads à requisiçã, serviç apenas irá devlver MCDT cujs estads nã sejam finais (ver anex 11.5 Estads pssíveis assciads a um MCDT). De ntar que resultad btid na pesquisa de prestaçã, dispõe a infrmaçã d utente à data d regist na prescriçã. 66 de 90

67 7.1 Parâmetrs de entrada MSPPesquisaInput Camp Descriçã Tip Obrigatóri Regras EntidadePrestaca Lista de dads da entidade de prestaçã EntidadeType S Entidade de prestaçã que realiza a pesquisa. PINAgendament PIN de agendament Text S Deve estar assciad a númer de requisiçã indicad. CriterisPesquisa Lista cm pções de critéris de pesquisa CriterisPesquisa S Nada a bservar. Tabela 96 - MSPPesquisaInput. CriterisPesquisa Camp Descriçã Tip Obrigatóri Regras Criteri1 Critéri de pesquisa númer 1 Criteris1Type C Um e apenas um ds critéris tem de ser usad para a pesquisa. Criteri2 Critéri de pesquisa númer 2 Criteris2Type C Um e apenas um ds critéris tem de ser usad para a pesquisa. Tabela 97 CriterisPesquisa. Criteri1 Camp Descriçã Tip Obrigatóri Regras Utente Lista de dads d utente UtenteType S Nada a bservar Tabela 98 - Criteri1. Utente Camp Descriçã Tip Obrigatóri Regras NumerSNS Númer de utente n SNS Numéric S Nada a bservar NmeCmplet Nme cmplet d utente Text N/A Nã cnsiderar este camp para serviç. 67 de 90

68 Camp Descriçã Tip Obrigatóri Regras DataNasciment Data de nasciment d utente Data N/A Sex Descriçã d sex d utente (F/M) Text N/A Nã cnsiderar este camp para serviç. Nã cnsiderar este camp para serviç. PaisNacinalidade País crrespndente à nacinalidade d utente Text N/A Nã cnsiderar este camp para serviç. PaisNaturalidade País crrespndente à naturalidade d utente Text N/A Nã cnsiderar este camp para serviç. CertificadCC Certificad d cartã de cidadã Text S Nada a bservar Tabela 98 - Utente. Criteri2 Camp Descriçã Tip Obrigatóri Regras NumerRequisica Identificaçã d númer de requisiçã Text S Nada a bservar Tabela 99 - Criteri Parâmetrs de saída Crp Camp Descriçã Tip Obrigatóri Regras ResultadOperaca Camp que cntém s dads de utput ds serviçs. PesquisaOutputType S Nada a bservar Tabela 100 MSPPesquisaOutput. 68 de 90

69 ResultadOperaca Camp Descriçã Tip Obrigatóri Regras CdigsOperaca Element cm lista de códigs e respetivas descrições de sucess/insucess da peraçã CdigsOperacaTy pe S Nada a bservar. ListaResultads Element cm dads referentes as resultads de pesquisa ListaResultadsType N Nada a bservar. Tabela 101 ResultadOperaca. CdigsOperaca Camp Descriçã Tip Obrigatóri Regras CdigOperaca Códig e respetiva descriçã d resultad Text S Nada a bservar. Tabela 102 CdigsOperaca. CdigOperaca Camp Descriçã Tip Obrigatóri Regras Cdig Códig d resultad Text S Descrica Descriçã d códig Text S Tabela 103 CdigOperaca. Deve crrespnder a uma das mensagens em Mensagens de retrn d serviç de pesquisa prestaçã. Deve crrespnder a uma das mensagens em Mensagens de retrn d serviç de pesquisa prestaçã. 69 de 90

70 ListaResultads Camp Descriçã Tip Obrigatóri Regras RequisicaMSP Dads relativs a uma requisiçã RequisicaType S Nada a bservar. Tabela 104 ListaResultads. 7.3 Mensagens de retrn d serviç de pesquisa prestaçã Códig Descriçã Tip Sucess Operaçã efetuada cm sucess. Sucess Pesquisa sem resultads. Sucess Utente Err na infrmaçã d utente. Nã cnfrme Utente nã encntrad. Nã cnfrme Mais d que um utente encntrad. Nã cnfrme Entidade Entidade inválida para a peraçã indicada. Nã cnfrme Outrs errs Err descnhecid. Err Err de nã cnfrmidade cm as regras de prescriçã. Err Operaçã nã autrizada. Err Err técnic. Err Autenticaçã inválida. Err Entidade sem permissões para invcar serviç. Err Estrutura da mensagem incrreta. Err Tabela Mensagens de retrn d serviç de pesquisa prestaçã. 70 de 90

71 8 Serviç de anulaçã de prestaçã Este capítul visa especificar, a nível técnic, serviç de anulaçã de prestaçã, enquadrad n âmbit da prestaçã. Este serviç permite que uma entidade prestadra anule uma prestaçã de um MCDT (efetivaça), atualizand estad d regist para estad anterir à prestaçã. O bjectiv deste serviç, é ser usad apenas quand existiu um err invluntári aquand da efetivaçã. 8.1 Parâmetrs de entrada MSPAnulacaPrestacaInputType Camp Descriçã Tip Obrigatóri Regras EntidadePrestadra Infrmaçã da entidade prestadra EntidadeType S Nada a bservar. Prfissinal Infrmaçã d prfissinal respnsável pela peraçã PrfissinalType N Nada a bservar. Tken Tken crrespndente à peraçã que se deseja anular (agendament/efetivaçã ) Text S Nada a bservar. Tabela 43 ListaPrestacaMSPINputType. EntidadePrestadra Camp Descriçã Tip Obrigatóri Regras Cdig Códig da entidade Text S Designaca DminiEntidade Designaçã da entidade Dmíni da entidade Deve estar registad na Platafrma central. Text N Nada a bservar. Text N Nada a bservar. PaisEntidade País da entidade Text N Nada a bservar. Tabela 46 EntidadeType. 71 de 90

72 Prfissinal Camp Descriçã Tip Obrigatóri Regras NumCedula Ordem Númer de cédula d prfissinal Códig da rdem d prfissinal Numéric S Nada a bservar. Text S Nada a bservar. NmeClinic Nme d prfissinal Text N Nada a bservar. Especialidade Especialidade d prfissinal CdigType N Nada a bservar. Cntact Cntat d prfissinal Text N Nada a bservar. Tabela 48 PrfissinalType. 8.2 Parâmetrs de saída Crp Camp Descriçã Tip Obrigatóri Regras ListaResultads Resultads da peraçã MSPListOutputType S Nada a bservar. Tabela 48 Crp. ListaResultads Element Descriçã Tip Obrigatóri Regras Resultad Resultad da peraçã PrestacaMSPOutputListType S Nada a bservar. Tabela 48 ListaResultads. Resultad Element Descriçã Tip Obrigatóri Regras MCDT_ID Identificadr d MCDT a qual crrespndem as mensagens de sucess/insucess Numéric N Nada a bservar. 72 de 90

73 Element Descriçã Tip Obrigatóri Regras ResultadOperaca Mensagens de sucess/insucess CdigGenericType S Nada a bservar. Tabela 48 Resultad. ResultadOperaca Camp Descriçã Tip Obrigatóri Regras Cdig Códig d resultad de peraçã. Text S Códig d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de anulaçã de prestações. Descrica Descriçã d resultad de peraçã. Text S Descriçã d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de anulaçã de prestações. Tabela 49 ResultadOperaca. 73 de 90

74 8.3 Mensagens de retrn d serviç de anulaçã de prestações Códig Descriçã Tip Sucess Operaçã efetuada cm sucess. Sucess Dads da peraçã Data da peraçã inválida. Nã cnfrme Indicadr EntidadeSNS inválid para a peraçã indicada. Nã cnfrme Entidade Entidade inválida para a peraçã indicada. Nã cnfrme MCDT Códig d MCDT nã está identificad na platafrma central. Nã cnfrme Estad assciad a(s) MCDT(s) incmpatível cm a peraçã pretendida. Nã cnfrme Estad d MCDT incmpativel cm tken. Nã cnfrme Prfissinal Err na infrmaçã d prfissinal. Nã cnfrme O médic nã está identificad ns sistemas centrais da SPMS. Nã cnfrme Tken Tken inválid. Nã cnfrme Tken expirad. Nã cnfrme Tken já fi utilizad. Nã cnfrme Outrs errs Err descnhecid. Err Err de nã cnfrmidade cm as regras de prescriçã. Err Operaçã nã autrizada. Err Err técnic. Err Autenticaçã inválida. Err Entidade sem permissões para invcar serviç. Err Estrutura da mensagem incrreta. Err Tabela 50 - Mensagens de retrn d serviç de anulaçã de prestações. 74 de 90

75 9 Serviç de cnsulta de agendaments cancelads Este capítul visa especificar, a nível técnic, serviç de cnsulta de agendaments cancelads, enquadrad n âmbit da prestaçã. Este serviç permite a uma entidade prestadra cmparar a infrmaçã de MCDT que fram agendads para si cm a infrmaçã ds MCDT que fram agendads pel utente para utra entidade. Na prática, serviç devlverá a infrmaçã básica (númer da requisiçã, ID d MCDT e data) ds MCDT que estavam agendads para a entidade que usa serviç e que n dia anterir (à data atual u a uma data frnecida a serviç) fram agendads para utra entidade. Dessa frma, é pssível perceber que existe uma vaga que pderá ser libertada d seu calendári que pderá ser apreveitada pr utr utente e pela própria entidade. 9.1 Parâmetrs de entrada MSPCnsultaAgendamentsCanceladsInputType Camp Descriçã Tip Obrigatóri Regras Entidade Infrmaçã da entidade prestadra EntidadeType S Nada a bservar. DataInici Data de inici para pesquisa de agendaments cancelaments (em cas DateTime N Nada a bservar. de nã se prentender pesquisa para dia anterir a atual) Tabela 43 MSPCnsultaAgendamentsCanceladsInputType. Entidade Camp Descriçã Tip Obrigatóri Regras Cdig Códig da entidade Text S Designaca Designaçã da entidade Deve estar registad na Platafrma central. Text N Nada a bservar. 75 de 90

76 Camp Descriçã Tip Obrigatóri Regras DminiEntidade Dmíni da entidade Text N Nada a bservar. PaisEntidade País da entidade Text N Nada a bservar. 9.2 Parâmetrs de saída Tabela 46 EntidadeType. Crp Camp Descriçã Tip Obrigatóri Regras ResultadOperaca Resultad da peraçã ResultadAgendamentsCan celadsoutputtype S Nada a bservar. Tabela 48 Crp. ResultadOperaca Element Descriçã Tip Obrigatóri Regras CdigOperaca MSPListaAgendamentsCancelads Mensagem de sucess/insucess Lista de MCDT cancelads CdigGenericType S Nada a bservar. ListaAgendamentsCanceladsType N Nada a bservar Tabela 48 ResultadOperaca. ResultadOperaca Camp Descriçã Tip Obrigatóri Regras Cdig Códig d resultad de peraçã. Text S Códig d resultad. Deve crrespnder a uma das mensagens descritas em Mensagens de retrn d serviç de cnsulta de agendaments cancelads. Descrica Descriçã d resultad de peraçã. Text S Descriçã d resultad. Deve crrespnder a uma 76 de 90

77 Camp Descriçã Tip Obrigatóri Regras Tabela 49 CdigGenericType. das mensagens descritas em Mensagens de retrn d serviç de cnsulta de agendaments cancelads. MSPListaAgendamentsCancelads Element Descriçã Tip Obrigatóri Regras MSPAgendamentsCancelads Infrmaçã d MCDT AgendamentsCanceladsType N Nada a bservar. Tabela 48 MSPListaAgendamentsCancelads. MSPAgendamentsCancelads Element Descriçã Tip Obrigatóri Regras Numer_Requisica Númer da requisiçã a que MCDT pertence. Text S Nada a bservar. MCDT_ID Identificadr únic d MCDT Text S Nada a bservar. Data Data d agendament Datetime S Nada a bservar. Tabela 48 MSPAgendamentsCancelads. 77 de 90

78 9.3 Mensagens de retrn d serviç de cnsulta de agendaments cancelads Códig Descriçã Tip Sucess Operaçã efetuada cm sucess. Sucess Pesquisa sem resultads. Sucess Entidade Entidade inválida para a peraçã indicada. Nã cnfrme Outrs errs Err descnhecid. Err Err de nã cnfrmidade cm as regras de prescriçã. Err Operaçã nã autrizada. Err Err técnic. Err Autenticaçã inválida. Err Entidade sem permissões para invcar serviç. Err Estrutura da mensagem incrreta. Err Tabela 50 - Mensagens de retrn d serviç de cnsulta de agendaments cancelads. 78 de 90

79 10 QR Cdes Os QR Cdes impresss na Guia de Prestaçã para Utente visam permitir a prestaçã em md ffline, sempre que crram falhas ds sistemas que impssibilitem crret funcinament d prcess. De seguida, serã detalhads tds s elements destes códigs matriz e métd de interpretaçã ds mesms Cmpsiçã d QR Cde Os elements da receita sã identificads pr: Element VER CRQ UTE EFR PRO LPR IRQ Descriçã Versã d QRCde Cabeçalh da requisiçã Infrmaçã d utente Subsistema respnsável Médic prescritr Lcal de prescriçã Linha da requisiçã Tabela 1 Segments de um QR Cde. Detalhe d segment VER: Camp Descriçã Cardinalidade Repetível VER.1 Versã d QRCde a ser utilizada na sua criaçã 1 N Tabela 2 Segment VER. Detalhe d segment CRQ: Camp Descriçã Cardinalidade Repetível CRQ.1 Númer da requisiçã 1 N CRQ.2 Data da requisiçã 1 N CRQ.3.1 Cntact d utente 0,1 N CRQ.3.2 d utente 0,1 N 79 de 90

80 CRQ.4.1 Dmicili (S/N) 1 N CRQ.4.2 Justificaçã de dmicili 0,1 N CRQ.5.1 Urgente (S/N) 1 N CRQ.5.2 Justificaçã de urgência 0,1 N Detalhe d segment UTE: Tabela 3 Segment CRQ. Camp Descriçã Cardinalidade Repetível UTE.1 Nme d utente 1 N Tabela 4 Segment UTE. Detalhe d segment EFR: Camp Descriçã Cardinalidade Repetível EFR.1.1 Códig da entidade 1 N EFR.1.2 Designaçã da entidade 1 N EFR.1.3 País da entidade, cf nrma ISO , alpha 2 0,1 N EFR.2 Númer de beneficiári d utente na Entidade Respnsável 0,1 N Tabela 5 Segment EFR. Detalhe d segment PRO: Camp Descriçã Cardinalidade Repetível PRO.1 Númer de rdem d médic prescritr 1 N PRO.2 Códig identificadr da rdem a que médic prescritr 1 N PRO.3 pertence, cf Especialidade d médic prescritr, Cnsultar Circular Nrmativa n.º35 de ACSS, relativamente à classificaçã de especialidade médica (1º nível Lista de Categrias). Tabela 6 Segment PRO. 0,1 N 80 de 90

81 Detalhe d segment LPR: Camp Descriçã Cardinalidade Repetível LPR.1 Códig da entidade 1 N Tabela 7 Segment LPR. Detalhe d segment IRQ: Camp Descriçã Cardinalidade Repetível IRQ.1 Identificadr únic d MCDT 1 N IRQ.2.1 Códig d exame 1 N IRQ.2.2 Área d exame 1 N IRQ.3 Exame nã cmparticipad 0,1 N IRQ.4 Infrmaçã cmplementar d exame 0,1 N IRQ.5 Identificadr da lateralidade d exame 0,1 N IRQ.6 Identificadr d prdut 0,1 N IRQ.7 Númer de amstras d exame 1 N IRQ.8 Infrmaçã acerca da isençã de taxa d exame (S/N) 1 N Caracteres de escape: Tabela 8 Segment LRC. Caractere Representaçã na mensagem \ ^ \^ Tabela 9 - Exceções. 81 de 90

82 Exempl da cmpsiçã da mensagem: VER 1.0 CRC NumerRequisica DataRequisica Cntact^ Dmicili^JustificacaDmicili Urgente^Jus tificacaurgencia UTE NmeUtente PRO NumOrdem Ordem Especialidade EFR Cdig^Designaca^PaisEntidade NumerBeneficiari LPR Cdig IRQ IdMCDT CdigExame^AreaExame OutrMCDT InfrmacaCmplementar Lateralidade Prdut NumAmstras IsencaTaxa 82 de 90

83 10.2 Prcess de leitura d QR Cde O cnteúd d códig matriz encntra-se cmprimid e cdificad, devend ser seguid prcess abaix apresentad para interpretaçã ds dads cntids n mesm. 1. É necessári descdificar cnteúd d QR Cde, cdificad em Base64. Exempl d QR Cde: 2. Exempl d cnteúd QR Cde (cdificad em Base64): H4sIAAAAAAAAAG1OzUrEMBi85ylyly1f2u1m9Za2nxCbU1iDx4CpaxQ6I8sHufuO/g6+2JW8egw AwMzAyN6dlAJQZTuGRmRj+XOuMNFJS5wOdD6kORA+/TPb4jtTuEOFjtS3TOM3ThiZCvARGw SY4+yqtNwXXkn3gnhsvXftUGIjOtVDH9EigHBD86HCf5SdS0bPr7e2zlY0pbduYWlYsvbl9VRy7sHfrz ihbt6qvhp3388bqvoiwhs+rzdl2ectnke1mkcym15ny/lzf0yrlbidzx4biij+u0haqaa 3. Efetuar a descmpressã (unzip) d cnteúd d QR Cde; 4. Interpretar cnteúd d text apresentad. Exempl da mensagem: VER 1.0 CRQ T00:00: :00 ^ S^Dmicili N^ UTE BEATRIZ ISABEL ESTEVENS ROMBA PRO EFR ^SERVIÇO NACIONAL DE SAÚDE^PT LPR IRQ ^A InfrmacaClinicaCmplementar N 83 de 90