Layout de integração com webservices de clientes. Agendamento on-line

Transcrição

1 Lyout de interção com webservices de clientes Aendmento on-line Objetivo Este documento tem o objetivo de presentr os webservices necessários pr interr o Módulo de Aendmento On-line d Mobile Súde com o softwre de estão de clinics d su operdor. Necessidde Disponibilizr os beneficiários cesso um rotin de utotendimento pr endmento de consults e procedimentos vi plictivo mobile e web. O beneficiário poderá pesquisr, endr, consultr e cncelr sus ends qulquer momento em qulquer pltform. Solução Propost A Mobile Súde fornecerá por meio deste documento os lyouts necessários pr construção de um conjunto de webservices de interção com o seu sistem de estão de clinics pr vibilizr s fciliddes do endmento online os seus beneficiários. Os webservices propostos neste documento vism tender um fluxo de utotendimento já consoliddo do ponto de vist d usbilidde junto o usuário finl, o seu beneficiário. É essencil reproduzi-los com máxim fidelidde. Obritoriedde Além dos Webservices descritos neste documento, interção dest funcionlidde depende tmbém d implementção dos WebServices de loin, descritos no documento Cliente 03 - lyout de interção com webservices de clientes - utenticção do beneficiário Método Loin. Pdrões de webservices Estmos fmilirizdos trblhr com webservice nos pdrões REST e SOAP. List de métodos que serão descritos, rupdos por processo: Busc de ends o especilidde_disponivel o servico_disponivel o locl_tendimento_disponivel contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

2 o o o profissionl_disponivel end_do_profissionl rde_horrios_end Aendmento o vlid_utorizco_previ o rv_endmento o confirm_presenc o cncel_endmento Consult ends rvds o sttus_ends_pciente o end_pciente o end_detlhes Obritoriedde Além dos Webservices descritos neste documento, interção dest funcionlidde depende tmbém d implementção dos WebServices de loin, descritos no documento Cliente 03 - lyout de interção com webservices de clientes - utenticção do beneficiário Método Loin. Aendmento online completo: pr utiliz-lo, todos os métodos são obritórios. Pesquis de endmento: Cso su empres deseje interr pens um pesquis de endmentos, todos os métodos do rupmento Consult ends rvds devem ser implementdos. Prmetrizções d busc de profissionis contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

3 Fluxo d plicção: 1. O usuário selecion dt inicil de busc e o sistem relizrá tods s verificções considerndo disponibiliddes prtir dest dt 2. Selecion o pciente dentre os beneficiários do seu rupo fmilir 3. Selecion especilidde que lhe interess. Opcionlmente poderá selecionr um exme (serviço) disponível pr especilidde seleciond 4. Opcionlmente poderá selecionr um ds uniddes em um list que mostr quis uniddes tendem especilidde/exme (serviço) seleciondo 5. Opcionlmente poderá informr o nome do médico desejdo Observção: os métodos que serão descritos bixo considerm que o usuário do plictivo já selecionou s etps 1 e 2 do fluxo: dt inicil e o pciente. método: pciente_disponivel Este método é chmdo qundo o beneficiário toc no cmpo Pciente (ver imem cim). contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

4 Importnte: esse método é OPCIONAL. Cso su empres não implemente o método, todos os beneficiários d fmíli serão exibidos. Rers de neócio O método deverá receber como prâmetro dt inicil informd nos prâmetros, ssim como chve únic do beneficiário; O método deverá considerr s rers de neócio d operdor e só retornr os identificdores únicos de beneficiários que possm ser listdos pr endmento; O método só pode devolver códios únicos de beneficiários que tenhm sido devolvidos no método de loin. Cso o identificdor não sej encontrdo no retorno d fmíli do beneficiário lodo, este não será exibido. chve_benefici Sim Chve únic do beneficiário no seu sistem de rio dt_referenci estão. Dte Sim Dt que será levd em considerção pr listr os beneficiários com direito o endmento. Estrutur de retorno sttus Bool Sim True = indic que requisição foi bem sucedid motivo_critic beneficirios _utorizdos Flse = Indic que requisição não foi bem sucedid Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry Não Retorn um rry de estruturs beneficirios (ver de estrutur bixo), contendo os identificdores únicos Objet dos beneficiários utorizdos terem ends os mrcds pelo endmento online. benefi cirio Este cmpo é obritório qundo o sttus for TRUE. s Definição d estrutur beneficirios. propriedde Tipo Obri Descrição Identificdor_benefi cirio Sim Códio único que identific o beneficiário.. Este cmpo deve ser relciondo com o contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

