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

AttributKardinalitetBeskrivning
exportDate1..1

Tidsstämpel för när exporten skedde. Skrivs som yyyy-MM-dd'T'hh:mm:ss+<tidszon>

systemName1..1Namnet på systemet "Stöd och behandling"
processName1..1Namnet på momentetmallen som valdes vid exportfiltreringen
specifiedSelection1..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). 

selectedCategories0..*Lista med kategorier som valdes att exporteras, om FILTER_ON_CATEGORIES valdes ovan.
status1..*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.
residentAnonymization1..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.

modulesExported1..1Visar om modulinformation valdes att exporteras. true/false.
messageTransactionsExported1..1Visar om meddelandehistorik valdes för export. true/false.
activityPlansExported1..1Visar om formulär som ingår i aktivitetsplaner med eventuellt tillhörande resultat valdes för export. true/false
measurementBatteriesExported1..1

Visar om formulär som ingår i mätbatterier med eventuellt tillhörande resultat valdes för export. true/false.

formsExported1..1

Visar om formulär som inte ingår i mätbatterier med eventuellt tillhörande resultat valdes att exporteras. true/false.

startFromPeriod0..1Anvä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.
startToPeriod0..1Anvä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.
endFromPeriod0..1Anvä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.
endToPeriod0..1Anvä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.
processes0..*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.

AttributKardinalitetBeskrivning
id1..1Unikt Id för momentet.
name1..1

Momentets namn.

T.ex. Rehabilitering efter knäskada

status1..1

Den status som momentet hade vid exporttillfället. Status kan vara följande:

INPROGRESS - Pågående

DONE - Avslutad

MAINTAIN - I vidmakthållande

majorVersion1..1

Momentets huvudversion. Version på momentet består av de två attributen majorVersion och minorVersion.

T.ex. 1.2 ger majorVersion = 1 minorVersion = 2

minorVersion1..1

Momentets delversion. Version på momentet består av de två attributen majorVersion och minorVersion.

T.ex. 1.2 ger majorVersion = 1 minorVersion = 2

startDate1..1

Momentets start enligt formatet yyyy-MM-dd'T'hh:mm:ss+<tidszon>.

T.ex. 2015-01-13T10:00:00.000+01:00

lastActivityDate0..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 

endDate0..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

terminationReason0..1Avslutningsorsak om momentet är avslutat. (se TerminationReason nedan)
categories0..*Lista med namn på de kategorier detta moment är märkt med.
resident1..1Invånare som momentet gäller. invånare exporteras enligt den komplexa typen ResidentType (se ResidentType nedan)
handlers1..*

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.

modules0..*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.
measurementBatteries0..*Lista med mätbatterier för momentet. Varje mätbatteri exporteras genom den komplexa datatypen MeasurementBatteryType (Se nedan)
activityPlans0..*Lista med aktivitetsplaner för momentet. Varje aktivitetsplan exporteras genom den komplexa datatypen ActivityPlanType (Se nedan)
connectedProcesses0..*

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.

conversations0..*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.

AttributKardinalitetBeskrivning
id1..1Id för det kopplade momentet.
name1..1

Namnet på det kopplade momentet

majorVersion

1..1Huvudversion på det kopplade momentet
minorVersion1..1Delversion på det kopplade momentet

terminationReason 0..1 (TerminationReasonType)

AttributKardinalitetBeskrivning
code1..1Komplex typ (CVType). Se vidare nedan underattributen för denna typ
code.code0..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..1N/A
code.codeSystemName0..1N/A
code.displayName0..1Titel på avslutningsorsak enligt Snomed. Tom om avslutningsorsak är satt till "Övrigt" (ingen kod/orsak definierad) eller om momentet avslutades innan release 1.12
code.originalText0..1N/A
nameInSoB1..1Beskrivning/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 snomedNamn i Stöd och behandlingKod i snomed
behandling slutfördMoment slutfört182992009
åtgärd stoppadBehandlare avbryter moment394908001
patienten avböjer behandlingInvånare avbryter moment105480006
ändrad behandlingÄndrad behandling445528004
-Ö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.

