1.Skapa meddelande

Organisation A

• Meddelandetjänst (verksamhets- och meddelandelager)

I meddelandetjänsten skapas en meddelandestruktur enligt schema (XHE, MessageType) och paketeras i AS4.

• AS4

  • MessagePayload (MessagePayloadType)

    • XHE

    • Message (MessageType)

Meddelandet skapas i en meddelandetjänst.

Steg 1 och steg 2 (steg 3) kan ske samtidigt.

2.Adressera

Organisation A

• Meddelandetjänst

Användare(avsändaren) inom organisationen med tillgång till en SDK funktionsadress söker i en adressbok för att hitta anslutna organisationer och dess funktionsadresser.

Meddelandetjänsten kompletterar meddelandet med adressuppgifter (organisations-id, funktions-id).

Transportadressering:

• AS4

  • originalSender (organisations-id)

  • finalRecipient (organisations-id)

Verksamhetsadressering:

• MessageType

  • Recipient (organisations-id)

    • Attention.Function (funktions-id)

    • Attention.Person (Endast referens: person-id)

  • Sender (organisations-id)

    • Attention.Function (funktion-id)

    • Attention.Person (Endast referens: person-id)

• XHE

  • Receiver (organisations-id)

  • Sender (organisations-id)

  • HandlingServiceID (funktions-id)

Användaren söker i en adressbok för att hitta anslutna organisationer och dess funktionsadresser. Detta kan ske antingen genom integration mot SDK Adressboks Sök-API eller genom en lokal läskopia.

Specifikationer:

• Kuverteringsprofil XHE (Se R8)

3.Kryptera och signera

Organisation A

• Meddelandetjänst

Avsändande användarorganisation krypterar och signerar meddelandet.

• Mottagande användarorganisationens krypteringsnyckel hämtas från SMP (CertPub)

• Meddelandetjänsten Base64-kodar det färdiga meddelandet och överför det till Accesspunkten.

  • Hur ett meddelande överförs till accesspunkten är en produktspecifik fråga; olika ev. APIer kan erbjudas beroende på produkt.

Specifikationer:

• Kuverteringsprofil XHE (Se R8)

• Certifikatspublicering - REST-bindning till SMP (Se R10)

4.Skicka meddelande

Organisation A

• Accesspunkt (AP)

Avsändande Accesspunkt skickar meddelande enligt eDelivery-protokoll.

• DNS ger transportadress till SMP

• SMP ger transportadress AP

Organisation B

• Accesspunkt (AP)

Mottagande Accesspunkt tar emot meddelande för vidare leverans.

Intern routing skall baseras på:

• Organisations-id

• Funktions-id

5.Status

Organisation B

• Accesspunkt (AP)

Transportkvittering: Mottagande Accesspunkt bekräftar överföring synkront enligt eDelivery-protokoll.

• SignalMessage innehåller bl.a. MessageId

6.Validering och kvittering

Organisation B

• Meddelandetjänst

Meddelandekvittering: Mottagande organisations meddelandetjänst validerar meddelande samt kvitterar meddelande.

1. Ursprungskontroll: Validerar sändarens signatur enligt XHE specifikation.

2. Dekrypterar meddelande

   • Ursprungskontroll meddelande: Genom kontroll mot SMP(CertPub) kan mottagaren kontrollera att sändarens identitet är korrekt (Organisations-id)

3. Kvittering sker när meddelandet är validerat (Se B2) och har nått mottagande organisations meddelandetjänst.

   • Kvitteringsmeddelanden skall endast signeras (ej krypteras)

4. Kvittering sker genom att meddelandetjänsten skickar ett kvitteringsmeddelande meddelande till avsändaren.

Observera att kvittensmeddelande skall skapas enligt DIGGs specifikation Meddelandekvittens (R7).

Överföring till mottagande organisations meddelandetjänst är nu garanterad.

Specifikationer:

• Meddelandespecifikation: Meddelandekvittens (Se R7)

  • för utformning av meddelandekvittens

• Certifikatspublicering - REST-bindning till SMP (Se R10)

• SDK Specifikation Validering, felhantering och kvittens (Se B2)

  • för tillämpning av SDKs regelverk

7.Meddelandestatus

Organisation A

Meddelandekvittens mottages

Dokumenttyp

Messaging

• UserMessage

  • CollaborationInfo.action

Värde: busdox-docid-qns::urn:riv:infrastructure:messaging:MessageWithAttachments:3::messagePayload##3.0::tm-base-ext-sigenc

Service (Process)

Messaging

• UserMessage

  • CollaborationInfo.service

Type = urn:fdc:digg.se:edelivery:process

Värde = bdx:noprocess

• Unik identifierare

  • ID

• Datum

  • CreationDateTime

Unikt identifierare av meddelandet/nyttolast.

• ID: Unik identifierare. Ska vara samma som för nyttolasten

• CreationDateTime: Datum när XHE skapadess. Kan vara samma som för nyttolasten.

• Avsändare

  • FromParty

• Mottagare

  • ToParty

FromParty.PartyIdentification

• Sändande användaroganisation (Organisations-id)

  • SKA vara samma som AS4 originalSender

  • SKA vara samma som MessageType.MessageHeaderType.SenderType

ToParty.PartyIdentification

• Mottagande användarroganisation (Organisations-id)

  • SKA vara samma som AS4 finalRecipient

  • SKA vara samma som MessageType.MessageHeaderType.RecipientType

Meddelandets struktur

Payloads.Payload.DocumentTypeCode

• SKA motsvara rotelementet dvs “Q{urn:riv:infrastructure:messaging:MessageWithAttachments:3}messagePayload”

Payloads.Payload.ContentTypeCode

• SKA sättas till “application/xml“

Funktionsadress (egen identifierare)

Payloads.Payload.HandlingServiceID

Nyttolastens funktionsadress, kan används för att underlätta meddelandehantering i meddelandetjänst/meddelandeväxel.

SDK Meddelande och Meddelandekvittens (OBS! Meddelandekvittens är ett separat meddelande som har en egen specifikation. Se R7 Meddelandespecifikation: Meddelandekvittensavser):

• Mottagarens Id för att identifiera funktion/enheter.

  • SKA vara samma som attention.subOrganization.organizationId.extension

• SKA även sättas i XHE kuvert på kvittensmeddelandet för detta meddelande.

../message

(MessageType)

MessageType

messageHeader

MessageHeaderType

Bärare av metadata

1..1

messageBody

MessageBodyType

Bärare av innehåll (text, bilaga)

1..1

../messageHeader

(MessageHeaderType)

creationDateTime

dateTime

Tidsstämpel för när meddelandet skapades. Tidszon UTC skall användas.

T.ex. 2018-09-12T15:06:00Z

1..1

messageId

String

Unik identifierare (UUID) av meddelande.

• Meddelande-id (messageid) SKA vara samma som XHE.ID

Ska följa RFC4122. Se ​

1..1

conversationId

String

Skapas av sändande system. Unik identifierare (UUID).

Notera att även AS4 eb:CollaborationInfo.ConversationId SKA sättas till samma värde som ConversationId.

“ConversationId” används för att koppla meddelanden i en konversation. Ett “ConversationId“ kan återanvändas i meddelandeutbyte mellan olika mottagare. T.ex. om sändaren vill skicka samma meddelande till flera mottagare.

Vid ny konversation/nytt meddelande:

• Samma värde används som för messageId eller ett nytt id skapas

Besvara meddelade:

• ConversationId sätts till samma värde som i meddelandet som besvaras (ConversationId återanvänds).

Komplettera meddelande

• ConversationId sätts till samma värde som i meddelandet som kompletteras (ConversationId återanvänds).

Meddelandeklient(MK) skall hantera värdet.

1..1

refToMessageId