5 cmpo chve_beneficirio objeto usuário - método loin webservice ws_loin_service.. Documentção pr esse método disponível em: Confiure-o-loin-crtão-deidentificção-e-componente-cdstrl-do-PIN-SSinterndo-com-nossos-WebServices. método: especilidde_disponivel Este método deverá considerr o pciente e dt de strt informdos pelo usuário do pp e retornr s especiliddes disponíveis pr endmento. Este método é chmdo qundo o beneficiário toc no cmpo Especilidde (ver imem cim). Rers de neócio O método deverá receber como prâmetro dt inicil informd nos prâmetros, ssim como chve únic do beneficiário O método deverá considerr s rers de neócio d operdor e só retornr s especiliddes que tendm ests rers, tis como: o Plno do pciente seleciondo tem cobertur pr especilidde? o O sexo do pciente seleciondo é comptível com especilidde? o A idde do pciente seleciondo é comptível com especilidde? o Entre outrs o Demis rers que su operdor pode implementr / vlidr O método deverá retornr pens s especiliddes que possuem pelo menos um end livre pr mrcção, prtir d dt inicil Propriedde Tipo Obri Descrição contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

6 chve_benefici rio dt_referenci Sim Chve únic do beneficiário no seu sistem de estão. Dte Sim O webservice deverá considerr especiliddes com pelo menos um end livre prtir dest dt. Cso de uso: um beneficiário que vij muito e só estrá n su cidde ntl prtir do di 20/02/2015. Ao prmetrizr um busc, ele irá informr est dt, pois pr ele só interess ends prtir dest dt. Estrutur de retorno sttus Bool Sim True = indic que requisição foi bem sucedid motivo_critic especilidd es Flse = Indic que requisição não foi bem sucedid Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry Não Retorn um rry de estruturs especilidde (ver de estrutur bixo), contendo s especiliddes Objet disponíveis pr endmento prtir d dt os informd pr o beneficiário. especi lidd Este cmpo é obritório qundo o sttus for TRUE. e lert Não Cso queri envir lum lert pr ser presentdo o beneficiário qundo ele cessr seleção de especiliddes, bst preencher ess propriedde. Definição d estrutur especilidde. propriedde Tipo Obri Descrição especilidde_id Sim Códio d especilidde no sistem d operdor Especilidde_descr ico Sim Descrição d especilidde no sistem d operdor cbos Não Códio CBOS d especilidde. lert Não Cso queir envir lum lert pr ser presentdo o beneficiário qundo ele selecionr est especilidde, bst preencher ess propriedde. Exemplo: Pr endmento com nutricionist, é contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

7 necessário presentr encminhmento do endocrinoloist. exie_utorizco Bool Não Qundo este cmpo for TRUE o plictivo irá brir um popup pr o usuário informr o numero d utorizção prévi, loo pós selecionr especilidde. Ao confirmr o popup o sistem irá chmr o método /vlid_utorizco_previ pr confirmr se o códio informdo é válido e só irá permitir continur o processo se o retorno de /vlid_utorizco_previ for TRUE. Método: servico_disponivel Este método deverá considerr o pciente, dt inicil e especilidde seleciondos pelo usuário do enddor e retornr list de exmes/serviços disponíveis. Observção: serviço pode ser um consult, um list de exmes ou demis serviços prestdos pelo estbelecimento de súde n especilidde seleciond. Rers de neócio O método deverá receber como prâmetro dt inicil, chve únic do beneficiário e especilidde seleciondos nos prâmetros. O método deverá considerr s rers de neócio d operdor e só retornr os serviços que tendm ests rers, tis como: o Plno do pciente seleciondo tem cobertur pr o serviço? o O sexo do pciente seleciondo é comptível com o serviço? o A idde do pciente seleciondo é comptível com o serviço? o Entre outrs O método deverá retornr pens serviços que possuem pelo menos um end livre pr mrcção, prtir d dt inicil chve_benefici Sim Chve únic do beneficiário no seu sistem de rio dt_referenci estão. Dte Sim O webservice deverá considerr locis de tendimento disponíveis prtir dest dt. contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