AttributKardinalitetBeskrivning
hsaId1..1HSAId för behandlaren
name1..1För- och efternamn för behandlaren
startDate1..1Startdatum då behandlaren blev ansvarig för momentet. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon>
endDate0..1Slutdatum 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>
careGiver1..1Vårdgivare som behandlaren arbetar under, för momentet. Representeras av den komplexa typen OrgUnitType (Se nedan)
careUnit1..1Vårdenhet som behandlaren arbetar under, för momentet. Representeras av den komplexa typen OrgUnitType (Se nedan)
unit0..1Kopplad 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.

AttributKardinalitetBeskrivning
hsaId1..1

Enhetens hsa-id. Motsvarar HSA-identitet på den enhet aktuellt uppdrag tillhör.

name1..1Enhetens 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.

AttributKardianlitetBeskrivning
name1..1

Namn på modulen

index1..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)

AtributKardinalitetBeskrivning
date1..1Datum och tid då statusändringen skedde. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon>
status1.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.

AttributKardinalitetBeskrivning
firstName0..1

Invånarens förnamn.

Ersätts med "Skyddad" om personuppgiften är skyddad.

Om invånaren inte har ett förnamn anges "NOT DEFINED"

lastName0..1

Invånarens efternamn.

Ersätts med "Identitet" om personuppgiften är skyddad.

Om invånaren inte har ett efternamn anges "NOT DEFINED"

personId0..1

Personnummer enligt den komplexa datatypen PersonIdType

personId.id1..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.type1..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.

gender1..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.

ageAtStart1..1Invå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.

AttributKardinalitetBeskrivning
messageType1..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.

messages0..*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"

AttributKardinalitetBeskrivning
sentDate1..1Datum och tid för när meddelandet skickades. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon>

sender

1..1

Visar vem som skickat meddelandet.

HANDLER = meddelandet skickat av behandlaren till invånaren

RESIDENT = meddelandet skickat av invånaren till behandlaren

handlerHsaId0..1HSAId för behandlaren som skickade meddelandet. Saknas om det var invånaren som skickade meddelandet.
handlerName0..1Namn (för och efternamn) på behandlaren. Saknas om det var invånaren som skickade meddelandet.

activityPlans 0..* (ActivityPlanType)

Lista med aktivitetsplaner för momentet. Varje aktivitetsplan exporteras genom den komplexa datatypen ActivityPlanType

AttributKardinalitetBeskrivning
name1..1Namn på aktivitetsplanen
activities0..*Lista med aktiviteter. Varje instans i denna lista är av typen ActivityType (se ActivityType nedan)

activities 0..* (ActivityType)

activities innehåller en eller flera instanser av ActivityType. Varje ActivityType motsvarar en aktivitet, i form av ett formulär (en instans av ett formulär) som ska fyllas i.

AttributKardinalitetBeskrivning
status1..1

Status då aktiviteten fått sin statusförändring;

MISSED: Invånaren har missad aktiviteten

SKIPPED: invånaren har satt aktiviteten som skippad

SAVED: Invånaren har sparat

CANCELLED: Behandlaren har inaktiverat aktivitetsplanen

Obesvarade/pågående aktiviteter visas inte i XML-filen.

statusDate1..1Datum för statusändringen. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon>.
activity0..1Attribut som pekar på den specifika formulärinstansen som ingått i aktiviteten. (se FormType nedan)

forms 0..*, activity 0..1 (FormType)

Lista med formulär då formulären är del av ett mätbatteri eller övriga formulär, kopplade till momentet.

Om formuläret däremot är den del av en aktivitetsplan innefattas datatypen FormType i instansen activity (ActivityType). I det fallet råder ett-till-ett förhållande mellan aktiviteten (ActivityType) och formuläret (FormType).

Formulär som är delsparade kommer inte med i exporten.

AttributKardinalitetBeskrivning
templateId1..1

