Tjänstedomän för invånarens inkorg/avisering (Patientportal)

Gå direkt till:

1 Skicka meddelande till invånare (AddMessage)
2 Kontrollera aktiv användare (IsActiveUser)
3 Flödesbeskrivning
4 Teknisk instruktion för att skapa inkorgsmeddelande i 1177 e-tjänster
- 4.1 Exempel på SOAP-meddelande
- 4.2 Skärmbild på inkorgsmeddelandet

Inkorgsfunktionen i 1177 e-tjänster gör det möjligt för externa system som exempelvis journalsystem och andra verksamhetssystem att skicka meddelanden till invånare med konto i 1177 e-tjänster. Inkorgsfunktionen är baserad på tjänstekontrakten IsActiveUser och AddMessageToPatientPortalInbox i tjänstedomänen Patientportal. Tjänstekontrakten gör det möjligt att dels kontrollera om en invånare är användare av portal och dels att skicka själva meddelandet.

Användning av kontrakten stäms först av med förvaltningen för Inkorgen gällande regler och riktlinjer för användning av tjänsterna. Läs mer om det här: https://inera.atlassian.net/wiki/spaces/OVET/pages/559383862

Anslutning till inkorg/avisering kan vara valfri, beroende på hur vårdsystemet har implementerat anslutning och funktion.

Skicka meddelande till invånare (AddMessage)

Tjänsten, via tjänstekontraktet AddMessage, används för att ett system ska kunna lägga till ett meddelande i invånarens inkorg.

Se mer information här: https://inera.atlassian.net/wiki/spaces/OFORM/pages/3014721

Kontrollera aktiv användare (IsActiveUser)

Tjänsten, via tjänstekontraktet IsActiveUser, tar ett personnummer och returnerar status för individen och om denne har aktiverat någon form av notifiering via SMS eller epost. Notera att det som returneras är endast status för vad som är aktiverat inte några faktiska uppgifter om adresser eller telefonnummer.

Flödesbeskrivning

Invånaren loggar in i 1177 Vårdguidens e-tjänster och öppnar sin inkorg
Formulären nås via ett inkorgsmeddelande. I inkorgsmeddelandet finns en länk till formulärinstansen, som är lagrad i Formulärmotorn
Invånaren klickar på länken i inkorgsmeddelandet och fyller i formuläret
Invånaren skickar in formuläret till vårdpersonalen
I Inkorgen finns inkorgsmeddelandet kvar. Invånaren kan öppna meddelandet och via länken nå det ifyllda formuläret

Formulären nås ÄVEN via sidan https://formular.1177.se

Övergripande information

https://inera.atlassian.net/wiki/spaces/OVET/pages/559383862
Teknisk information om tjänstedomänen "Patientportal - infrastructure:eservicesupply:patientportal": Tjänstedomän Patientportal
Tjänstekontraktsbeskrivning Patientportal (finns på sidan ovan)

Teknisk instruktion för att skapa inkorgsmeddelande i 1177 e-tjänster

Av tabellen nedan framgår vilka värden som ska uppges för XML-elementen i begäran till version 1.0 av tjänsten AddMessageToPatientPortalInbox för att inkludera ett länk i meddelandet som leder till det aktuella formuläret i Formulärtjänsten. Dokumentationen innehåller även ett exempel på en begäran samt skärmbilder på hur meddelandet presenteras i 1177 e-tjänster för invånaren.

Definitioner av XML-elementen finns i version 1.0 av tjänstedomänen Patientportal releaspaket.

XML-element	Värde	Obl.	Radnr. i exempel nedan	Kommentar