8 especilidde_i d Sim Códio d especilidde item já seleciondo nteriormente Estrutur de retorno sttus Bool Sim True = indic que requisição foi bem sucedid motivo_critic servicos Flse = Indic que requisição não foi bem sucedid Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry Sim Retorn um rry de estruturs servico (ver estrutur de bixo), contendo os serviços disponíveis pr Objet endmento prtir d dt e especilidde os informd pr o pciente. servic o Este cmpo é obritório qundo o sttus for TRUE. lert Não Cso queri envir lum lert pr ser presentdo o beneficiário qundo ele cessr view de seleção de serviços, bst preencher ess propriedde. Definição d estrutur servico. propriedde Tipo Obri Descrição servico_id Sim Códio interno do serviço procedimento Sim Códio do procedimento servico_descrico Sim Descrição do procedimento exie_utorizco Bool Não Qundo este cmpo for TRUE o plictivo irá brir um popup loo pós selecionr o serviço pr o usuário informr o número d utorizção prévi. Ao confirmr o popup o sistem irá chmr o método /vlid_utorizco_previ pr confirmr se o códio d mesm é válido e só irá permitir continur o processo se o retorno de /vlid_utorizco_previ for verddeiro. Se utorizção já tiver sido informd o selecionr especilidde, o popup de serviço será inordo. contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

9 Método: locl_tendimento_disponivel Este método deverá considerr o pciente, dt inicil, especilidde e o exme/serviço seleciondos pelo usuário do enddor e retornr list de locis de tendimento disponíveis pr endmento. Este método é chmdo qundo o beneficiário toc no cmpo Locl (ver imem cim). Rers de neócio O método deverá receber como prâmetro dt inicil, chve únic do beneficiário, especilidde e o códio do serviço seleciondos nos prâmetros. O método deverá considerr s rers de neócio d operdor e só retornr os locis de tendimento que tendm ests rers, tis como: o Plno do pciente seleciondo tem cobertur pr o Locl de tendimento? o O locl de tendimento prest tendimento pr especilidde/serviço seleciond? o O locl de tendimento tem end disponível? O método deverá retornr pens Locis de Atendimento que possuem pelo menos um end livre pr mrcção, prtir d dt strt chve_benefici Sim Chve únic do beneficiário no seu sistem de rio dt_referenci estão. Dte Sim O webservice deverá considerr locis de tendimento disponíveis prtir dest dt. Cso de uso: um beneficiário que vij muito e só estrá n su cidde ntl prtir do di 20/02/2015. Ao prmetrizr um busc, ele irá informr est dt, pois pr ele só interess ends prtir dest dt. especilidde_i Sim Códio d especilidde d servico_id Sim Códio do serviço Estrutur de retorno Propriedde Tipo Obri Descrição contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

10 sttus Bool Sim True = indic que requisição foi bem sucedid motivo_critic locis Flse = Indic que requisição não foi bem sucedid Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry Sim Retorn um rry de estruturs locl_tendimento de (ver estrutur bixo), contendo os Locis disponíveis Objet pr endmento prtir d dt, especilidde e os serviço informdo pelo beneficiário. locl_ tendi ment o lert Não Cso queri envir lum lert pr ser presentdo o beneficiário qundo ele cessr seleção de Locl de Atendimento, bst preencher ess propriedde. Definição d estrutur locl_tendimento. propriedde Tipo Obri Descrição locl_id Sim Códio do locl de tendimento no sistem d operdor locl_descrico Sim Descrição do locl de tendimento locl_endereco Sim Endereço do locl de tendimento locl_numero Não Numero do endereço do locl de tendimento locl_complemento Não Complemento do endereço do locl de tendimento locl_birro Não Birro do endereço do locl de tendimento locl_cidde Sim Texto descritivo do nome d cidde do locl de tendimento locl_cidde_id Não Códio d cidde no cdstro do IBGE locl_estdo Sim Sil d UF correspondente o estdo do locl de tendimento, como por exemplo SP, RJ, SC e etc... locl_cep Não CEP do locl de tendimento. Informe o locl_telefone Não conteúdo com máscr pr o CEP (XX.YYY-ZZZ) Telefone do locl de tendimento, preferencilmente n já formtdo, exemplo: contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