Id för formulärmallen. Dessa id:n är unika för varje exporterat moment. Id:n är, för gemensamma formulär, unikt per momentmall och om formuläret uppdaterats får det istället en ny version. Om formulär är gemensamma kommer detta id att vara detsamma för alla versioner av det formuläret. Om formuläret inte är gemesamt kommer ett nytt id att genereras vid ny majorversion av momentet.

Om formuläret finns i en aktivitetsplan som skapats av behandlaren kommer id vara olika per startat moment.

(varning) De moment som exporterats av designern innan release 1.12 (24/10-17) har unika id per version av moment, oavsett om formuläret är oförändrat eller inte.

templateVersion1..1

Versionsnummer för formulärmallen i Stöd och behandling.

De enda formulär som idag har versionshantering är gemensamma formulär. Momentspecifika formulär kommer därför ha versionsnummer 1.

(varning) Endast de moment som publicerats/exporterats efter release 1.12 (24/10-17) kommer att ha rätt versionsnummet, övriga kommer att ha version 1.

templateAlternativeName0..1Altenativt namn som angetts för formuläret. Kommer endast med om designer angett denna information.
name1..1

Formulärets namn.

T.ex. Hälsodeklaration

id

1..1Unikt id för formulärinstansen. Detta unika id består även mellan exportuttag. Olika uttag som pekar på samma formulärmalls-instans kommer således att få samma unika id.
lastSavedDate0..1

Datum och tid för när formuläret senast sparades av invånare. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon>.

referralDate0..1

Hänvisningsdatum (det datum formuläret avser) för formulär som ingår i kalenderformulär eller aktivitetsplaner. 

Om formulär är av typen kalender skrivs endast datum för kalenderdagen ut.

2015-10-09T00:00:00+0200

status1..1

Status på formuläret. Kan vara en av följande (SUCCESS|ERASED)

SUCCESS = Formuläret finns.

ERASED = Formuläret finns ej.

questions0..*Lista med frågor som ingår i formuläret. Varje fråga representeras av en instans av datatypen QuestionType.
results0..*Lista med resultat som är genererade utifrån formulärsvaren i ett formulär (en formulärinstans). Varje resultat i listan representeras av den komplexa datatypen ResultType. (Se nedan)

results 0..* (ResultType)

Lista med resultat.

AttributKardinalitetBeskrivning
name1..1Namn på resultat
alternativeName0..1Alternativt namn på resultat. Kommer endast med om designern angivit alternativt namn för resultatet.
value1..1Resultatets värde

questions 0..* (QuestionType)

Lista med frågor i ett formulär. Frågor som är av typen media eller informationstext kommer inte med i exporten då de inte har några svar.

AttributKardinalitetBeskrivning
question1..1

Frågetexten - frågan.

T.ex. Hur mår du?

