- Skapad av Martin Carlman den okt. 22, 2019
Du visar en gammal version av den här sidan. Visa nuvarande version.
Jämför med nuvarande Visa sidhistorik
Version 1 Nästa »
Inkorgsfunktionen är baserad på tjänstekontrakten i tjänstedomänen Patientportal. 1177 Vårdguidens e-tjänster är anslutet till Nationella tjänsteplattformen som producent av dessa tjänstekontrakt. Anslutande system ska anpassas till tjänstekontrakten för att kunna anlutas till Nationella tjänsteplattformen som konsument av dessa. Läs mer på Tjänstekontrakt och Nationella tjänsteplattformen.
Tjänstekontrakt | Syfte |
---|---|
IsActiveUser | Används för att kontrollera om en invånare är användare av den nationella patientportalen 1177 Vårdguidens e-tjänster. Returnerar även aktiv användares inställningar för avisering. |
AddMessageToPatientPortalInbox | Används för att adressera meddelanden till en invånare genom den nationella patientportalen 1177 Vårdguidens e-tjänster. |
Uthoppslänkar (SSO)
Anslutande system kan konfigureras för att stödja uthopp/länkning med sömlös övergång (SSO) för att på så sätt låta invånaren hitta tillbaka till konsumentsystemet via en uthoppslänk i inkorgsmeddelandet. Uthoppslänken kan konfigureras på två olika sätt:
Genom att inkludera XML-elementet message.ssoLink och dess underlement.
Genom att konfigurera länken direkt i meddelandetexten inom DocBook-elementet ulink.
Avsändaren kan avgöra om denne vill att meddelandet ska aviseras invånaren om möjligt. Om avisering sker, och i så fall med vilken metod (sms och/eller e-post), beror på invånarens personliga inställningar i 1177 Vårdguidens e-tjänster.
För att komma igång är initialt två konfigurationsparametrar aktuella, varav den ena är obligatorisk.
Parameter | Beskrivning | Obligatorisk |
---|---|---|
systemId | Erhålls av förvaltningen för 1177 Vårdguidens e-tjänster. Används för att identifiera konsumentssystemet hos 1177 Vårdguidens e-tjänster. Systemid är obligatoriskt att skicka med i elementet som heter sourceSystem, som är en del av tjänstekontraktet AddMessageToPatientPortalInbox. Systemid används också som ett id-begrepp för att hitta igen den konfigurerade bas-URL:en, om konsumenten valt att använda sig av en sådan. | Ja |
bas-URL | Delges förvaltningen för 1177 Vårdguidens e-tjänster tekniska förvaltning om anslutande part avser använda konfigurerbara länkar i meddelandet. | Nej |
Informationsmappning mellan tjänstekontrakten och invånarens vyer
Detta avsnitt visar hur 1177 Vårdguidens e-tjänster presenterar innehållet i XML-meddelanden som skickas genom tjänstekontaktet AddMessageToPatientPortalInbox. Tabellen under bilderna visar mappningen mot de ingående elementen i XML-meddelandet.
Inkorg
I inkorgen visas ärenden och meddelanden. I den övergripande listan visas vad som kallas huvudärenden. Klickar man på ett ärende eller meddelande öppnas det och man ser meddelandets detaljer. I den detaljerade vyn ser man även ”trådade” meddelanden. Ett huvudärende kan ha flera ”trådade” meddelanden.
Konsumenten kan själv styra rubriken eller beskrivningen av meddelandet. Detta görs genom att sätta ett värde för elementet messageDescription. Sätter man inget värde är default-värdet Meddelande. Ett meddelande är markerat som oläst i inkorgen tills användaren öppnat det och tittat på dess detaljer.
Figur | XML-element | Beskrivning |
---|---|---|
1 | message.organisationUnit.unitName | Avsändande vårdenhets namn. |
2 | message.messageDescription | Meddelandets rubrik. |
Meddelande
När man klickat på ett meddelande i inkorgen visas dess detaljer. Den större delen av vad som visas är förstås själva meddelandet. Som konsument kan man även styra utseende av andra detaljer. Rubriken för meddelandets detaljerade information tas även den från vad som konsumenten anger i messageDescription enligt ovan. Däremot är defaultvärdet blankt om man inte anger något, alltså inte "Meddelande", som i listan med huvudärenden. Man kan även ange information om mottagningen som står som avsändare för meddelandet. Detta görs genom att ange värden i (underelementen till) elementet organisationUnit. Inkorgsmeddelandet visar den information som konsumenten anger. Det hämtas alltså ingen information från HSA eller 1177 Vårdguidens e-tjänsters register av mottagningar.
Figur | XML-element | Beskrivning |
---|---|---|
1 | message.messageDescription | Meddelandets rubrik. |
2 | message.organisationUnit.unitName | Avsändande vårdenhets namn. Klick tar invånaren till vårdenhetens kontaktkort i 1177 Vårdguidens e-tjänster. Detta förutsätter att avsändande vårdenhets HSA-id (message.organisationUnit.unitId) är anslutet till 1177 Vårdguidens e-tjänster. |
3 | - | Klick visar/döljer information om avsändande vårdenhet (figur 4, 5, 6 och 7). |
4 | message.organisationUnit.unitAddress | Avsändande vårdenhets adress. Visas om avsändande vårdenhets HSA-id (message.organisationUnit.unitId) är anslutet till 1177 Vårdguidens e-tjänster. |
5 | message.organisationUnit.unitPostalCode | Avsändande vårdenhets postnummer. Visas om avsändande vårdenhets HSA-id (message.organisationUnit.unitId) är anslutet till 1177 Vårdguidens e-tjänster. |
6 | message.organisationUnit.unitPostalCity | Avsändande vårdenhets postort. Visas om avsändande vårdenhets HSA-id (message.organisationUnit.unitId) är anslutet till 1177 Vårdguidens e-tjänster. |
7 | message.organisationUnit.unitTelephone | Avsändande vårdenhets telefonnummer. Visas om avsändande vårdenhets HSA-id (message.organisationUnit.unitId) är anslutet till 1177 Vårdguidens e-tjänster. |
8 | message.messageDescription | Meddelandets rubrik. |
9 | message.messageText | Meddelandets text. Vid användning av SSO (Single sign-on) måste texten vara formaterad i DocBook. Exemplet på bilden visar samtliga tillåtna DocBook-element. |
10 | message.ssoLink.text | Länktext för SSO-länk. Länkens url skapas i run time utifrån bas-url registrerad hos 1177 Vårdguidens e-tjänster + eventuellt medskickade parametrar i elementet message.ssoLink.queryString. |
Formatering av meddelanden
Konsument har möjlighet att formatera text i elementet message.messageText i det standardiserade layout-formatet DocBook (vid användning av SSO-länk i 1177 Vårdguidens e-tjänster är DocBook-formatering av texten ett krav). DocBook är ett ganska rikligt format (http://www.docbook.org/tdg5/en/html/docbook.html). Därför finns en avgränsning till ett antal utvalda element och ett antal utvalda kombinationer av dessa. Tabellen nedan redovisar möjliga kombinationer av element i DocBook-formatet som stöds av tjänsten. Annan användning av DocBook kommer resultera i att texten ”##### Mismatched Element in Source #####” visas i inkorgsmeddelandet.
Element | Parent | Child |
article | NA | info, para, section, bibliography, variablelist |
info | article, section | title |
section | article | info, title, para, bibliography, variablelist |
para | article, section | ulink |
bibliography | article, section | NA |
variablelist | article, section | title, varlistentry |
title | info, section, variablelist | NA |
ulink | para | NA |
varlistentry | variablelist | term, listitem |
term | varlistentry | NA |
listitem | varlistentry | NA |
Entity encoding
Text som skickas i elementet messageText i DocBook-format måste vara ”entity encoded” så att DocBooks XML-taggar inte uppfattas som del av SOAP-meddelandets XML-struktur. Nedan är ett exempel på ett XML-meddelande före och efter entity encoding.
<?xml version="1.0"?> <article> <section> <title>article.section.title</title> <info> <title>article.section.info.title</title> </info> <para>article.section.para</para> <para> <ulink url="http://www.exampleurl.com">article.section.para.ulink</ulink> </para> <bibliography>article.section.bibliography</bibliography> </section> <section> <title>article.section.title</title> <variablelist> <title>article.section.variablelist.title</title> <varlistentry> <term>article.section.variablelist.varlistentry.term</term> <listitem>article.section.variablelist.varlistentry.listitem</listitem> </varlistentry> <varlistentry> <term>article.section.variablelist.varlistentry.term</term> <listitem>article.section.variablelist.varlistentry.listitem</listitem> </varlistentry> <varlistentry> <term>article.section.variablelist.varlistentry.term</term> <listitem>article.section.variablelist.varlistentry.listitem</listitem> </varlistentry> </variablelist> </section> </article> <?xml version="1.0"?> <article> <section> <title>article.section.title</title> <info> <title>article.section.info.title</title> </info> <para>article.section.para</para> <para> <ulink url="http://www.exampleurl.com">article.section.para.ulink</ulink> </para> <bibliography>article.section.bibliography</bibliography> </section> <section> <title>article.section.title</title> <variablelist> <title>article.section.variablelist.title</title> <varlistentry> <term>article.section.variablelist.varlistentry.term</term> <listitem>article.section.variablelist.varlistentry.listitem</listitem> </varlistentry> <varlistentry> <term>article.section.variablelist.varlistentry.term</term> <listitem>article.section.variablelist.varlistentry.listitem</listitem> </varlistentry> <varlistentry> <term>article.section.variablelist.varlistentry.term</term> <listitem>article.section.variablelist.varlistentry.listitem</listitem> </varlistentry> </variablelist> </section> </article> |
Kodexempel
Bifogade kodexempel nedan ovan kan kopieras, användas och återanvändas fritt. Kodexemplen underhålls dock inte av 1177 Vårdguidens e-tjänsters förvaltning. 1177 Vårdguidens e-tjänsters förvaltning tar heller inte ansvar för att kodexemplen fungerar i konsumerande systems miljö.
- Inga etiketter