11 locl_prioridde Não (27) ou Indic se esse locl deverá precer em destque, em um áre seprd dos demis locis. locl_prioridde_orde m S = Sim, prioriz o locl N = Não prioriz Vzio = Não prioriz Int Não Indic em qul posição o locl deve precer dentro d sessão de destques / prioriddes Este cmpo só será considerdo se o cmpo prioridde for iul S. lert Não Info: qunto menor o conteúdo informdo neste cmpo, mis cim o item precerá. Cso queri envir lum lert pr ser presentdo o beneficiário qundo ele selecionr o Locl de Atendimento, bst preencher ess propriedde. Método: profissionl_disponivel Este serviço é utilizdo pr retornr os profissionis disponíveis pr endmento. Este webservice tem que ser preprdo pr responder pesquis pelo nome do profissionl cso o nome sej informdo nos prâmetros de busc pelo usuário do pp. Rers de neócio contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

12 O método deverá receber por prâmetro dt inicil, chve únic do beneficiário, especilidde, o serviço e opcionlmente, o Locl e o nome do prestdor O método deverá considerr s rers de neócio d operdor e só retornr os profissionis que tendm tis rers Retornr pens profissionis que tenh pelo menos um horário livre pr endmento Suestão: ordenr list de médicos com bse n dt d primeir end disponível, priorizndo ssim o profissionl que tem end mis próxim. Cso sej informdo o nome do profissionl, o método deverá desconsiderr o prâmetro de locl de tendimento, plicr o filtro tipo like %nome% e retornr pens os reistros correspondentes. chve_benefici rio Sim Chve únic do beneficiário no seu sistem de estão dt_referenci Dte Sim O webservice deverá considerr médicos com ends disponíveis prtir dest dt especilidde_i Sim Códio d especilidde d servico_id Não Códio do serviço locl_id Não Códio do locl de tendimento nome Não Nome do profissionl. Qundo informdo, desconsiderr o locl de tendimento e plicr filtro tipo LIKE %nome% e retornr pens profissionis que correspondem o termo informdo. Estrutur de retorno sttus Bool Sim True = indic que requisição foi bem sucedid Flse = Indic que requisição não foi bem sucedid motivo_critic Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

13 profissionis Arry de Objet os profis sionl Sim iul Flse Retorn um rry de estruturs profissionl (ver estrutur bixo), contendo os profissionis disponíveis pr endmento, conforme prâmetros de busc. lert Não Cso sej necessário presentr um mensem pr o beneficiário no momento em que relção de profissionis é presentd, bst informr o texto qui. Definição d estrutur profissionl. propriedde Tipo Obri Descrição profissionl_id Sim Códio do profissionl do sistem d operdor profissionl_nome Sim Nome do profissionl locl_telefone Não Telefone de contto do locl de tendimento do profissionl locl_id Sim Códio do Locl de tendimento locl_descrico Sim Nome do Locl de tendimento locl_endereco Sim Endereço do locl de tendimento locl_numero Não Numero do endereço do locl de tendimento locl_complemento Não Complemento do endereço do locl de tendimento locl_birro Não Birro do locl de tendimento locl_estdo Sim Sil d UF correspondente o estdo do locl de tendimento, como por exemplo SP, RJ, SC e etc... locl_cidde_id Não Códio d cidde conforme IBGE (7 posições) locl_cidde Sim Texto descritivo do nome d cidde do locl de tendimento locl_cep Não Cep do locl de tendimento informdo com máscr de CEP. primeir_end Dte Time Sim Dt e hor d primeir end disponível pr o profissionl / equipmento quntidde_ends Int Não N list de médicos / equipmentos é possível contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

