Formatspecifikation XML
Version 2.0 exportformatet (XML).
export 1..1 (ExportType)
Datatypen beskriver vilka urval som gjordes i användargränssnittet i SoB exportgränssnitt och som gäller för efterföljande data om moment i denna fil
Attribut | Kardinalitet | Beskrivning |
|---|---|---|
exportDate | 1..1 | Tidsstämpel för när exporten skedde. Skrivs som yyyy-MM-dd'T'hh:mm:ss+<tidszon> |
systemName | 1..1 | Namnet på systemet "Stöd och behandling" |
processName | 1..1 | Namnet på momentetmallen som valdes vid exportfiltreringen |
specifiedSelection | 1..1 | Val av export. Ett av följande fyra konstanter är valbara. Valen följer de fyra alternativ som finns i användargränssnittet för export: ALL (alla invånare) FILTER_ON_CATEGORIES (Begränsat urval baserat på en eller flera kategorier) ONLY_ONE_RESIDENT (Begränsat urval på en invånare inklusive länkade moment) SELECT_RESIDENTS (Begränsat urval på en eller flera invånare). |
selectedCategories | 0..* | Lista med kategorier som valdes att exporteras, om FILTER_ON_CATEGORIES valdes ovan. |
status | 1..* | Visar filtreringen som gjordes på status för moment. Om filtrering gjorts på avslutade moment kommer status vara DONE. Om filtrering gjorts på pågående moment kommer två statusar visas: INPROGRESS och MAINTAIN då både moment som pågår och moment som är i vidmakthållande räknas som pågående moment. |
residentAnonymization | 1..1 | Visar om vald export inkluderar personuppgifter för invånare eller inte, visas som följande: Ingen invånarinformation: ANONYMIZED Invånarinformation med hashat personnummer: PSEUDONONYMIZED Invånarinformation i klartext (personnummer och namn): NONE. Ålder vid momentstart samt kön kommer alltid med i exporten. |
modulesExported | 1..1 | Visar om modulinformation valdes att exporteras. true/false. |
messageTransactionsExported | 1..1 | Visar om meddelandehistorik valdes för export. true/false. |
activityPlansExported | 1..1 | Visar om formulär som ingår i aktivitetsplaner med eventuellt tillhörande resultat valdes för export. true/false |
measurementBatteriesExported | 1..1 | Visar om formulär som ingår i mätbatterier med eventuellt tillhörande resultat valdes för export. true/false. |
formsExported | 1..1 | Visar om formulär som inte ingår i mätbatterier med eventuellt tillhörande resultat valdes att exporteras. true/false. |
startFromPeriod | 0..1 | Användaren tillåts i exportgränssnittet att välja ett datumintervall för vilka moment som ska exporteras. StartFromPeriod visar periodens från och med-datum för momentens startdatum. Om fältet är tomt och startToPeriod har ett värde kommer startFromPeriod tolkas som tidigast möjliga datum ett moment kan ha startats. |
startToPeriod | 0..1 | Användaren tillåts i exportgränssnittet att välja ett datumintervall för vilka moment som ska exporteras. StartToPeriod visar periodens till och med-datum för momentens startdatum. Om fältet är tomt och startFromPeriod har ett värde kommer startToPeriod tolkas som dagens datum. |
endFromPeriod | 0..1 | Användaren tillåts i exportgränssnittet att välja ett datumintervall för vilka moment som ska exporteras. EndFromPeriod visar periodens från och med-datum för momentens avslutsdatum. Om fältet är tomt och endToPeriod har ett värde kommer endFromPeriod tolkas som tidigast möjliga datum ett moment kan ha avslutats. |
endToPeriod | 0..1 | Användaren tillåts i exportgränssnittet att välja ett datumintervall för vilka moment som ska EndToPeriod visar periodens till och med-datum för momentens avslutsdatum. Om fältet är tomt och endFromPeriod har ett värde kommer endToPeriod tolkas som dagens datum. |
processes | 0..* | Lista med alla moment som exporterats. |
processes 0..* (ProcessType)
Lista med exporterade moment. Varje processes XML-nod håller information om ett specifikt moment som en invånare går.
Attribut | Kardinalitet | Beskrivning |
|---|---|---|
id | 1..1 | Unikt Id för momentet. |
name | 1..1 | Momentets namn. T.ex. Rehabilitering efter knäskada |
status | 1..1 | Den status som momentet hade vid exporttillfället. Status kan vara följande: INPROGRESS - Pågående DONE - Avslutad MAINTAIN - I vidmakthållande |
majorVersion | 1..1 | Momentets huvudversion. Version på momentet består av de två attributen majorVersion och minorVersion. T.ex. 1.2 ger majorVersion = 1 minorVersion = 2 |
minorVersion | 1..1 | Momentets delversion. Version på momentet består av de två attributen majorVersion och minorVersion. T.ex. 1.2 ger majorVersion = 1 minorVersion = 2 |
startDate | 1..1 | Momentets start enligt formatet yyyy-MM-dd'T'hh:mm:ss+<tidszon>. T.ex. 2015-01-13T10:00:00.000+01:00 |
lastActivityDate | 0..1 | Senaste invånaraktivitet enligt formatet yyyy-mm-dd+<tidszon>. Kan vara tomt om invånaren aldrig varit aktiv enligt momentets definition på aktivitet. T.ex. 2015-01-13+01:00 |
endDate | 0..1 | Momentets avslutsdatum enligt formatet yyyy-mm-dd+<tidszon>. T.ex. 2016-12-20+01:00 |
maintainDate | 0..1 | Datumet då momentet sattes i vidmakthållande av behandlaren enligt formatet yyyy-mm-dd+<tidszon> T.ex. 2017-02-26+01:00 |
terminationReason | 0..1 | Avslutningsorsak om momentet är avslutat. (se TerminationReason nedan) |
categories | 0..* | Lista med namn på de kategorier detta moment är märkt med. |
resident | 1..1 | Invånare som momentet gäller. invånare exporteras enligt den komplexa typen ResidentType (se ResidentType nedan) |
handlers | 1..* | Lista med ansvariga behandlare för momentet. Se komplexa typen HandlerType nedan. Varje handler-nod motsvarar en period då en behandlare har haft ansvar för momentet. Om en behandlare har haft ansvar för momentet under två olika tidsperioder kommer detta att representeras av två handler-fält. |
modules | 0..* | Lista med moduler som ingår i momentet. Varje modul exporteras genom den komplexa typen ModuleType. Denna lista kommer att alltid innehålla alla moduler som finns tillgängliga för momentet, även om moduler ännu inte påbörjats. |
measurementBatteries | 0..* | Lista med mätbatterier för momentet. Varje mätbatteri exporteras genom den komplexa datatypen MeasurementBatteryType (Se nedan) |
activityPlans | 0..* | Lista med aktivitetsplaner för momentet. Varje aktivitetsplan exporteras genom den komplexa datatypen ActivityPlanType (Se nedan) |
connectedProcesses | 0..* | Lista med information om moment som är länkade med detta moment. Länkade moment som exporteras här exporteras genom den komplexa typen ConnectedProcessType. Denna lista innehåller endast de unika IDn, namnen samt versionen på de länkade momenten. I fallet då användaren valt att exportera alla moment inklusive länkade moment för en viss invånare (ONLY_ONE_RESIDENT) kommer denna lista inte att exporteras. Istället exporteras en instans av ProcessType för varje moment som innehåller en komplett bild av momentet. |
conversations | 0..* | Lista med konversationer som har förts mellan behandlare och invånare under momentet. Konversationer består vidare av meddelanden eller kommentarer och exporteras som den komplexa typen ConversationType (se nedan). |
connectedProcesses 0..* (ConnectedProcessType)
Lista med information om länkade moment/behandlingar.
Attribut | Kardinalitet | Beskrivning |
|---|---|---|
id | 1..1 | Id för det kopplade momentet. |
name | 1..1 | Namnet på det kopplade momentet |
majorVersion | 1..1 | Huvudversion på det kopplade momentet |
minorVersion | 1..1 | Delversion på det kopplade momentet |
terminationReason 0..1 (TerminationReasonType)
Attribut | Kardinalitet | Beskrivning |
|---|---|---|
code | 1..1 | Komplex typ (CVType). Se vidare nedan underattributen för denna typ |
code.code | 0..1 | Kod till avslutningsorsak i Snomed. Tom om avslutningsorsak är satt till "Övrigt" eller om momentet avslutades innan release 1.12. Koder följer struktur enligt tabellen nedan (se Koder i Snomed). Koden beskrivs via den komplexa typen CVType (Coded value). |
code.codeSystem | 0..1 | N/A |
code.codeSystemName | 0..1 | N/A |
code.displayName | 0..1 | Titel på avslutningsorsak enligt Snomed. Tom om avslutningsorsak är satt till "Övrigt" (ingen kod/orsak definierad) eller om momentet avslutades innan release 1.12 |
code.originalText | 0..1 | N/A |
nameInSoB | 1..1 | Beskrivning/namn på avslutningsorsak enligt konfiguration i Stöd- och behandling. Denna beskrivning ska överrensstämma med beskrivning/konceptnamn i Snomed för förmedlad kod. |
Koder i Snomed
Term i snomed | Namn i Stöd och behandling | Kod i snomed |
|---|---|---|
behandling slutförd | Moment slutfört | 182992009 |
åtgärd stoppad | Behandlare avbryter moment | 394908001 |
patienten avböjer behandling | Invånare avbryter moment | 105480006 |
ändrad behandling | Ändrad behandling | 445528004 |
- | Övrigt | - |
handlers 1..* (HandlerType)
Lista med behandlare som avsvarat för momentet. Om en behandlare har haft ansvaret vid flera olika tidsperioder kommer det att skapas en post per sådan period. En behandlare kan således förekomma flera gånger i denna lista.
Attribut | Kardinalitet | Beskrivning |
|---|---|---|
hsaId | 1..1 | HSAId för behandlaren |
name | 1..1 | För- och efternamn för behandlaren |
startDate | 1..1 | Startdatum då behandlaren blev ansvarig för momentet. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon> |
endDate | 0..1 | Slutdatum för behandlarens ansvar för momentet. Tom om behandlaren fortfarande innehar ansvaret för momentet. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon> |
careGiver | 1..1 | Vårdgivare som behandlaren arbetar under, för momentet. Representeras av den komplexa typen OrgUnitType (Se nedan) |
careUnit | 1..1 | Vårdenhet som behandlaren arbetar under, för momentet. Representeras av den komplexa typen OrgUnitType (Se nedan) |
unit | 0..1 | Kopplad enhet som behandlaren arbetar under, för momentet. Representeras av den komplexa typen OrgUnitType (Se nedan) |
careGiver 1..1, careUnit 1..1, unit 0..1 (OrgUnitType)
Vårdgivare/vårdenhet eller kopplad enhet som behandlaren arbetar under.
Attribut | Kardinalitet | Beskrivning |
|---|---|---|
hsaId | 1..1 | Enhetens hsa-id. Motsvarar HSA-identitet på den enhet aktuellt uppdrag tillhör. |
name | 1..1 | Enhetens namn. |
modules 0..* (ModuleType)
Lista som innehåller alla moduler som finns tillgängliga för momentet. Listan innehåller även moduler som ännu inte är påbörjade för det specifika momentet. Antalet moduler i listan är m a o konstant för en specifik version av momentet.
Attribut | Kardianlitet | Beskrivning |
|---|---|---|
name | 1..1 | Namn på modulen |
index | 1..1 | Index (löpsiffra/numrering) för modulen, som visar i vilken ordning modulen legat i momentet. Behandlaren kan per moment välja att starta moduler i olika ordning så index kommer inte att motsvara den ordning invånaren har fått se modulerna, utan endast den ordning designern valt att lägga modulerna. |
statusChanges | 0..* | Lista med alla statusändringar för modulen. Moduler som aldrig startats och varit tillgängliga för invånaren kommer inte att ha några statusändringar. Varje statusändring representeras av den komplexa datatypen ModeuleStatusType (se nedan) |
statusChanges 0..* (ModuleStatusType)
Atribut | Kardinalitet | Beskrivning |
|---|---|---|
date | 1..1 | Datum och tid då statusändringen skedde. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon> |
status | 1.1 | Nytt status för modulen. En av (START|STOP|PENDING) START visar när modulen satts som tillgänglig för invånaren. Detta kan vara när behandlaren manuellt startat modulen, alternativt när modulen gjordes synlig i samband med vidmakthållande. STOP visar när behandlaren manuellt har satt en modul som avklarat. Moduler loggas inte som STOP i samband med vidmakthållande eller avslut av moment. PENDING visar när en behandlare manuellt satt en modul till kommande, efter att den startats. |
resident 1..1 (ResidentType)
Håller information gällande den invånare som behandlas.
Attribut | Kardinalitet | Beskrivning |
|---|---|---|
firstName | 0..1 | Invånarens förnamn. Ersätts med "Skyddad" om personuppgiften är skyddad. Om invånaren inte har ett förnamn anges "NOT DEFINED" |
lastName | 0..1 | Invånarens efternamn. Ersätts med "Identitet" om personuppgiften är skyddad. Om invånaren inte har ett efternamn anges "NOT DEFINED" |
personId | 0..1 | Personnummer enligt den komplexa datatypen PersonIdType |
1..1 | Personnummer eller liknande unik identifierare för invånare. I dagsläget stödjer systemet endast personnummer. Formatet för personnummer yyyymmdd-nnnn. T.ex. 19121212-1212 Om dataadmin valt att exportera prsonnummer hashat (krypterat) skrivs detta ut istället för personummer. | |
personId.type | 1..1 | OID eller liknande som visar vad för typ av identifierare för person som avses. Kan sättas till: "1.2.752.129.2.1.3.1" = Id genererat från Skatteverket och motsvarar person-id för någon som är folkbokförd i Sverige enligt SKV704. "HASHED_PERSON_ID" = Personnumret är krypterat. |
gender | 1..1 | Invånarens kön. Kan vara en av tre värden: MALE, FEMALE, OTHER. Om en person har skyddad identitet anges kön som OTHER. |
ageAtStart | 1..1 | Invånarens ålder vid start av momentet. |
conversations 0..* (ConversationType)
Lista med konversationer som antingen är av typen kommentar eller meddelande (Observera att datatypen ConversationType också innehåller en lista - messages. Se nästa avsnitt). Listan innehåller instanser av datatypen ConversationType som grupperar de enskilda kommentarerna/meddelandena. Samtliga konversationer ligger direkt under ProcessType, oavsett om det är kommentarer eller meddelanden.
Attribut | Kardinalitet | Beskrivning |
|---|---|---|
messageType | 1..1 | Vilken typ av meddelanden som finns i konversationen. MESSAGE - om konversationen innehåller fristående meddelanden. COMMENT - om konversationen innehåller kommentarer på steg eller formulär. |
messages | 0..* | Lista med de meddelanden som skickats i konversationen. Meddelanden som inte skickats (utkast) kommer inte med i exporten. |
messages 0..* (MessageType)
Lista med meddelanden/kommentarer. Varje instans i denna lista motsvarar det enskilda meddelandet/kommentaren som skickats inom en konversation. Konversationer är i sin tur antingen "meddelanden" eller "kommentarer"
Attribut | Kardinalitet | Beskrivning |
|---|