String

Används inte för meddelanden som inte är svar på annat meddelande.

RefToMessageId sätts av sändande system när ett meddelande besvaras. RefToMessageId ska sättas till messageId för meddelandet som besvaras/kompletteras.

Ger stöd för att se ordningsföljd i konversationstrådar, samt att koppla samman meddelandekvittenser med meddelandet.

• Om ett värde skickas skall det valideras och hanteras i klient.

• Meddelandeklient(MK) skall hantera ordningsföljd mellan meddelanden baserat på värdet.

0..1

label

String

Meddelandets rubrik. Max 256 tecken.

• Meddelandeklient(MK) skall hantera meddelandets rubrik

1..1

confidentiality

Boolean

Kommunicerar sändande organisations sekretessbedömning. Syftet med markeringen är att upplysa mottagande organisation om att meddelandet innehåller sekretessbelagd information och/eller känsliga personuppgifter.

Meddelandeklient(MK) skall hantera och synliggöra fältet.

• True - omfattas av sekretess

• False - omfattas ej av sekretess

1..1

generatingSystem

IIType

Identifierare för systemet som skapade/genererade meddelandet. Id kan användas för felsökning/support.

Regelverk IIType:

• root = kodverk för identifierare

  • Identifierare är oreglerad

• extension = id.

0..1

recipient

recipientType

Bärare av metadata för mottagande organisation

1..1

sender

senderType

Bärare av metadata för sändande organisation

1..1

../recipient

(RecipientType)

recipientId

IIType

Mottagande organisation (organisations-id).

Tillämpas enligt specifikation.

• Identifierare av organisation SKA vara samma värde som

  • AS4 header:

    • Messaging

      • UserMessage

        • MessageProperties

          • finalRecipient

  • XHE:

    • ToParty.PartyIdentification

Regelverk IIType:

• root = kodverk för identifierare

  • Använd: iso6523-actorid-upis

• extension = “0203:” + organisations-id i form av domännamn.

  • Ex: 0203:​

• Värdet i extension SKALL valideras programmatiskt i meddelandetjänst för att säkerställa korrekt adressering. Täcks inte av schema/schematron. 

1..1

label

String

Tillämpas enligt specifikation. Organisationens namn. Max 256 tecken.

• Mappas mot adressbokens attribut för organisationsnamn (organizations "name")

• Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

0..1

attention

attentionDataType

Bärare av metadata för funktionsadress och refererad person. Se avsnitt "3.3.2.3 AttentionDataType" för detaljerad information.

1..1

../sender

(SenderType)

senderId

IIType

Sändande organisation.

Tillämpas enligt specifikation.

• Identifierare av organisation SKA vara samma värde som

  • AS4 header:

    • Messaging

      • UserMessage

        • MessageProperties

          • originalSender

  • XHE

    • FromParty.PartyIdentification

• Kontroll av avsändare (gäller vid tillämpning av organisatonsidentifierare iso6523:0203)

  • SKALL vara samma toppdomän i “PartyInfo.From.PartyId” och “MessageProperties Property name="originalSender”

  • SKALL kontrollera mot SMP att originalSender är registrerad i federationen (ParticipantIdentifier)

Regelverk IIType:

• root = kodverk för identifierare

  • Använd: iso6523-actorid-upis

• extension = “0203:” + organisations-id i form av domännamn.

  • Ex: 0203:​

Validering:

• Värdet i extension SKA valideras programmatiskt i meddelandetjänst för att säkerställa korrekt adressering. Täcks inte av schema/schematron. 

• Meddelandets XHE signatur SKA valideras mot DIGGs SMP (CertPub) tjänst.

  • Signaturen SKA motsvara Organisations-id registrerad i Certifikatspubliceringstjänst (CertPub) tjänst.

1..1

label

String

Tillämpas enligt specifikation. Max 256 tecken

• Mappas mot adressbokens attribut för organisationsnamn (t.ex.organizationalUnitName)

• Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

0..1

attention

attentionDataType

Bärare av metadata för funktionsadress och refererad person. Se avsnitt "3.3.2.3 AttentionDataType" för detaljerad information.

1..1

../attention (AttentionDataType)

../attention/person/PersonId (AttentionPersonType)

AttentionPersonType

identifierare för refererad person (sender eller recipient). Attributet utelämnas om det saknas en unik identifierare.

Regelverk IIType:

• root = kodverk för identifierare (användarorganisationens identifierare)

  • Exempel:.

    • Personnummer: 1.2.752.129.2.1.3.1 

    • Hsa-id person: 1.2.752.29.6.2.1

    • E-post: 0.9.2342.19200300.100.1.3

    • Övrig "slask" oid: 1.2.752.129.2.1.2.1

• extension = personal-id.

  • Ex: SE2321000016-nnnnn

Övrigt

• Det finns idag inga krav på att endast mottagande PersonId får ta del av meddelandet. Adressering får endast ske på funktionsnivå.

  • PersonId ingår ej i gemensam adressbok

• Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

0..*

../attention/person/label

String

Refererad personen fullständiga namn (fullname). Max 256 tecken

T.ex. Karin Svensson

• Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

0..1

../attention/subOrganization

(SubOrganizationType)

SubOrganizationType

Funktion/Enhet

1..1

../attention/subOrganization/organizationId

IIType

Id för att identifiera funktion/enheter.

• Hämtas från SDK adressbok "identifier"

Regelverk IIType:

• root = urn:riv:infrastructure:messaging:functionalAddress

• extension = Identifierare för funktionsbrevlåda 

  • Ex(hämtas från adressboken): SE2321000016-nnnnn

1..1

../attention/subOrganization/label

String

Funktion/enhetens namn. Max 256 tecken

T.ex. Socialtjänsten i Håbo

• Hämtas från SDK adressbok

Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

0..1

../attention/reference

(ReferenceType)

0..*

../attention/reference/referenceId

IIType

Referens-id. T.ex. ärende-id eller diarienummer eller personnummer. Referens-id underlättar för sändare och mottagare att koppla meddelandet till lokala ärenden/handlingar eller en specifik invånare/patient. Max 256 tecken.

Regelverk IIType:

• root = kodverk för identifierare (organisationens interna eller gemensam identifierare)

  • T.ex.

    • Diarienummer: dnr

    • GLN: 1.3.88

    • Svenskt personnummer(PNR): 1.2.752.129.2.1.3.1

    • Samordningsnummer(SNR): 1.2.752.129.2.1.3.3

    • Nationell reservidentitet(NRID): 1.2.752.74.9.1

    • Övriga/okänd: unregistred

• extension = id

  • Ex: 7362220000318

Om referens-id används för Sender

• Sändaren bifogar sitt referens-id t.ex. diarienummer.

  • Mottagaren skall returnera sändarens referens-id vid svar.

Om referens-id används för recipient

• Mottagarens referens-id anges. Detta id kan hämtas från föregående meddelande dvs det meddelandet som besvaras.

Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

1..1

../attention/reference/label

String

Namn/etikett på internt referens-id.

Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

0..1

../messageBody

(MessageBodyType)

./Documents

DigitalDocumentType

Bärare av textmeddelande och bilaga.

1..*

../documents

(DigitalDocumentType)

Ett meddelande (documents) SKA innehålla minst ett textmeddelande (contentext) och eller en bifogad fil(contentFiles).

documentID

String

Identifierare av dokument. Skapas av sändaren.

1..1

documentName

String

Dokumentets namn.

Om ett värde skickas skall det hanteras i klient.

0..1

Index

String

Sorteringsordning. Om flera documents(DigitalDocumentType) skickas skall sorteringsordning sättas. Detta för att underlätta informationsutbyte då presentationsordning. Siffror skall användas. 1 representerar den första.

0..1

../contentFiles

contentAsBase64Type