14 _disponiveis presentr quntidde de ends disponíveis. Bst envir quntidde neste cmpo lert Não O sistem presentrá 1 end em destque e informrá bixo um termo + XX ends disponíveis. Cso queir presentr um mensem pr o usuário qundo ele selecionr este profissionl, envie o texto neste cmpo Aendmento de consults Método: end_do_profissionl Este método é utilizdo pr retornr os dis d end do profissionl ou equipmento com bse nos prâmetros informdos pelo usuário Rers de neócio O método deverá processr end do profissionl e retornr pens os dis que possuem pelo menos um horário livre, conforme prâmetros informdos pelo usuário Pr mximizr performnce de trnsferênci de ddos em dispositivos com internet 3G, é interessnte retornr no máximo 10 dis por vez, prtir d dt de referenci informd por prâmetro e deixr que o plictivo se encrreue pel pinção ds requisições chve_benefici rio Sim Chve únic do beneficiário no seu sistem de estão profissionl_id Sim Códio do profissionl do sistem d operdor dt_referenci Dte Sim O webservice deverá retornr end do médico/equipmento prtir dest dt especilidde_i Sim Códio d especilidde d servico_id Não Códio do serviço locl_id Não Códio do locl de tendimento contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

15 Estrutur de retorno sttus Bool Sim True = indic que requisição foi bem sucedid Flse = Indic que requisição não foi bem sucedid motivo_critic Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse primeir_e Dte Sim Dt e hor d primeir end disponível pr o nd disponibilidd es Arry de Objeto s disponi bilidd e Sim profissionl / equipmento Retorn um rry de estruturs disponibilidde (ver estrutur bixo), contendo s dts em que o profissionl ou equipmento possui pelo menos um horário disponível Alert Não Cso sej necessário presentr um mensem pr o beneficiário no momento em que end do profissionl for presentd, informr o texto qui. Definição d estrutur disponibilidde. propriedde Tipo Obri Descrição Dt Dte Sim Dt d end. Formto: yyyy-mm-dd Método: rde_horrios_end Este método é utilizdo pr retornr os horários d end do profissionl ou equipmento com bse em um dt informd por prâmetro. Rers de neócio O método deverá receber por prâmetro chve únic do beneficiário, especilidde, o serviço, o locl, o códio do profissionl e um dt O método deverá retornr rde de horários livres do profissionl d referid dt É interessnte presentr n end os horários já mrcdos pr os beneficiários do mesmo rupo fmilir. Isso fcilit identificção de horários já mrcdos, evit mrcções indevids e no-show. Pr que o contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

16 plictivo mostre os horários já mrcdos pr os beneficiários do mesmo rupo fmilir, bst envir mtricul dele nest propriedde Propriedde Tipo Obri Descrição chve_benefici rio Sim Chve únic do beneficiário no seu sistem de estão especilidde_i Sim Códio d especilidde d servico_id Sim Códio do serviço locl_id Sim Códio do locl de tendimento do profissionl que foi seleciondo pelo usuário profissionl_id Sim Códio do profissionl dt Dte Não Dt d end solicitd Estrutur de retorno sttus Bool Sim True = indic que requisição foi bem sucedid motivo_critic horrios Flse = Indic que requisição não foi bem sucedid Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry Sim Retorn um rry de estruturs horrio (ver estrutur de bixo), contendo s dts em que o profissionl ou Objet equipmento possui pelo menos um horário disponível os horri o lert Não Cso sej necessário presentr um mensem pr o beneficiário no momento em que end do profissionl for presentd, informr o texto qui. Definição d estrutur horrio. propriedde Tipo Obri Descrição dt Dte Sim Dt d end Formto: yyyy-mm-dd hor Sim Hor inicil d end contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

17 Formto: hh:mm end_id Int Não Cso o sistem d operdor tenh um reistro no bnco de ddos pr cd horário d mtriz de disponibilidde, o códio do reistro corresponde este horário deverá ser envido nest propriedde. chve_bene ficirio nome_benefi cirio Não É interessnte presentr n end os horários já mrcdos pr os beneficiários do mesmo rupo fmilir. Isso fcilit identificção de horários já mrcdos, evit mrcções indevids e no-show. Pr que o plictivo mostre os horários já mrcdos pr os beneficiários do mesmo rupo fmilir, bst envir mtricul dele nest propriedde Não É interessnte presentr n end os horários já mrcdos pr os beneficiários do mesmo rupo fmilir. Isso fcilit identificção de horários já mrcdos, evit mrcções indevids e desperdício de ends. Pr que o plictivo mostre os horários já mrcdos pr os beneficiários do mesmo rupo fmilir, bst envir o nome dele nest propriedde Aendmento Método: vlid_utorizco_previ Este método é utilizdo pr confirmr vlidde do códio d utorizção prévi, diitd pelo usuário qundo o tendimento exiir utorizção prévi Rers de neócio O método deve receber chve únic do beneficiário e o códio d utorizção prévi O método deve retornr se o códio d utorizção prévi é válido ou não O método não deve mrcr como utilizdo, ele deve pens retornr se é vlido ou não Propriedde Tipo Obri Descrição chve_beneficiri o Sim Chve únic do beneficiário no seu sistem de estão numero_utoriz co Não Número d utorizção prévi, cso tenh sido informd pelo usuário pós selecionr contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

