Hämta meddelanden (SOL:10)
Med denna tjänst kan vården hämta meddelanden i fritextformat. Ett meddelande i SOL är alltid kopplat till ett personnummer. Meddelandet kan även vara kopplat till tidigare meddelanden. Meddelandeidentitet genereras automatiskt i SOL.
Innehållsförteckning
1. Tjänstespecifikation Hämta meddelanden (SOL:10)
HamtaMeddelanden V4.0
2. Formatregler
2.1. Datum och tid
Datatypen ”Datum” sätts i SOLs tjänstespecifikationer till formatet YYYY-MM-DDTHH:mm:ss om inte annat anges. Om inte tid skickas med vid anrop sätts tiden till 00:00:00. Vissa tjänster tar bara hänsyn till YYYY-MM-DD -delen.
3. Indata
|
ID |
<XML-tag> / fältnamn |
Kort beskrivning |
Mult |
Validering/ Anmärkning |
|---|---|---|---|---|
|
I002 |
Behorighetsinformation |
Se I1 nedan |
1..1 |
Klass |
|
I011 |
Meddelandenurval |
Se I2 nedan |
1..1 |
Klass |
3.1. I1. Behörighetsinformation
|
ID |
<XML-tag> / fältnamn |
Kort beskrivning |
Mult |
Validering/ Anmärkning |
|---|---|---|---|---|
|
I003 |
fornamn |
Användarens förnamn |
1..1 |
1 - 25 pos |
|
I004 |
efternamn |
Användarens efternamn |
1..1 |
1 - 25 pos |
|
I005 |
forskrivarkod |
Användarens förskrivarkod |
0..1 |
Exakt 7 pos |
|
I006 |
yrkeskod |
Typ av förskrivare LK = Läkare BM = Barnmorska SJ = Sjuksköterska TL = Tandläkare RS = Röntgensjuksköterska TH = Tandhygienist |
0..1 |
Enum |
|
I007 |
arbetsplatskod |
Arbetsplatskod |
1..1 |
1 - 13 pos |
|
I008 |
hsaid |
Vårdens identitetsbegrepp |
0..1 |
1 - 64 pos Se R004 |
|
I009 |
personnummer |
Användarens personnummer |
0..1 |
Exakt 12 pos |
|
I010 |
organisationsnummer |
Användarens organisations organisationsnummer |
0..1 |
1 - 20 pos |
3.2. I2. Meddelandenurval
|
ID |
<XML-tag> / fältnamn |
Kort beskrivning |
Mult |
Validering/ Anmärkning |
|---|---|---|---|---|
|
I001 |
dosapotekid |
GLN-kod för dosapotek som har skickat meddelandet |
0..1 |
Exakt 13 pos Valideras mot EXPO |
|
I018 |
personnummer |
De personnummer för dospatienter som hämtningen avser enligt format: YYYYMMDDXXXX |
0..* |
Exakt 12 pos Se R004, R005 och R006 |
|
I021 |
meddelandeid |
ID för meddelandet |
0..1 |
UUID 0-36 pos Se R008 |
|
I022 |
meddelandestatus |
Tillåtna värden: O = Oläst L = Läst LO = Läst eller oläst B = Borttaget |
0..1 |
Enum Se R001 och R007 |
|
I026 |
frantidpunkt |
Datum och klockslag |
0..1 |
Datum Se R007 |
|
I027 |
tilltidpunkt |
Datum och klockslag |
0..1 |
Datum Se R007 |
| I028 | maxantal | Anges för att begränsa antalet meddelanden som anropet ska returnera. | 0..1 |
Integer Se R003 |
4. Utdata
|
ID |
<XML-tag> / fältnamn |
Kort beskrivning |
Mult |
Validering/ Anmärkning |
|---|---|---|---|---|
|
U001 |
resultatkod |
Möjliga värden: |
1..1 |
enum |
|
U002 |
meddelandetext |
Meddelandetext |
1..1 |
1 - 300 pos |
|
U003 |
meddelandeid |
ID för responsmeddelande |
1..1 |
Integer |
|
U004 |
Meddelanden |
Se U1 nedan |
0..* |
Klass |
4.1. U1. Meddelanden
|
ID |
<XML-tag> / fältnamn |
Kort beskrivning |
Mult |
Validering/ Anmärkning |
|---|---|---|---|---|
|
U005 |
meddelandeid |
ID för meddelandet, tilldelat av eHälsomyndigheten |
1..1 |
UUID 36 pos |
|
U011 |
personnummer |
Personnummer för dospatient som meddelandet avser enligt format: YYYYMMDDXXXX |
1..1 |
Exakt 12 pos |
|
U014 |
kommunikationsriktning |
Möjliga värden: 1 = Från vården 2 = Från dosapotek |
0..1 |
Enum |
|
U015 |
tidigaremeddelandeid |
Anges om meddelandet är kopplat till ett tidigare meddelande |
0..1 |
UUID 36 pos |
|
U017 |
dosapotekid |
GLN-kod för sändande dosapotek |
0..1 |
Sträng |
|
U018 |
dosapoteknamn |
Namn på dosapotek |
0..1 |
Sträng |
|
U019 |
sandningstidpunkt |
Tidpunkt som meddelandet skickades |
1..1 |
Datum |
|
U020 |
sandarefornamn |
|
1..1 |
1 - 25 pos |
|
U021 |
sandareefternamn |
|
1..1 |
1 - 40 pos |
|
U022 |
sandarehsaid |
HSA-id för sändare |
0..1 |
Sträng |
|
U023 |
sandareyrkeskod |
Möjliga värden: LK = Läkare BM = Barnmorska SJ = Sjuksköterska TL = Tandläkare RS = Röntgensjuksköterska TH = Tandhygienist |
0..1 |
Sträng |
|
U024 |
sandarearbetsplats |
Ursprunglig sändare arbetsplatskod |
0..1 |
Sträng |
|
U025 |
rubrik |
Rubrik för meddelandet |
0..1 |
Sträng |
|
U026 |
prioritet |
Möjliga värden: H = Hög N = Normal L = Låg |
0..1 |
Enum |
|
U027 |
meddelandestatus |
Möjliga värden: O = Oläst L = Läst |
1..1 |
Enum |
|
U028 |
meddelandestatusfornamn |
Namn på person som senast uppdaterat meddelandets status |
1..1 |
1 - 25 pos |
|
U029 |
meddelandestatusefternamn |
Namn på person som senast uppdaterat meddelandets status |
1..1 |
1 - 25 pos |
|
U030 |
meddelandestatusarbetsplats |
Arbetsplatskod för person som senast uppdaterat meddelandets status |
1..1 |
1 - 40 pos |
|
U031 |
meddelandestatustidpunkt |
Datum och klockslag för senaste statusuppdatering |
1..1 |
Datum |
|
U032 |
meddelande |
|
1..1 |
1 - 1024 pos |
5. Verksamhetsregler/logik
|
ID |
Verksamhetsregler/logik |
|---|---|
|
R001 |
Meddelanden som är markerade som Borttagna (I022 meddelandestatus = B) returneras ej. |
|
R002 |
Sökresultat som inte ger någon träff genererar informationsmeddelande ”Ingen träff”. |
|
R003 |
Om sökning ger fler träffar än det definierade maxantalet returneras maxantalet tillsammans med en varning. De meddelanden som returneras är de äldsta bland de som uppfyller sökkriterierna, baserat på meddelandets sändningstidpunkt. Maxantalet anges i I028. Om inget värde anges i I028 blir defaultvärdet 500 st. |
|
R007 |
Sökning kan förfinas genom att ange: |
|
R008 |
Sökning kan ske på I018 personnummer, I021 meddelandeid eller I001 dosapotekid. Parametrarna kan inte kombineras, endast en av dem kan anges. Om I001 dosapotekid anges måste även I008 hsaid anges. |
Versionshistorik
|
Version |
Datum |
Kommentar |
|---|---|---|
| 1.0 | 2021-11-27 | Ny handbok vård- och apotekstjänster |
| 1.2 | 2022-05-25 |
Tillagt: I028 Ändrat: datatyp på I021, U005 och U015 samt formulering på R003 I018 det går att ange flera |