ESP Exames Sem Papel 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.
Históric de alterações Cntrl d dcument Versã Data Autres Revisres Alterações Aprvaçã 1.0.0 30-09-2017 SPMS Versã inicial SPMS 1.01 13-04-2018 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ç PesquisaPrestaçã SPMS SPMS 2 de 99
Lista de distribuiçã Nme Email Respnsabilidade Dcuments relacinads Refª Títul Outrs dcuments relevantes Ref. Títul 3 de 99
Cnteúd 1 Intrduçã... 7 1.1 Objetiv... 7 1.2 Enquadrament... 7 2 Acrónims, terms e definições... 8 2.1 Acrónims... 8 2.2 Terms e definições... 9 3 Mdel de dads canónic... 10 3.1 Mdel de dads canónic - Prestaçã... 11 3.2 Mdel de dads canónic - Pesquisa... 13 3.3 Mdel de dads canónic - Anulaçã... 14 3.4 Estruturas... 15 3.4.1 CabecalhType... 15 CabecalhType... 15 EntidadeType... 17 ChaveEntidadeType... 17 CdigGenericType... 17 3.4.2 ListaPrestacaMSPInputType... 19 ListaPrestacaMSPInputType... 19 CabecalhRequisicaPrestacaType... 20 EntidadeType... 21 ListaPrestacaType... 22 PrestacaType... 22 MSPServicPrestacaType... 23 sadicinaistype... 23 ListaType... 25 ItemRequisicaType... 26 SignatureType... 28 PrfissinalType... 30 CdigType... 30 3.4.3 PrestacaMSPOutputType... 32 PrestacaMSPOutputType... 32 PrestacaMSPOutputListType... 32 CdigGenericType... 33 3.4.4 MSPPesquisaInputType... 34 MSPPesquisaInputType... 34 4 de 99
CriterisPesquisaType... 35 Criteri1Type... 35 UtenteType... 36 Criteri2Type... 37 3.4.5 MSPPesquisaOutputType... 37 MSPPesquisaOutputType... 37 CdigsOperacaType... 38 ListaResultadsType... 38 RequisicaType... 39 CabecalhRequisicaType... 40 ExameDmiciliType... 42 ExameUrgenteType... 42 EmissaExternaType... 42 NtificacaRequisicaType... 43 ListaItemsRequisicaType... 43 ItemRequisicaType... 44 MSPType... 46 CdigGenericType... 46 3.4.6 MSPAnulacaPrestacaInputType... 46 MSPAnulacaPrestacaInputType... 47 3.4.7 MSPAnulacaPrestacaOutputType... 47 MSPAnulacaPrestacaOutputType... 47 MSPListOutputType... 47 3.5 Frmat das datas... 48 4 Serviç de recusa... 49 4.1 Parâmetrs de entrada... 49 4.2 Parâmetrs de saída... 54 4.3 Mensagens de retrn d serviç de recusa... 56 5 Serviç de agendament... 57 5.1 Parâmetrs de entrada... 57 5.2 Parâmetrs de saída... 63 5.3 Mensagens de retrn d serviç de agendament... 64 6 Serviç de efectivaçã... 66 6.1 Parâmetrs de entrada... 66 6.2 Parâmetrs de saída... 72 6.3 Mensagens de retrn d serviç de efectivaçã... 74 7 Serviç de regist de resultads... 76 5 de 99
7.1 Parâmetrs de entrada... 76 7.2 Parâmetrs de saída... 82 7.3 Mensagens de retrn d serviç de regist de resultads... 84 8 Serviç de pesquisa prestaçã... 85 8.1 Parâmetrs de entrada... 85 8.2 Parâmetrs de saída... 87 8.3 Mensagens de retrn d serviç de pesquisa prestaçã... 90 9 Serviç de anulaçã de prestaçã... 91 9.1 Parâmetrs de entrada... 91 9.2 Parâmetrs de saída... 92 9.3 Mensagens de retrn d serviç de anulaçã de prestações... 93 10 Anexs... 95 10.1 Dmínis de entidades... 95 10.2 Entidades financeiras d dmíni EFRPT... 95 10.3 Entidades financeiras d dmíni EFREST exempls de entidades aplicáveis a cidadãs migrantes d espaç eurpeu (Cartã Eurpeu Segur de Dença)... 96 10.4 Entidades financeiras d dmíni EFREST, aplicáveis a migrantes a abrig de acrds internacinais cm Prtugal... 96 10.5 Estads pssíveis assciads a um... 97 10.6 Áreas (lad) assciads a um... 98 10.7 Prduts assciads a um... 98 10.8 Mtivs de anulaçã de um /Requisiçã... 99 6 de 99
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 (). 1.2 Enquadrament Este dcument especifica a interface cm sistema central de prestações 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 pr parte de uma entidade prestadra SNS; Agendament Agendament (u cancelament de agendament) de um u mais ; Efetivaçã Efetivaçã de um agendad; Regist de resultads - Regist ds resultads de um u mais efetivads; Pesquisa prestaçã Cnsulta da infrmaçã de uma requisiçã e respectivs. Anula prestaçã Anula uma prestaçã de um u mais. Em anex encntram-se s dmínis de valres utilizads neste mdel de cmunicaçã. 7 de 99
2 Acrónims, terms e definições 2.1 Acrónims Sigla BDNR EFR 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. 8 de 99
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çã 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 assciads a um utente. Meis cmplementares de diagnóstic e terapêutica. Estabeleciment de saúde nde exame é prescrit. Estabeleciment de saúde u utr centr de respnsabilidade nde sã efetivads s. 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. 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. 9 de 99
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. 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ã aplicável (quand camp nã é cnsiderad para a execuçã d serviç). 10 de 99
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 é efetuada após a fase de prescriçã, e tem iníci cm a necessidade de Agendar um, para realizar numa instituiçã d SNS u num prestadr cnvencinad. Os prestadres cnvencinads pderã agendar um que se encntre num estad Aguarda cativaçã (ACA), enquant que s prestadres d SNS pderã agendar um quand este se encntra num estad Aguarda agendament (AAG). Quand fr agendad ele passa para estad Agendad. Após Agendament é pssível Reagendament u a Efetivaçã de, estad n qual 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çã. Mensagem de input: Fig. 1- Element de input ds serviçs de Prestaçã. Mensagem de utput: 11 de 99
Fig. 2 - Element de utput ds serviçs de Prestaçã. 12 de 99
3.2 Mdel de dads canónic - Pesquisa O mdel canónic cnstruíd para s serviçs referentes à pesquisa de requisiçõ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 pesquisa de prestaçã. Mensagem de input: Fig. 3 - Element de input d serviç de pesquisa. Mensagem de utput: Fig. 4 - Element de utput d serviç de pesquisa. 13 de 99
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: Fig. 6 - Element de utput d serviç de anulaçã. 14 de 99
3.4 Estruturas Nas secções seguintes serã descritas tdas as estruturas utilizadas ns mdels de dads canónics cnstruíds. 3.4.1 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. 15 de 99
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 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; ChavePedidRelacinad: chave única d pedid que deu rigem à mensagem atual (respsta). 16 de 99
EntidadeType Fig. 6- Estrutura EntidadeType. 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. 17 de 99
Element Descriçã Tip Ocrrência Cdig Códig Text 1 Descrica Descriçã d códig Text 0-1 Tabela 6 CdigGenericType. 18 de 99
3.4.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 ListaPrestaca sadicinais 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 Lista de elements cm infrmaçã referente a um u mais Element cm s dads referentes a adicinais n mment da efetivaçã CabecalhRequisicaPrestacaType 0-1 EntidadeType 0-1 PrfissinalType 0-1 ListaPrestacaType 1 sadicinaistype 0-1 Tabela 15 ListaPrestacaMSPInputType. 19 de 99
CabecalhRequisicaPrestacaType Fig. 17 - Estrutura CabecalhRequisicaPrestacaType. Element Descriçã Tip Ocrrência Requisica_Numer Númer da requisiçã Text 0-1 PINAgendament PINPrestaca PIN de agendament ds da requisiçã PIN de prestaçã ds da requisiçã Text 0-1 Text 0-1 EntidadeSNS Indica se é uma entidade SNS Text 1 Tabela 16 CabecalhRequisicaPrestacaType. 20 de 99
EntidadeType Fig. 19 - 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. 21 de 99
ListaPrestacaType Fig. 20 - ListaPrestacaType. Element Descriçã Tip Ocrrência Prestaca Element que cntem infrmaçã relacinada cm a prestaçã ds PrestacaType 1-N Tabela 19 ListaPrestacaType. PrestacaType Fig. 23- Estrutura PrestacaType. Element Descriçã Tip Ocrrência _ID Identificadr d Numéric 1 MSPServic Estrutura cm s dads necessáris as serviçs de prestaçã sbre um MSPServicPrestacaType 1 Tabela 22 PrestacaType. 22 de 99
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 LinkResultads Observações assciadas a serviç efetuad Link de resultads para regist ds mesms Text 0-1 Text 0-1 Tabela 23 MSPServicPrestacaType. sadicinaistype Fig. 20 - sadicinaistype. Element Descriçã Tip Ocrrência s Element que cntem infrmaçã relacinada cm s adicinais ListaType 1 23 de 99
Element Descriçã Tip Ocrrência Signature Assinatura digital SignatureType 1 Tabela 19 sadicinaistype. 24 de 99
ListaType Fig. 20 - ListaType. Element Descriçã Tip Ocrrência Element que cntem infrmaçã relacinada cm ItemRequisicaType 1-N Tabela 19 ListaType. 25 de 99
ItemRequisicaType Fig. 20 - ItemRequisicaType. 26 de 99
Element Descriçã Tip Ocrrência MSP Id Estad Infrmaçã d assciad à linha da requisiçã Identificadr únic d Códig d estad assciad a MSPType 0-1 Text 0-1 Text 0-1 Lateralidade Lateralidade d Text 0-1 Prdut Tip de amstra d Text 0-1 NAmstras OutrMSP InfrmacaClinicaCmplem entar EntidadePrestadraRegist RequerAutrizaca IsencaTaxa Internalizar Númer de amstras a reclher Descritiv de 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 é isent de taxa (S/N) Indicaçã de internalizaçã da realizaçã d (S/N) Numéric 0-1 Text 0-1 Text 0-1 EntidadeType 0-1 Text 0-1 Text 0-1 Text 0-1 Prec Preç d Numéric 0-1 TaxaMderadra Resultads Taxa mderadra assciada a Link ds resultads d Numéric 0-1 Text 0-1 27 de 99
Reagendament DataRealizaca Indica se huve reagendament d (S/N) Data de prestaçã d Text 0-1 Datetime 0-1 ObservacesRecusa Observações de recusa de um Text 0-1 ObservacesAgendament Observações de agendament de um Text 0-1 ObservacesPrestaca Observações de prestaçã de um Text 0-1 ObservacesResultads Observações ds resultads btids da prestaçã de um Text 0-1 MSPServics Estrutura cm s dads necessáris as serviçs cm perações a realizar sbre um (anulaçã u autrizaçã) MSPServicsType 0-1 Tabela 1 - Tip ItemRequisicaType. SignatureType Fig. 7 Tip SignatureType. Element Descriçã Tip Ocrrência 28 de 99
SignedInf SignedInfType 0-1 SignatureValue SignatureValueType 0-1 KeyInf KeyInfType 0-1 Object ObjectType 0-1 Tabela 2 - Tip SignatureType. 29 de 99
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. 30 de 99
Element Descriçã Tip Ocrrência Cdig Códig Text 0-1 Descrica Descriçã d códig Text 0-1 Tabela 21 - CdigType. 31 de 99
3.4.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. 25 - 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 _ID Identificadr d a qual crrespndem as mensagens de sucess/insucess Numéric 0-1 ResultadOperaca Mensagens de sucess/insucess CdigGenericType 1-N Tabela 25 CdigGenericType. 32 de 99
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. 33 de 99
3.4.4 MSPPesquisaInputType MSPPesquisaInputType Fig. 27 - Estrutura MSPPesquisaInputType. Element Descriçã Tip Ocrrência EntidadePrestaca Lista de dads da entidade de prestaçã EntidadeType 1 PINAgendament CriterisPesquisa Pin de agendament ds MSP da requisiçã Lista cm pções de critéris de pesquisa Text 1 CriterisPesquisaType 1 Tabela 26 MSPPesquisaInputType. 34 de 99
CriterisPesquisaType Fig. 28 - 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. 35 de 99
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. 36 de 99
Criteri2Type Fig. 30- Estrutura Criteri2Type. Element Descriçã Tip Ocrrência NumerRequisica Identificaçã d númer de requisiçã Text 1 Tabela 29 - Criteri2Type. 3.4.5 MSPPesquisaOutputType MSPPesquisaOutputType Fig. 31 - Estrutura MSPPesquisaOutputType. Element Descriçã Tip Ocrrência ResultadOperaca Element cm lista de resultads PesquisaOutputType 1-N Tabela 30 - MSPPesquisaOutputType. PesquisaOutputType Fig. 32 - Estrutura PesquisaOutputType. Element Descriçã Tip Ocrrência 37 de 99
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. Element Descriçã Tip Ocrrência RequisicaMSP Element cm um u mais cnjunts de requisições Tabela 33 - ListaResultadsType. RequisicaType 1 38 de 99
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 da requisiçã ListaItemsRequisica Type 0-1 Tabela 34 - RequisicaType. 39 de 99
CabecalhRequisicaType Fig. 36- Estrutura CabecalhRequisicaType. 40 de 99
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çã EntidadeRespnsavel Type 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 da requisiçã Text 0-1 PINPrestaca PIN de prestaçã ds da requisiçã Text 0-1 NtificacaRequisica Indicaçã d tip de ntificaçã a utente NtificacaRequisica Type 0-1 Tabela 35 - CabecalhRequisicaType. 41 de 99
ExameDmiciliType 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. 42 de 99
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 EmailNtificaca Cntat de email 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. 43 de 99
ItemRequisicaType Fig. 42 - Estrutura ItemRequisicaType Element Descriçã Tip Ocrrência 44 de 99
MSP Descrica Infrmaçã d assciad à linha da requisiçã Descritiv cm tda a infrmaçã d MSPType 0-1 Text 0-1 Id Identificadr únic d Text 0-1 Estad Códig d estad assciad a CdigGenericType 0-1 Lateralidade Lateralidade d CdigGenericType 0-1 Prdut Tip de amstra d CdigGenericType 0-1 NAmstras Númer de amstras a reclher Numéric 0-1 OutrMSP InfrmacaClinicaCmpleme ntar EntidadePrestadraRegist RequerAutrizaca IsencaTaxa Internalizar Descritiv de 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 Infrmaçã se a requisiçã requer autrizaçã para ser realizada (S/N) Infrmaçã acerca da isençã de taxa (S/N) Infrmaçã acerca da internalizaçã d (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 (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 45 de 99
Tabela 41 ItemRequisicaType MSPType Fig. 43- Estrutura MSPType Element Descriçã Tip Ocrrência CdigMSP Códig d Text 0-1 AreaMSP Área a que pertence Text 0-1 SinnimMSP Códig d sinónim d 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. 3.4.6 MSPAnulacaPrestacaInputType 46 de 99
MSPAnulacaPrestacaInputType 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. 3.4.7 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 47 de 99
Element Descriçã Tip Ocrrência Resultad Resultad da peraçã PrestacaMSPOutputList Type 1-N Tabela 42 - MSPListOutputType. 3.5 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: 1. 2011-01-21T13:49:48+00:00; 2. 2012-04-02T21:24:23-01:00 (cas d arquipélag ds Açres). 48 de 99
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, atualizand estad d regist para Recusad. Adicinalmente, serviç atualiza estad d para Aguarda cativaçã, permitind que pssa ser agendad pr qualquer instituiçã cnvencinada. 4.1 Parâmetrs de entrada ListaPrestacaMSPInput Camp Descriçã Tip Obrigatóri Regras CabecalhRequisica EntidadePrestadra Prfissinal ListaPrestaca 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 Lista de elements cm infrmaçã referente a um u mais CabecalhRequisicaPres tacatype EntidadeType PrfissinalType S Nada a bservar. Nã cnsiderar este camp para serviç. Nã cnsiderar este camp para serviç. ListaPrestacaType S Nada a bservar. sadicinais Element cm s dads referentes a adicinais n mment da efetivaçã sadicinaistype Nã cnsiderar este camp para serviç. Tabela 43 ListaPrestacaMSPINputType. 49 de 99
CabecalhRequisica Camp Descriçã Tip Obrigatóri Regras Requisica_Numer Númer de requisiçã Numéric Nã cnsiderar este camp para serviç. PINAgendament PIN de agendament Text Nã cnsiderar este camp para serviç. PINPrestaca PIN de prestaçã Text 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. 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. 50 de 99
Especialidade Especialidade d prfissinal CdigType N Nada a bservar. Cntact Cntat d prfissinal Text N Nada a bservar. ListaPrestaca Element Descriçã Tip Obrigatóri Regras Prestaca Element que cntem infrmaçã relacinada cm a prestaçã ds PrestacaType S Só deverá pssuir um destes elements. Prestaca Camp Descriçã Tip Obrigatóri Regras _ID MSPServic Identificadr d Estrutura cm s dads necessáris as serviçs de prestaçã sbre um Numéric S Nada a bservar. MSPServicPrestaca Type S Nada a bservar. Tabela 45 PrestacaType. 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ã cnsiderar este camp para serviç. Tabela 47 MSPServicPrestacaType. 51 de 99
Adicinais Camp Descriçã Tip Obrigatóri Regras s Element que cntem infrmaçã relacinada cm s adicinais ListaType S Nada a bservar. Signature Assinatura digital SignatureType S Nada a bservar. Tabela 44 sadicinaistype. Camp Descriçã Tip Obrigatóri Regras Element que cntem infrmaçã relacinada cm ItemRequisicaType S Nada a bservar. Tabela 44 ListaType. Camp Descriçã Tip Obrigatóri Regras MSP Infrmaçã d assciad à linha da requisiçã MSPType S Nada a bservar. Id Identificadr únic d Text Nã cnsiderar este camp para serviç. Estad Códig d estad assciad a Text Nã cnsiderar este camp para serviç. Lateralidade Lateralidade d Text N Deve estar de acrd cm s valres registads n anex Áreas (lad) assciads a um. 52 de 99
Camp Descriçã Tip Obrigatóri Regras Prdut Tip de amstra d Text N Deve estar de acrd cm s valres registads n anex Prduts assciads a um. NAmstras Númer de amstras a reclher Numéric N Númer psitiv inteir. OutrMSP InfrmacaClinicaCmplementar Descritiv de que nã pertença à tabela de cnvencinads Infrmaçã clínica cmplementar relevante à execuçã da linha da requisiçã Text N Nada a bservar. Text N Nada a bservar. EntidadePrestadraRegist Entidade definida n mment d regist para prestar EntidadeType N Preencher cas a entidade prestadra pertença a SNS. Deverá estar registada na platafrma central. RequerAutrizaca Indica se a requisiçã requer autrizaçã para ser realizada (S/N) Text S Lista de valres: S - Sim N - Nã IsencaTaxa Indica se é isent de taxa (S/N) Text S Lista de valres: S Sim N - Nã Internalizar Indicaçã de internalizaçã da realizaçã d (S/N) Text S Lista de valres: S - Sim N" - Nã Prec Preç d Numéric Nã cnsiderar este camp para serviç. TaxaMderadra Taxa mderadra assciada a Numéric N Nada a bservar. 53 de 99
Camp Descriçã Tip Obrigatóri Regras Resultads Link ds resultads d Text Nã cnsiderar este camp para serviç. Reagendament Indica se huve reagendament d (S/N) Text Nã cnsiderar este camp para serviç. DataRealizaca Data de prestaçã d Datetime Nã cnsiderar este camp para serviç. ObservacesRecusa Observações de recusa de um Text Nã cnsiderar este camp para serviç. ObservacesAgendament Observações de agendament de um Text Nã cnsiderar este camp para serviç. ObservacesPrestaca Observações de prestaçã de um Text Nã cnsiderar este camp para serviç. ObservacesResultads Observações ds resultads btids da prestaçã de um Text Nã cnsiderar este camp para serviç. MSPServics Estrutura cm s dads necessáris as serviçs cm perações a realizar sbre um (anulaçã u autrizaçã) MSPServicsType Nã cnsiderar este camp para serviç. Tabela 44 Type. 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. 54 de 99
Camp Descriçã Tip Obrigatóri Regras Tken Tken assciad a uma peraçã (efetivaçã/agendament) Text Nã cnsidera r este camp para serviç. Tabela 48 PrestacaMSPOutputType. PrestacaMSPOutputList Element Descriçã Tip Obrigatóri Regras _ID ResultadOperaca Identificadr d 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 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. 55 de 99
4.3 Mensagens de retrn d serviç de recusa Códig Descriçã Tip Sucess 100007010003 Operaçã efetuada cm sucess. Sucess Dads da peraçã 100007022002 Data da peraçã inválida. Nã cnfrme 100007025001 Indicadr EntidadeSNS inválid para a peraçã indicada. Nã cnfrme Entidade 100007024007 Entidade inválida para a peraçã indicada. Nã cnfrme 100007028002 Códig d nã está identificad na platafrma central. Nã cnfrme 100007028008 Estad assciad a(s) (s) incmpatível cm a peraçã pretendida. Nã cnfrme Outrs errs 100007029098 Err descnhecid. Err 100007029099 Err de nã cnfrmidade cm as regras de prescriçã. Err 100007030001 Operaçã nã autrizada. Err 100007030002 Err técnic. Err 100007030003 Autenticaçã inválida. Err 100007030004 Entidade sem permissões para invcar serviç. Err 100007030005 Estrutura da mensagem incrreta. Err Tabela 50 - Mensagens de retrn d serviç de recusa. 56 de 99
5 Serviç de agendament O serviç de agendament permite que uma entidade prestadra agende u cancele agendament de um u váris, esta distinçã é feita enviand s seguintes valres n camp peraçã: ANU Anulaçã de agendament AGE (u vazi) Agendament Em relaçã à anulaçã de agendament, esta só pderá ser feita em cuj estad seja AGE (Agendad) e s dads necessáris serã quase s mesms que n prcess nrmal de agendament, send a única diferença pin de agendament e as bservações (nã serã necessáris). Relativamente a agendament/reagendament d, 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 que está a tentar agendar, em cas de sucess será registada a data de agendament e estad d para Agendad assim cm retrnada uma mensagem de sucess. N cas de insucess de algum ds serã retrnadas mensagens cm as razões d insucess da peraçã (cm a devida identificaçã d ) e nã será registad nenhum ds s desse pedid. 5.1 Parâmetrs de entrada ListaPrestacaMSPInput Camp Descriçã Tip Obrigatóri Regras CabecalhRequisica EntidadePrestadra Prfissinal 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 CabecalhRequisicaPres tacatype S Nada a bservar. EntidadeType S Nada a bservar PrfissinalType N Nada a bservar 57 de 99
Camp Descriçã Tip Obrigatóri Regras ListaPrestaca peraçã realizada sbre Lista de elements cm infrmaçã referente a um u mais ListaPrestacaType S Nada a bservar. sadicinais Element cm s dads referentes a adicinais n mment da efetivaçã sadicinaistype 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ã cnsiderar este camp para serviç. EntidadeSNS Indica se é uma entidade SNS Text S Deverá ser preenchid cm valr S u N. Tabela 44 CabecalhRequisicaPrestacaType. 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. 58 de 99
Camp Descriçã Tip Obrigatóri Regras 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. ListaPrestaca Element Descriçã Tip Ocrrência Prestaca Element que cntem infrmaçã relacinada cm a prestaçã ds s PrestacaType 1-N Prestaca Camp Descriçã Tip Obrigatóri Regras _ID MSPServic Identificadr d Estrutura cm s dads necessáris as serviçs de prestaçã sbre um Numéric S Nada a bservar. MSPServicPrestaca Type S Nada a bservar. Tabela 45 PrestacaType. 59 de 99
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ã cnsiderar este camp para serviç. Tabela 47 MSPServicPrestacaType. sadicinais Camp Descriçã Tip Obrigatóri Regras s Element que cntem infrmaçã relacinada cm s adicinais ListaType S Nada a bservar. Signature Assinatura digital SignatureType S Nada a bservar. Tabela 44 sadicinaistype. s Camp Descriçã Tip Obrigatóri Regras Element que cntem infrmaçã relacinada cm ItemRequisicaType S Nada a bservar. Tabela 44 ListaType. 60 de 99
Camp Descriçã Tip Obrigatóri Regras MSP Infrmaçã d assciad à linha da requisiçã MSPType S Nada a bservar. Id Identificadr únic d Text Nã cnsiderar este camp para serviç. Estad Códig d estad assciad a Text Nã cnsiderar este camp para serviç. Lateralidade Lateralidade d Text N Deve estar de acrd cm s valres registads n anex Áreas (lad) assciads a um. Prdut Tip de amstra d Text N Deve estar de acrd cm s valres registads n anex Prduts assciads a um. NAmstras Númer de amstras a reclher Numéric N Númer psitiv inteir. OutrMSP InfrmacaClinicaCmplementar Descritiv de que nã pertença à tabela de cnvencinads Infrmaçã clínica cmplementar relevante à execuçã da linha da requisiçã Text N Nada a bservar. Text N Nada a bservar. EntidadePrestadraRegist Entidade definida n mment d regist para prestar EntidadeType N Preencher cas a entidade prestadra pertença a SNS. Deverá estar registada na platafrma central. 61 de 99
Camp Descriçã Tip Obrigatóri Regras RequerAutrizaca Indica se a requisiçã requer autrizaçã para ser realizada (S/N) Text S Lista de valres: S - Sim N - Nã IsencaTaxa Indica se é isent de taxa (S/N) Text S Lista de valres: S Sim N - Nã Internalizar Indicaçã de internalizaçã da realizaçã d (S/N) Text S Lista de valres: S - Sim N" - Nã Prec Preç d Numéric Nã cnsiderar este camp para serviç. TaxaMderadra Taxa mderadra assciada a Numéric N Nada a bservar. Resultads Link ds resultads d Text Nã cnsiderar este camp para serviç. Reagendament Indica se huve reagendament d (S/N) Text Nã cnsiderar este camp para serviç. DataRealizaca Data de prestaçã d Datetime Nã cnsiderar este camp para serviç. ObservacesRecusa Observações de recusa de um Text Nã cnsiderar este camp para serviç. ObservacesAgendament Observações de agendament de um Text Nã cnsiderar este camp para serviç. ObservacesPrestaca Observações de prestaçã de um Text Nã cnsiderar este camp para serviç. ObservacesResultads Observações ds resultads btids da prestaçã de um Text Nã cnsiderar este camp para serviç. MSPServics Estrutura cm s dads necessáris as serviçs cm perações MSPServicsType Nã cnsiderar este camp para serviç. 62 de 99
Camp Descriçã Tip Obrigatóri Regras a realizar sbre um (anulaçã u autrizaçã) Tabela 44 Type. 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. PrestacaMSPOutputList Element Descriçã Tip Obrigatóri Regras _ID ResultadOperaca Identificadr d a qual crrespndem as mensagens de sucess/insucess Mensagens de sucess/insucess Numéric N Nada a bservar. CdigGenericType S Nada a bservar. ResultadOperaca 63 de 99
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. 5.3 Mensagens de retrn d serviç de agendament Códig Descriçã Tip Sucess 100007010003 Operaçã efetuada cm sucess. Sucess Requisiçã 100007021005 Requisiçã expirada. Nã cnfrme 100007022002 Data da peraçã inválida. Nã cnfrme 100007022003 Nã é pssivel reagendar a mens de 24H da data já agendada. Nã Cnfrme 100007028002 Códig d nã está identificad na platafrma central. Nã cnfrme 100007028008 Estad assciad a(s) (s) incmpatível cm a peraçã pretendida. Nã cnfrme 100007028009 inválid para númer de requisiçã indicad. Nã cnfrme Entidade 100007024007 Entidade inválida para a peraçã indicada. Nã cnfrme 100007028010 A área assciada a nã é abrangida pela entidade prestadra indicada. Nã Cnfrme Prfissinal 100007023001 Err na infrmaçã d prfissinal. Nã cnfrme 100007023002 O médic nã está identificad ns sistemas centrais da SPMS. Nã cnfrme 64 de 99
Códig Descriçã Tip Outrs errs 100007029098 Err descnhecid. Err 100007029099 Err de nã cnfrmidade cm as regras de prescriçã. Err 100007030001 Operaçã nã autrizada. Err 100007030002 Err técnic. Err 100007030003 Autenticaçã inválida. Err 100007030004 Entidade sem permissões para invcar serviç. Err 100007030005 Estrutura da mensagem incrreta. Err Tabela 59 - Mensagens de retrn d serviç de agendament. 65 de 99
6 Serviç de efectivaçã O serviç permite a efetivaçã de um que se encntre num ds seguintes estads: Agendad - AGE Aguarda Cativaçã - ACA Aguarda Agendament - AAG Send em cas de sucess atualizad estad d regist para Realizad/Aguarda resultads. A entidade prestadra a invcar este serviç terá de indicar se é uma entidade SNS u cnvencinada. N cas de ser uma entidade cnvencinada, a entidade deverá indicar brigatriamente PIN de prestaçã e númer de requisiçã. N cas de sucess será retrnada uma mensagem de sucess para cada assim cm um tken que pderá ser utilizad n serviç de anulaçã de prestaçã. N cas de nã ser retrnad um tken (Insucess) serviç irá retrnar as mensagens para cada um ds s respnsáveis pela falha e nã irá registar a efetivaçã para s s que nã pssuam qualquer prblema. 6.1 Parâmetrs de entrada ListaPrestacaMSPInput Camp Descriçã Tip Obrigatóri Regras CabecalhRequisica EntidadePrestadra Prfissinal ListaPrestaca 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 Lista de elements cm infrmaçã referente a um u mais CabecalhRequisicaPres tacatype S Nada a bservar. EntidadeType S Nada a bservar.. PrfissinalType N Nada a bservar.. ListaPrestacaType S Nada a bservar. 66 de 99
Camp Descriçã Tip Obrigatóri Regras sadicinais Element cm s dads referentes a sadicinais n mment da efetivaçã sadicinaistype 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ã cnsiderar este camp para serviç. PINPrestaca PIN de prestaçã Text C Deverá cnstar n cas de ser uma entidade cnvencinada. EntidadeSNS Indica se é uma entidade SNS Text S Deverá ser preenchid cm valr S u N. Tabela 44 CabecalhRequisicaPrestacaType. 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. 67 de 99
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. ListaPrestaca Element Descriçã Tip Ocrrência Prestaca Element que cntem infrmaçã relacinada cm a prestaçã ds s PrestacaType 1-N Prestaca Camp Descriçã Tip Obrigatóri Regras _ID MSPServic Identificadr d Estrutura cm s dads necessáris as serviçs de prestaçã sbre um Numéric S Nada a bservar. MSPServicPrestaca Type S Nada a bservar. Tabela 45 PrestacaType. 68 de 99
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ã cnsiderar este camp para serviç. Tabela 47 MSPServicPrestacaType. sadicinais Camp Descriçã Tip Obrigatóri Regras s Element que cntem infrmaçã relacinada cm s s adicinais ListaType S Nada a bservar. Signature Assinatura digital SignatureType S Nada a bservar. Tabela 44 sadicinaistype. s Camp Descriçã Tip Obrigatóri Regras Element que cntem infrmaçã relacinada cm ItemRequisicaType S Nada a bservar. Tabela 44 ListaType. 69 de 99
Camp Descriçã Tip Obrigatóri Regras MSP Infrmaçã d assciad à linha da requisiçã MSPType S Nada a bservar. Id Identificadr únic d Text Nã cnsiderar este camp para serviç. Estad Códig d estad assciad a Text Nã cnsiderar este camp para serviç. Lateralidade Lateralidade d Text N Deve estar de acrd cm s valres registads n anex Áreas (lad) assciads a um. Prdut Tip de amstra d Text N Deve estar de acrd cm s valres registads n anex Prduts assciads a um. NAmstras Númer de amstras a reclher Numéric N Númer psitiv inteir. OutrMSP InfrmacaClinicaCmplementar Descritiv de que nã pertença à tabela de cnvencinads Infrmaçã clínica cmplementar relevante à execuçã da linha da requisiçã Text N Nada a bservar. Text N Nada a bservar. EntidadePrestadraRegist Entidade definida n mment d regist para prestar EntidadeType N Preencher cas a entidade prestadra pertença a SNS. Deverá estar registada na platafrma central. 70 de 99
Camp Descriçã Tip Obrigatóri Regras RequerAutrizaca Indica se a requisiçã requer autrizaçã para ser realizada (S/N) Text S Lista de valres: S - Sim N - Nã IsencaTaxa Indica se é isent de taxa (S/N) Text S Lista de valres: S Sim N - Nã Internalizar Indicaçã de internalizaçã da realizaçã d (S/N) Text S Lista de valres: S - Sim N" - Nã Prec Preç d Numéric Nã cnsiderar este camp para serviç. TaxaMderadra Taxa mderadra assciada a Numéric N Nada a bservar. Resultads Link ds resultads d Text Nã cnsiderar este camp para serviç. Reagendament Indica se huve reagendament d (S/N) Text Nã cnsiderar este camp para serviç. DataRealizaca Data de prestaçã d Datetime Nã cnsiderar este camp para serviç. ObservacesRecusa Observações de recusa de um Text Nã cnsiderar este camp para serviç. ObservacesAgendament Observações de agendament de um Text Nã cnsiderar este camp para serviç. ObservacesPrestaca Observações de prestaçã de um Text Nã cnsiderar este camp para serviç. ObservacesResultads Observações ds resultads btids da prestaçã de um Text Nã cnsiderar este camp para serviç. MSPServics Estrutura cm s dads necessáris as serviçs cm perações MSPServicsType Nã cnsiderar este camp para serviç. 71 de 99
Camp Descriçã Tip Obrigatóri Regras a realizar sbre um (anulaçã u autrizaçã) Tabela 44 Type. 6.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çã) Text N Tken apenas será retrnad quand pedid retrnar sucess para tds s s. Tabela 48 PrestacaMSPOutputType. PrestacaMSPOutputList Element Descriçã Tip Obrigatóri Regras _ID ResultadOperaca Identificadr d a qual crrespndem as mensagens de sucess/insucess Mensagens de sucess/insucess Numéric N Nada a bservar. CdigGenericType S Nada a bservar. 72 de 99
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. 73 de 99
6.3 Mensagens de retrn d serviç de efectivaçã Códig Descriçã Tip Sucess 100007010003 Operaçã efetuada cm sucess. Sucess Requisiçã 100007021002 O númer de requisiçã nã se encntra registad na platafrma central. Nã cnfrme 100007021004 O PIN nã está de acrd cm númer de requisiçã indicad. Nã cnfrme 100007021005 Requisiçã expirada. Nã cnfrme Entidade prestadra 100007024007 Entidade inválida para a peraçã indicada. Nã cnfrme 100007028010 A área assciada a nã é abrangida pela entidade prestadra indicada. Nã cnfrme 100007022002 Data da peraçã inválida. Nã cnfrme 100007028001 Nã existem s assciads à requisiçã. Nã cnfrme 100007028002 Códig d nã está identificad na platafrma central. Nã cnfrme 100007028008 Estad assciad a(s) (s) incmpatível cm a peraçã pretendida. Nã cnfrme 100007028009 inválid para númer de requisiçã indicad. Nã cnfrme Utente 100007024016 Utente falecid. Nã cnfrme Prfissinal 100007023001 Err na infrmaçã d prfissinal. Nã cnfrme 100007023002 O médic nã está identificad ns sistemas centrais da SPMS. Nã cnfrme Outrs errs 100007029098 Err descnhecid. Err 100007029099 Err de nã cnfrmidade cm as regras de prescriçã. Err 100007030001 Operaçã nã autrizada. Err 100007030002 Err técnic. Err 100007030003 Autenticaçã inválida. Err 100007030004 Entidade sem permissões para invcar serviç. Err 100007030005 Estrutura da mensagem incrreta. Err Tabela 85 - Mensagens de retrn d serviç de efectivaçã. 74 de 99
75 de 99
7 Serviç de regist de resultads O serviç de regist de resultads permite regist em sistema, para um determinad, d respetiv link que identifica a lcalizaçã ds resultads. Adicinalmente estad d regist é atualizad para Realizad/Resultads divulgads. 7.1 Parâmetrs de entrada ListaPrestacaMSPInput Camp Descriçã Tip Obrigatóri Regras CabecalhRequisica EntidadePrestadra Prfissinal ListaPrestaca 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 Lista de elements cm infrmaçã referente a um u mais CabecalhRequisicaPres tacatype EntidadeType S Nada a bservar. Nã cnsiderar este camp para serviç. PrfissinalType N Nada a bservar. ListaPrestacaType S Nada a bservar. sadicinais Element cm s dads referentes a sadicinais n mment da efetivaçã sadicinaistype 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ã cnsiderar este camp para serviç. 76 de 99