18 especilidde Estrutur de retorno sttus Bool Sim True = indic que utorizção é válid e utoriz continução do processo de endmento do pciente motivo_critic recomendc oes Flse = Indic que utorizção não é mis válid e proíbe continução do processo Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry Não Retorn um rry de estruturs recomendco (ver de estrutur no método rv_endmento), contendo Objet s recomendções sobre utorizção prévi. os recom Cso de uso: endc 1 utorizção válid por 20 dis o 2 obritório presentr encminhmento do endocrinoloist Método: rv_endmento Este método é utilizdo pr rvr end seleciond pelo beneficiário Rers de neócio O método deve nlisr s rers de neócio do plno e contrto do beneficiário O método deve verificr se end ind está disponível Relizr controle de semáforo Dr bix n utorizção prévi, cso tenh sido informd pelo usuário pós selecionr especilidde o Sinlizr utorizção como utilizd pr que não poss ser utilizd novmente Durnte o processo de endmento, pedimos pr o beneficiário confirmr o seu telefone e o emil. Este método pode tulizr estes ddos no cdstro do beneficiário. Suerimos que sej implementd ess lóic pr fcilitr comunicção com o beneficiário em cso de mudnç de end ou qulquer comunicção com o cliente. contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

19 Propriedde Tipo Obri chve_beneficiri Sim o numero_utoriz co end_id Não Não Descrição Chve únic do beneficiário no seu sistem de estão Número d utorizção prévi, cso tenh sido informd pelo usuário pós selecionr especilidde Cso o sistem d operdor tenh um reistro no bnco de ddos pr cd horário d mtriz de disponibilidde, o códio do reistro corresponde este horário deverá ser envido nest propriedde. dt_hor end_confirm d Se não for o cso, este códio deve ser envido vzio Não Se o sistem não possui um ID d end pr relizr o endmento, será necessário envir este prmento, contendo dt e hor seleciond pelo pciente. Este prâmetro só será necessário cso não sej possível trblhr com end_id. Bool Sim Se o seu processo de endmento requer confirmção d end pelo beneficiário, liue este fl locl_id especilidde_id profissionl_id Não Não Não True = indic que end está confirmd e não será necessário que o pciente confirme end Flse = Indic que end não está confirmd e o pciente terá que confirmr end pelo plictivo ou vi SMS ou emil. Se o seu processo de endmento não exiir confirmção de ends pelo beneficiário, informe sempre TRUE neste Este prâmetro só será necessário cso não sej possível trblhr com end_id. Neste cso será necessário informr o códio do locl. Este prâmetro só será necessário cso não sej possível trblhr com end_id. Neste cso, será necessário informr o códio d especilidde. Este prâmetro só será necessário cso não sej possível trblhr com end_id. Neste cso, será necessário informr o códio do profissionl. telefone_pciente Não Durnte o processo de endmento, pedimos pr contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