Bärare av filer

0..*

../contentText

contentAsTextType

Bärare av textmeddelande

0..*

../contentText

(ContentAsText)

characterSequence

1..1

Fritext (UTF-8).

Text kan formateras med följande MarkDown koder enligt RFC 7763.

Headers:

Grafiskt gränssnitt i meddelandeklient (verksamhetssystem) tjänst skall rendera ovanstående MarkDown-koder.

Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

Meddelandet inklusive bifogade filer får ej överstiga 30 MB.

1..1

../ContentFiles (ContentAsBase64Type)

Bifogas flera element skall dessa hanteras enligt valfri sortering.

fileName

String

Bilagans filnamn. Filnamnet bör visas i meddelandetjänsten.

1..1

contentType

String

Typ av bilaga som överförs/bifogas. MIME-typ för bifogad fil skall anges.

• Alla användarorganisationer ska stödja filtypen PDF.

  • Rekommendation för arkivbeständig PDF-format är

    • PDF-A1

    • PDF-A2

• Utöver PDF ansvarar användarorganisationen själv för vilka ytterligare filtyper som ska kunna skickas och tas emot.

Filtyper som inte stöds av mottagaren skall kvitteras(REJECTED) enligt följande.

1..1

content

String

Base64-kodad bilaga (UTF-8). Den binära informationen skall kodas med base64 enligt RFC 4648.

Meddelandet inklusive bifogade filer får ej överstiga 30 MB.

1..1

Meddelandet mottaget och validerat utan avvikelser

ACCEPTED

-

-

Meddelandet mottaget, kvitterat och validerat utan avvikelser.

Meddelandekuvertets struktur och i förekommande fall innehåll kodverksregler etc.

REJECTED

SV

structure

Meddelandet är strukturellt (xsd) felaktigt eller är korrupt.

• Felaktig datatyper etc

Kontroll mot skadlig kod i nyttolast.

REJECTED

BV

forbidden

Felkod REJECTED skall genereras av mottagaren i de fall det är möjligt. En incident behöver skapas om skadlig kod upptäcks.

Skalskydd i form av antivirussystem kan förhindra filhantering genom t.ex. att sätta meddelande i "karantän".

Storleksvalidering (storlek)

REJECTED

BV

too-long

Storleksöverträdelse över fastställd storlek (f.n. > 30mb för hela meddelandet) skall generera ett stoppande fel (REJECTED)

Logisk schema validering (schematron)

REJECTED

BV

invariant

Logiska regler eller kodverk följs ej (schematron)

• T.ex. typning är felaktig eller saknas.

MessageId är ej unikt

REJECTED

BV

duplicate

multiple-matches

refToMessageId finns ej

ACCEPTED

-

-

 Meddelandet kvitteras med ACCEPTED.

Filtyp (SDK Innehållsspecifikation - contentAsBase64)

REJECTED

BV

Not-supported

Meddelandet skall ej kvitteras, felkod REJECTED. Filtyp stödjs ej.

Funktionsadress finns ej

REJECTED

BV

Not-found

Funktionsadress finns ej eller är felaktigt

referens till meddelande (refToMessageId) som är markerat som REJECTED.

REJECTED

BV

not-supported

Meddelandet kan ej levereras och kvitteras pga att meddelandet är marketat som felaktigt (t.ex. pga sändarens time-out).

Felaktig avsändare - Sändarens XHE signatur

REJECTED

SIG

security

Avsändarinformation (organisations-id) är felaktig eller matchar ej XHE-signatur.

Felaktig avsändare - Angiven avsändare felaktig

REJECTED

BV

security

Avsändarinformation är felaktig eller matchar ej.

• Kvittens returneras med detaljer om originalSender inte matchar med avsändande accesspunkts konfiguration.

• Vid scenariot att avsändande organisation inte finns registrerad i SMP bör inte kvittens skickas eftersom kvittensen inte kommer levereras msspunkt.