index1..1Index/löpsiffra på frågan. Löpsiffran visar på vilken fråga, i ordningen, det är inom formuläret. Det kan förekomma "luckor" i denna serie av ordnings-index. Detta kan exempelvis inträffa om formuläret är designat med följdfrågor, d v s frågor som endast presenteras för invånaren/patienten om svaret på tidigare fråga innehåller specifikt/specifika svar. Indexsiffran som visas för en viss fråga är persistent mellan olika exporter av samma formulär (som är genererad utifrån en specifik version av en formulärmall. Det betyder att om exempelvis frågan "Hur mår du?" får index 5 i ett uttag så kommer samma fråga i andra formulärinstanser (som bygger på samma mall) att få samma index.
inputType1..1

Typ av gränssnittsinmatning för frågan. Exempelvis huruvida frågan gäller ett textsvar, en "rullgardin" med förvalda svar, checkboxar som tillåter flera svar mm.

Möjliga värden är:

"TEXT" = Textinmatning 

(Om frågor i aktivitetsplaner är av typen "text" kommer de alltid att innehålla numreriska heltal)

"TEXTAREA" = Textarea

"NUMBER" = Sifferinmatning

"CHECKBOX" = Checkbox

"RADIO" = Radioknapp

"SELECT" = Select

"SCALE" = Skala

"NONE" = N/A

"RANGE" = Slider i formulär eller skala i aktivitetsplan

"MATRIXCHECKBOX" = Matris checkbox 

"MATRIXRADIO" = Matris radioknapp

superiourIndex0..1Index för den fråga som föranledde denna fråga. Detta värde finns endast om frågan är av typen följdfråga.
min0..1Vid inputType RANGE/SCALE anger detta värde minsta giltiga värdet
max0..1Vid inputType RANGE/SCALE anger detta värde högsta giltiga värdet
minText0..1Textuell beskrivning av minsta värdet vid inputType RANGE/SCALE
maxText0..1Textuell beskrivning av högsta värdet vid inputType RANGE/SCALE
interval0..1Tal som anger det minsta steg mellan svar en invånare kan ange vid inputType RANGE.
unit0..1

Enhet för frågan. Gäller endast aktivitetsplaner. Kan vara:

cm, km, meter, kg, gram, mmHg, mmol/l, timmar, minuter, st, ggr

description0..1N/A
answerAlternatives0..*

Lista med möjliga svar vid frågor som har fasta svarsalternativ (förhandsval).

Varje svarsalternativ i listan representeras av en instans av datatypen AnswerAlternativesType.

answers0..*

Lista med svar. Listan kan bestå av mer än ett svar då frågan rör en flervalsfråga


answerAlternatives 0..* (AnswerAlternativeType)

Lista med svarsalternativ.

AttributKardinalitetBeskrivning
index1..1Index/löpsiffra för svarsalternativet. Varje svarsalternativ får ett unikt löpnummer inom frågan. Detta index används sedan för att förmedla svaret/svaren som invånaren/patienten valde
answer1..1Den textuella representationen av svaret. Exempelvis "JA", "NEJ". Gäller vid checkboxar och liknande frågor.

answers 0..* (AnswerType)

Lista med svar

AttributKardinalitetBeskrivning
answer1..1Svaret som invånare angav eller valde från en förvals/flervalsfråga
answerAlternativeIndex0..1Om svaret härstammar från en förvalsfråga eller flervalsfråga håller detta attribut svarsalternativets index (se AnswerAlternativeType ovan).

measurementBatteries 0..* (MeasurementBatteryType)

De mätbatterier som har genomförts under momentets gång. I varje mätbatteri ingår ett eller flera formulär.

AttributKardinalitetBeskrivning
name1..1Namn på mätbatteri
alternativeName0..1Alternativt namn på mätbatteri. Kommer endast med om designern angivit detta.
status

1..1

Status för mätbatteriet:

MISSED: Invånaren har missat att fylla i mätbatteriet under utsatt tid.

SAVED: Invånaren har fyllt i samtliga formulär som ingår i mätbatteriet.

CANCELLED: Behandlaren har avbrutit mätbatteriet.

Ett mätbatteri som pågår kommer inte med i exporten. 

Mätbatterier som har status MISSED eller CANCELLED kan helt sakna formulärfrågor/svar. Har dock invånaren hunnit sparat ett eller flera formulär men inte alla formulär i ett mätbatteri kommer dessa att komma med. 

createdDate1..1

Tidpunkt då mätbatteriet blivit tillgängligt för invånaren. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon>.

measurementEventDate1..1

Tidpunkt då mätbatteriet besvarats (dvs samtliga formulär som ingår har besvarats) av invånaren, alternativt den tidpunkt det satts till missad eller avbruten i systemet. Visas som yyyy-MM-dd'T'hh:mm:ss+<tidszon>.

forms0..*Lista med formulärinstanser som är besvarade i mätbatteriet. Populeras endast om mätbatteriet har formulär som besvarats.

Bilagor

FilBeskrivning
Schemafil för XML exportformatet

Projektfil för modellering av datamodell och för automatgenerering av schemafil (XSD)

Projektfilen är i Visual Paradigm format