20 emil_pciente oriem Não Sim o beneficiário confirmr o seu telefone. Neste momento enviremos o numero informdo por ele pr que sej tulizdo n bse de ddos. Durnte o processo de endmento, pedimos pr o beneficiário confirmr o seu emil. Neste momento enviremos o numero informdo por ele pr que sej tulizdo n bse de ddos. Indic oriem do endmento pr permitir erção de esttístics de tendimento. 0 = ios 1 = Android 2 = Web 9 = Reservdo pr outros dispositivos Estrutur de retorno sttus Bool Sim True = indic que o endmento foi relizdo com sucesso motivo_critic recomendc oes Flse = Indic que o endmento não foi relizdo Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry Não Retorn um rry de estruturs recomendco (ver de estrutur bixo), contendo s recomendções sobre Objet su consult ou procedimento. os recom endc o Cso de uso: 1 - Comprecer com 30 minutos de ntecedênci. 2 Trzer tênis e bermud pr o teste erométrico. 3 Comprecer compnhdo end_id Não Retorn o códio d end cso el tenh sido erd no to d rvção Este retorno será usdo por outros métodos, qundo for necessário referencir este endmento. Definição d estrutur recomendco. propriedde Tipo Obri Descrição ordem Int Sim A ordem em que deverá ser presentd n tel de recomendções o finl do endmento recomendc o Sim Texto descritivo d recomendção o beneficiário contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

21 Método: confirm_presenc Este método é utilizdo pr rvr confirmção de presenç d end. A confirmção d end pode ser feit pelo usuário por meio do plictivo mobile, ou respondendo um SMS, ou in-pp ou e-mil. Rers de neócio O método deve receber o id d end O método deve nlisr rer de neócio o Se ind é possível confirm n dt e hor requisitdo end_id Sim Códio d end ser confirmd Estrutur de retorno sttus Bool Sim True = indic que confirmção d end foi relizd com sucesso motivo_critic recomendc oes Flse = Indic que não foi possível confirmr end Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry Não Retorn um rry de estruturs recomendco (ver de estrutur no método rv_end), contendo s Objet recomendções sobre confirmção d end os recom Cso de uso: endc 1 em cso de flt, será cobrdo 70% do vlor d o consult 2 em cso de flt, hverá um bloqueio de 30 dis pr novos endmentos contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

22 Método: cncel_endmento Este método é utilizdo pr cncelr um end Rers de neócio O método deverá receber o códio d end Anlisr s rers de neocio, tis como o Est dentro do período permitido pr cncelmentos? o Deverá err coprticipção pr o beneficiário? end_id Sim Códio d end ser excluíd Estrutur de retorno sttus Bool Sim True = indic que o endmento cnceldo com sucesso motivo_critic Flse = Indic que o endmento não foi cnceldo Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse lert Não Cso queir presentr um lert pr o beneficiário pos o cncelmento, envie o texto neste cmpo. Consult ends rvds Método: sttus_ends_pciente Este método deve retornr os sttus d end. Este método é utilizdo pelo método ends_pciente descrito seuir. Suestão de sttus - Em berto - Relizds - Cncelds - Flts contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

23 Propriedde Tipo Obr Descrição i No se plic - - Não se plic Estrutur de retorno propriedde Tipo Obri Descrição sttus Bool Sim True = indic que requisição foi relizd com sucesso Flse = Indic que requisição não teve sucesso motivo_critic sttus_en d Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry de Objeto s sttus_ end Sim Retorn um rry de estruturs sttus_end (ver estrutur bixo) Definição d estrutur sttus_end. propriedde Tipo Obri Descrição sttus_id Sim Códio identificdor do sttus sttus_descrico Sim Descrição do sttus Método: ends_pciente Este serviço é utilizdo pr retornr os endmentos do pciente de cordo com o período que su empres desejr. Pr mior trnsprênci com o beneficiário, envir os reistros de ends Em berto, Aends executds, Aends cncelds (pelo pciente / instituição) e ends fltoss. Rers de neócio O método deverá receber por prâmetro chve únic do beneficiário e o sttus desejdo O método deve ser preprdo pr retornr ends de todos os sttus ou de um sttus especificdo por prâmetro Retornr o histórico de ends dos últimos 12 meses contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