XML-element	Värde	Obl.	Radnr. i exempel nedan	Kommentar
Header
LogicalAddress	HSA-id för den aktuella miljön av 1177 Vårdguidens e-tjänster.	Ja	3	Aktuella HSA-id för 1177 Vårdguidens e-tjänster som tjänsteproducent av tjänstekontrakten i tjänstedomänen Patientportal finns här: Adressering till tjänsteproducenter.
Body.AddMessageToPatientPortalInbox
subjectOfCareId	Mottagande persons person- eller samordningsnummer.	Ja	7
notify	"true" eller "false".	Nej	27	Anger om konsument önskar att notifiering ska ske enligt mottagande personens inställningar i 1177 Vårdguidens e-tjänster.
sourceSystem (accountableOrganization i AddMessage 2.0)	Det ID som ni får via intresseanmälan	Ja	28	Identifierar ert IT-system/verksamhet som fakturamottagare vad gäller användning av Inkorgsfunktionen i 1177 e-tjänster.
Body.AddMessageToPatientPortalInbox.message
messageThreadId	Id för att relatera flera meddelanden (trådning).	Nej	17	Om detta inte anges blir meddelandet orelaterat.
messageDescription	Exempel: "Formulär att besvara"	Nej	18	Observera att det är valfritt att inkludera detta XML-element, som styr meddelandets rubrik. Om XML-elementet exkluderas kommer meddelandets rubrik per default att bli "Meddelande". Om XML-elementet inkluderas är värdet valfritt, och kan exempelvis vara "Formulär", formulärmallens rubrik, etc.
messageText	Exempel: <?xml version="1.0"?> <article> <section><para>Hej!</para> <para>Du har ett formulär att fylla i via länken nedan.</para> </section> </article>	Ja	19	Meddelandets text (innehåll). Meddelandets text är angivet i det XML-baserade formatet DocBook och måste "escape:as" för att inte uppfattas som en del av SOAP-meddelandets XML-struktur.
Body.AddMessageToPatientPortalInbox.message.organisationUnit
unitId	Den avsändande enhetens HSA-id	Ja	10
unitName	Den avsändande enhetens namn	Ja	11
unitAddress	Den avsändande enhetens adress	Nej	12
unitPostalCode	Den avsändande enhetens postnummer	Nej	13
unitPostalCity	Den avsändande enhetens postort	Nej	14
unitTelephone	Den avsändande enhetens telefonnummer	Nej	15
Body.AddMessageToPatientPortalInbox.message.ssoLink
systemId	"FORM-FORM"	Ja	29	Utifrån detta värde slår 1177 Vårdguidens e-tjänster upp lokalt lagrad bas-url till invånargränssnittet av Formulärtjänsten. XML-elementet är obligatoriskt vid användning av SSO-länkar.
text	Exempel: "Klicka här för att komma till formuläret."	Ja	30	Motsvarar text inom HTML-taggen <a>.
queryString	Formulärets Id	Ja	31	Det formId som erhållits av Formulärtjänsten. Denna sträng kommer att läggas till efter bas-url:en.
type	"CurrentTarget"	Ja	32	Ser till att länken öppnas i samma fönster som 1177 Vårdguidens e-tjänster. Detta är ett krav för användning av Inkorgsfunktionen i 1177 Vårdguidens e-tjänster: Riktlinjer.

Exempel på SOAP-meddelande

Exempel på SOAP-meddelande vid begäran till tjänsten AddMessageToPatientPortalInbox

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:riv:itintegration:registry:1" xmlns:urn1="urn:riv:infrastructure:eservicesupply:patientportal:AddMessageToPatientPortalInboxResponder:1" xmlns:urn2="urn:riv:infrastructure:eservicesupply:patientportal:1" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header>
      <urn:LogicalAddress xmlns:h="urn:riv:itintegration:registry:1" xmlns="urn:riv:itintegration:registry:1">SE2321000016-A29F</urn:LogicalAddress>
   </soapenv:Header>
   <soapenv:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <urn1:AddMessageToPatientPortalInbox xmlns="urn:riv:infrastructure:eservicesupply:patientportal:AddMessageToPatientPortalInboxResponder:1">
         <urn1:subjectOfCareId>191212121212</urn1:subjectOfCareId>
         <urn1:message>
            <urn2:organisationUnit xmlns="urn:riv:infrastructure:eservicesupply:patientportal:1">
               <urn2:unitId>SE2321000180-4GW9</urn2:unitId>
               <urn2:unitName>Akutmottagning Avesta</urn2:unitName>
               <urn2:unitAddress>Avesta lasarett, Lindsnäsvägen 2</urn2:unitAddress>
               <urn2:unitPostalCode>774 82</urn2:unitPostalCode>
               <urn2:unitPostalCity>Avesta</urn2:unitPostalCity>
               <urn2:unitTelephone>0226-49 60 00</urn2:unitTelephone>
            </urn2:organisationUnit>
            <urn2:messageThreadId>abc123</urn2:messageThreadId>
            <urn2:messageDescription>Formulär</urn2:messageDescription>
            <urn2:messageText xmlns="urn:riv:infrastructure:eservicesupply:patientportal:1">
				<?xml version="1.0"?>
				<article>
					<section>
						<para>Hej!</para>
						<para>Du har ett formulär att fylla på länken nedan.</para>
					</section>
				</article>						
			</urn2:messageText>
            <urn2:ssoLink>
               <urn2:systemId>FORM-FORM</urn2:systemId>
               <urn2:text>Klicka här för att komma till formuläret.</urn2:text>
               <urn2:queryString>a5ad3e89-a421-4103-970b-c62b36f206ed</urn2:queryString>
               <urn2:type>CurrentTarget</urn2:type>
            </urn2:ssoLink>
         </urn1:message>
         <urn1:notify>true</urn1:notify>
         <urn1:sourceSystem>IDfrånIntresseanmälan</urn1:sourceSystem>
      </urn1:AddMessageToPatientPortalInbox>
   </soapenv:Body>
</soapenv:Envelope>

Skärmbild på inkorgsmeddelandet

Så presenteras meddelandet för invånaren

Meddelandet i invånarens inkorg i 1177 Vårdguidens e-tjänster

Öppnat meddelande med länk till formuläret i Formulärtjänsten