Informationshantering i tjänsten

subjectOfCareId

Invånarens personnummer

threadId

Används för att “tråda” meddelanden. Om fältet ej anges kommer en ny tråd med en automatgenererad identitet skapas. Meddelandetrådens id (antingen den tillhandahållna eller den automatiska) returneras i svaret.

threadTitle

En titel på meddelandet i inkorgens översikt, dvs trådens titel. Om fältet utelämnas vid första meddelandet i en tråd sätts värdet till "Meddelande". Utelämnas det vid kommande meddelanden i samma tråd förändras inte titeln. Om fältet inkluderas vid kommande meddelanden skrivs tidigare värde över.

threadLabel

Används för att informera om status för en meddelandetråd, t ex “Ärendet avslutat”. Om fältet utelämnas vid första meddelandet i en tråd sätts värdet till "Information".
Utelämnas det vid kommande meddelanden i samma tråd förändras inte label.
Om fältet inkluderas vid kommande meddelanden skrivs tidigare värde över.

message

En typ som beskriver detaljer om meddelandet, dvs innehållet i meddelandet

notify

Avgör huruvida avsändaren avser att avisera invånaren om meddelandet baserat på invånarens egna inställningar i 1177

queueForDays

Om invånaren saknar inloggning i 1177 kan avsändaren välja att spara meddelandet i en kö i ett visst antal dagar. Invånaren får då meddelandet vi sin första inloggning. Om fältet utelämnas sätts värdet till 90 dagar

approve

Godkänner invånaren för kommunikation på den enhet som meddelandet avser.

Dvs om denna flagga = TRUE i anropet, så får invånaren en relation till den mottagningen på 1177 Vårdguidens e-tjänster, vilket underlättar för användarupplevelsen sen i andra tjänster, exempelvis Mina bokade tider.

Specialfall:

• Är flaggan = FALSE i anropet så sätts inte den relationen upp. Om det finns en relation sedan tidigare så påverkas den inte av att man sätter flaggan=FALSE. Man kan alltså inte dra tillbaka en relation inom 1177 via detta anrop.

• Invånaren kan ta bort en mottagning från sin startsida. Om invånaren har tagit bort mottagningen från sin startsida så kommer ett anrop med approve=TRUE inte lägga tillbaka mottagningen på startsidan. Mottagningsrelationen finns dock kvar, så invånaren har rätt att kommunicera med mottagningen.

accountableOrganisation

Identitet på den organisation som skickar meddelandet. Används som grund för fakturering.

serviceLink

Denna typ används om meddelandets detaljinnehåll finns i ett annan inkorg, dvs ett annat system t ex en uthoppstjänst

title

En titel för meddelandet. Visas i detaljvyn av invånarens inkorg. Utelämnas om “serviceLink”, annars obligatoriskt

text

Meddelandets brödtext i DocBook-format. Utelämnas om “serviceLink”, annars obligatoriskt

organisationUnit

Ska innehålla avsändande enhet.

Om avsändarens hsaid finns som en aktiv mottagning i 1177 så gäller:

1. Enhetens namn som visas i meddelandet i 1177 Inkorg hämtas från den aktiva enheten i 1177 Vårdguidens e-tjänster.

2. Namnet blir klickbart så att användaren kan navigera till kontaktkortet i 1177.

3. Knapparna för tidbokning kan aktiveras för att underlätta för användaren att nå tidbokningstjänsten inom 1177 Vårdguidens e-tjänster.

Om avsändarens hsaid saknas i 1177 så gäller följande:

1. AddMessage returnerar ett resultCode.INFO och en text i stil med ”Mottagningen är inte aktiv i 1177”. Men meddelanden kommer fortfarande fram till invånarens inkorg. Det är upp till konsumenten att hantera returkoder på ett för sin tillämpning adekvat sätt.

2. Det är obligatoriskt att skicka med ett enhetsnamn i AddMessage

3. Tidbokningstjänsten inom 1177 Vårdguidens e-tjänster kan ej nyttjas.

actions

En typ som möjliggör för avsändaren att skapa länkar eller knappar inbäddade i meddelandet som länkar vidare till uthoppstjänster

queryString

Avsändare kan skicka med parametrar till länkens url

text

Knappen eller länkens text

serviceId

Ett id som definierar hur man adresserar tjänstetypen i 1177.

displayType

En enum som kan anta endera värdena “Button” eller “Link”. En “action” kan representeras av endera en knapp eller en länk i ett meddelande

queryString

?bookingId=XYZ123

text

“Boka tid“, “Omboka tid” respektive “Avboka tid”

serviceId

“BOKATID”, “OMBOKA” respektive “AVBOKA”

displayType

Button

serviceId

Tjänsten man länkar till adresseras genom en tjänstetyp definierad i 1177

queryString

Avsändare kan skicka med parametrar till länkens url

hasAttachment

Talar om huruvida det finns en bilaga med i meddelandet

unitId

Hsaid för avsändande enhet

unitName

Namn på avsändande enhet. Inskickat namn används endast om sändande enhet inte aktiverats som mottagning i 1177. HSA-katalogen är informationskälla avseende enhetsnamn i 1177

root

En identifierare för värdemängden. Enligt nationell arkitektur ofta ett sk OID. I denna domän används OID för Hsaid, vilket är 1.2.752.129.2.1.4.1

extension

Värdet för aktuell typ

threadId

Ett id för den meddelandetråd man vill veta status för

id

Trådens id

title

En titel på meddelandet i inkorgens översikt, dvs trådens titel

label

Används för att informera invånare om status för en meddelandetråd, t ex “Ärendet avslutat”

status

Används för personal att avgöra huruvida invånare läst meddelandet. Status är en enum och kan anta värdena “Read” eller “Unread”

statusChanged

Datum och tid för senaste förändring avseende lässtatus

subjectOfCareId

Invånarens personnummer

isActive

Invånaren har ett aktivt konto eller inte

activeNotificationMethods

En enum som talar om vilka aktiva aviseringsvägar invånaren tillhandahåller. Denna kan anta värdena “SMS”, “Email” eller “Other”