24 Propriedde Tipo Obri Descrição chve_benefici rio Sim Chve únic do beneficiário no seu sistem de estão sttus_id Não Códio identificdor do sttus Rer: identificdor de sttus será informdo qundo necessário demonstrr pens um sttus específico. Se for deixdo sem conteúdo, devem ser exibidos todos os sttus existentes. Estrutur de retorno Propriedde Tipo Obri Descrição sttus Bool Sim True = indic que requisição foi relizd com sucesso Flse = Indic que requisição não teve sucesso motivo_critic Aendment os Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse Arry de Objeto s end mento Sim Retorn um rry de estruturs endmento (ver estrutur bixo), contendo tods s ends em berto mis o histórico do período confiurdo em seus serviços. Importnte: existênci dest propriedde é obritóri, ms el poderá ser envid vzi, qundo nenhum endmento for encontrdo. Definição d estrutur endmento. propriedde Tipo Obri Descrição end_id Sim Códio do endmento dt_hor Dte Não Dt e hor time sttus_id Sim Códio do sttus end_confirm d Suestão: - Em berto - Relizds - Cncelds - Flts Bool Sim Indic se end está confirmd. Este fl irá controlr o botão de confirmção n list de ends contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

25 True = Aend confirmd. O pp não present o botão pr o usuário confirmr end Flse = Aend não confirmd. O pp present o botão pr o usuário confirmr end Se o seu processo de endmento não exiir confirmção de ends pelo beneficiário, informe sempre TRUE neste cmpo. especilidde_id Sim Códio d especilidde especilidde_d Sim Descrição d especilidde escrico chve_benefici rio Sim Códio do beneficiário mrcdo no endmento nome_beneficir Sim Nome do beneficiário io profissionl_id Sim Códio do profissionl profissionl_no Sim Nome do profissionl me locl_id Sim Códio do locl de tendimento Locl_descrico Sim Nome do locl de tendimento Método: end_detlhes Este serviço é utilizdo pr retornr os detlhes de um endmento. Propriedde Tipo Obri Descrição end_id Sim Códio do endmento ser detlhd Estrutur de retorno Propriedde Tipo Obri Descrição sttus Bool Sim True = indic que requisição foi relizd com sucesso Flse = Indic que requisição não teve sucesso motivo_critic Não Qundo o sttus for iul Flse, envie nest propriedde o motivo pelo qul não foi possível relizr requisição. Este cmpo é obritório qundo o sttus iul Flse contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

26 detlhes Objeto detlhe s Sim Retorn um objeto único contendo estrutur detlhes (ver estrutur bixo), Definição d estrutur endmento. propriedde Tipo Obri Descrição end_id Sim Códio do endmento no sistem d operdor dt_hor Dte Sim Dt e hor do endmento time sttus_id Sim Códio do sttus cncelmento_d t_hor Dte time Não Se end estiver cnceld, informr dt e hor do cncelmento cncelmento_ motivo Não Se o endmento estiver cnceldo, informr o motivo do cncelmento, se existir tendimento_d t_hor Dte time Não Se end foi relizd, informr hor e hor do tendimento do tendimento tendimento_no t Int Não Not de vlição dd pelo pciente o tendimento especilidde_id Sim Códio d especilidde especilidde_d Sim Descrição d especilidde escrico chve_benefici rio Sim Códio do beneficiário mrcdo no endmento beneficirio_em Não Emil do beneficiário il beneficirio_tele Não Telefone do beneficiário fone profissionl_id Sim Códio do profissionl profissionl_no Sim Nome do profissionl me locl_id Sim Códio do Locl de tendimento locl_telefone Não Telefone de contto do locl de tendimento locl_descrico Sim Nome do Locl de tendimento locl_endereco Sim Endereço do locl de tendimento locl_numero Não Numero do endereço do locl de tendimento locl_compleme nto Não Complemento do endereço do locl de tendimento locl_birro Não Birro do locl de tendimento locl_estdo Sim Sil d UF correspondente o estdo do locl de tendimento, como por exemplo SP, RJ, SC e etc... locl_cidde_id Não Códio d cidde locl_cidde Sim Texto descritivo do nome d cidde do locl de contto@ R. Aenor Amro dos Sntos, 785 sl 3 -

27 tendimento locl_cep Sim Cep do locl de tendimento recomendcoes Arry de objeto recom endc o beneficirio_no me Retorn um rry de estruturs recomendco (ver estrutur n definição do ws rv_endmento), contendo s recomendções sobre su consult ou procedimento. Cso de uso: 1 - Comprecer com 30 minutos de ntecedênci. 2 Trzer tênis e bermud pr o teste erométrico. 3 Comprecer compnhdo Sim Devolver o nome do beneficiário que está tribuído pr o tendimento já enddo. contto@ R. Aenor Amro dos Sntos, 785 sl 3 -