Kalenderelement iCalendar

xCal versjon 2.0 skal benyttes Skjemaet definerer ikke makslengder eller innhold i felter. Men for Digital dialog med innbygger er det innført begrensninger i brukergrensesnitt for feltlengder og ved lagring av data. Begrensninger er vist i tabellen under, dersom det sendes innhold lenger enn dette vil Helsenorge sende negativ AppRec (kode X99) på meldingen med informasjon om hvilket felt er for langt. Element Obligatorisk eller valgfri Beskrivelse Begrensning på innhold xcal:vcalendar.properties.version Obligatorisk Versjon av iCalendar standarden som benyttes xCal versjon 2.0 skal benyttes xcal:vcalendar.properties.prodid Obligatorisk Produktidentifikasjon av det produktet som genererte iCalendar objektet xcal:components Obligatorisk Angis på selve vcalendar objektet som inneholder alle vevent. På hver vevent må det også angis for å validere ihht XSD. <xcal:components/> xcal:dtstart Obligatorisk Starttidspunkt for time Tidssone skal være norsk tidssone: Normaltid (vinter): CET (Central European Time), UTC+1. Sommertid (sommer): CEST (Central European Summer Time), UTC+2.  Format: yyyy-MM-ddTHH:mm:ss xcal:dtend Obligatorisk Sluttidspunkt for time. Tidssone skal være norsk tidssone: Normaltid (vinter): CET (Central European Time), UTC+1. Sommertid (sommer): CEST (Central European Summer Time), UTC+2.  Format: yyyy-MM-ddTHH:mm:ss xcal:uid Obligatorisk Id for time på formatet UUID Id for time på formatet UUID xcal:contact Obligatorisk HER-id for kommunikasjonspart som timen tilhører (xcal:contact). Denne er nødvendig for å vite mottager for operasjoner som er tilgjengelig på en timeavtale, slik som avbestilling for en mottatt avtale. Det støttes mottak av denne av historiske grunner, men den blir ikke brukt og trenger ikke å være med. xcal:related-to Valgfri Id for relatert timeavtale, skal oppgis dersom denne id-en eksisterer. Denne benyttes i to tilfeller: Ved timebestilling i timebok henter Helsenorge ledige tidspunkt (slot) fra timebok og sender en forespørsel om en av disse. Timeavtalen opprettes i timebok. related-to skal ha verdien til sloten som Helsenorge sendte bestilling på, og uid settes til id til timeavtalen som ble bekreftet. Dersom det gjøres endringer på timeavtaler, der det opprettes en ny instans av timeavtalen skal related-to peke på opprinnelig avtale. Dette gjør det mulig for Helsenorge å identifisere avtalen som endret. xcal:categories Valgfri Benyttes for å angi timetype, se eget avsnitt kategorisering av avtaler.  Kodeverk "Timetype Innbyggerportal" med id 7617: Ved angivelse av flere kategorier så er eneste tillatte kombinasjon “Hastetime” og “Video“ xcal:summary Valgfri Benyttes for å angi oppsummering av avtale. For hjemmebaserte tjenester navn på tjenesten som utføres, f.eks. «Praktisk Bistand» eller «Hjemmesykepleie». Vises på Helsenorge som “Timen Gjelder” Maks 192 tegn xcal:description Valgfri Angir fritekstinformasjon om avtalen. Maks 1000 tegn xcal:rrule Valgfri Regelmessighet. Gjentagelse brukt ved planlagte besøk og eventuelle unntak fra gjentagelse, bruk av Rrule element. Støttes kun for hjemmebesøk Les mer under seksjonen “Angivelse av regelmessige avtaler i iCalendar”. xcal:xdate Valgfri Angit datoer som skal eksluderes fra regelmessighet. Støttes kun for hjemmebesøk Les mer under seksjonen “Angivelse av regelmessige avtaler i iCalendar”. xcal:location Valgfri Angivelse av hvor avtalen finner sted. Maks 255 tegn xcal:status Valgfri Angivelse av status for avtalen. Støttes kun for hjemmebesøk Følgende koder støttes: CONFIRMED CANCELLED COMPLETED xcal:x-cancellation-reason Valgfri Angir hvorfor en avtale har status avlyst. Ved angivelse av verdi som ikke er støttet settes default Avlyst av tjeneste. Brukes for hjemmebesøk. Følgende verdier er støttet: Avlyst av tjeneste Avlyst - ikke hjemme Avlyst av innbygger Avlyst på vegne av innbygger Ikke møtt xcal:x-referral-id Valgfri Referanse til henvisningsid Støttes kun for spesialisthelsetjenesten. Skal være en henvisnings-id xcal:attendee Valgfri Angivelse av deltagere i avtalen, benyttes blant annet for ansatte som utfører besøk. Mulig å angi flere. Støttes kun for hjemmebesøk Se informasjon her: iCalendar - attendee xcal:organizer Valgfri Angivelse av organisasjonen som utfører avtalen. Se informasjon her: iCalendar - organizer xcal:x-available-at Valgfri Angivelse av tidspunkt avtalen tilgjengeliggjøres eller gjøres valgbar for innbygger. Benyttes ved visning av ledige tidspunkt for timebestilling, ikke relevant for annen bruk. Tidssone skal være norsk tidssone: Normaltid (vinter): CET (Central European Time), UTC+1. Sommertid (sommer): CEST (Central European Summer Time), UTC+2.  Format: yyyy-MM-ddTHH:mm:ss xcal:x-servicetype Valgfri Angir alderstrinn for helsestasjoner og skolehelsetjenesten. Brukes for å vise standardisert informasjon om en timeavtale. Maks 20 tegn Kodeverk "Alderstrinn" med id 9505: xcal:x-contact-type Valgfri Angir møteform. Telefon/Video Støttes kun for timeønskeungdom Maks 255 tegn XML eksempel på iCalendar med svar fra fastlegen vedørende bekreftelse av reservasjon av en time: <xcal:vcalendar> <xcal:properties> <xcal:prodid> <xcal:text>System NN</xcal:text> </xcal:prodid> <xcal:version> <xcal:text>2.0</xcal:text> </xcal:version> </xcal:properties> <xcal:components> <xcal:vevent> <xcal:properties> <xcal:dtstart> <xcal:date-time>2012-02-13T09:15:00</xcal:date-time> </xcal:dtstart> <xcal:dtend> <xcal:date-time>2012-02-13T09:30:00</xcal:date-time> </xcal:dtend> <xcal:summary> <xcal:text>Konsultasjon med lege NN</xcal:text> </xcal:summary> <xcal:description> <xcal:text>Din time er bekreftet. Du får SMS påminnelse før konsultasjonen. Mvh. Legekontor NN.</xcal:text> </xcal:description> <xcal:uid> <xcal:text>012d1e50-760e-11e2-bcfd-0800200c9a66</xcal:text> </xcal:uid> <xcal:contact> <xcal:text>91095 </xcal:text> </xcal:contact> <xcal:related-to> <xcal:uri>651b1341-26ca-11e4-8c21-0800200c9a66</xcal:uri> </xcal:related-to> </xcal:properties> <xcal:components/> </xcal:vevent> </xcal:components> </xcal:vcalendar>

En endring kan være hvilke som helst informasjon som er synlig for innbygger: Start-/slutt tidspunkt Oppmøtested Avtaletype (endret til/fra video/telefon time / fysisk oppmøte) Hva timen gjelder Beskrivelse Behandler ... Endring som trigger varsel om endret timeavtale Hvis en time blir endret, sendes det varsel med informasjon om at timen er endret. For å regnes som endret må oppmøtested, starttid eller timetype. Andre endringer vil vises, men ikke varsles. Identitethåndtering ved endringer Følgende identiteter brukes for å identifisere hvilke timeavtale på Helsenorge endringen gjelder. For å finne treff på timeavtale som skal oppdateres så sjekkes verdiene i skrivende rekkefølge. Ved ingen treff vil timeavtale tolkes som ny. Verdi Er påvkrevd Kommentar Related-to fra iCalendar Valgfri Dette feltet skal brukes ved oppdatering av timeavtaler til å referere til opprinnelig timeavtale. Ved oppdateringer der den oppdaterte timeavtalen ikke har lik uid som den hadde før endringen er dette feltet obligatorisk. Forventes være statisk verdi på tvers av endringer. Verdien skal peke på opprinnelige timeavtale. Dersom related-to er lik en eksisterende avtales related-to, eller peker på en eksisterende avtales uid så vil den eksisterende avtalen oppdateres. Uid fra iCalendar Påkrevd Id for time på formatet UUID (xcal:uid) Dersom uid er lik en eksisterende avtales uid så vil den eksisterende avtalen oppdateres. Dersom uid endrer seg (når uid representerer et konkret tidspunkt), så skal related-to brukes for å identifisere eksitserende avtale. RefToConversation / RefToParent fra Hodemeldingen Valgfri Dersom ingen treff på related-to/uid så gjøres en sjekk på RefToConversation/RefToParent. Det gjør det mulig å finne eksisterende timeavtale når innbygger har sendt forespørsel. Ikke ment som primær identitet for å finne eksisterende timeavtale. Oppførsel ved endrete felter For noen felter beholder vi forrige verdi dersom en endret timeavtale ikke har med dette feltet og for noen fjerner vi informasjonen dersom de ikke er med. Her er en liste over de ulike feltene og hvordan de oppfører seg ved timeendring: Element Kategori Forklaring av logikk ved manglende xcal:version Obligatorisk Dette er et påkrevd felt, og må alltid være med xcal:prodid Obligatorisk Må alltid være med for å identifisere systemet som genererte avtalen xcal:uid Obligatorisk Dette er et påkrevd felt, og må alltid være med xcal:dtstart Obligatorisk Dette er et påkrevd felt, og må alltid være med xcal:dtend Oppdateres kun hvis verdi er satt Beholder gammel verdi hvis feltet mangler eller er blankt og den har vært satt tidligere xcal:contact Obligatorisk. Informasjonen fra denne brukes ikke på Helsenorge, da det er teknisk avsender i hodemeldingen som brukes for adressering Dette er et påkrevd felt, og må alltid være med xcal:summary Oppdateres kun hvis verdi er satt Beholder gammel verdi hvis feltet mangler eller er blankt og den har vært satt tidligere xcal:description Oppdateres alltid Oppdateres uansett, blank tolkes som sletting xcal:categories Gruppetime: Oppdateres alltid Møteform: Settes for video og telefontime Oppdateres uansett, om ikke angitt så setter timeavtale som ordinær. Om flere verdier er angitt så brukes kun først angitte category. Unntak er kombinasjon av hastetime + videotime som håndteres som en videotime. xcal:status Oppdateres kun hvis verdi er satt Beholder gammel verdi hvis feltet mangler eller er blankt og den har vært satt tidligere xcal:x-cancellation-reason Oppdateres kun hvis verdi er satt Beholder gammel verdi hvis feltet mangler eller er blankt og den har vært satt tidligere xcal:rrule Ikke relevant med endring Dersom denne sendes med, så ignoreres den da vi bare bruker den ved å gjøre oppslag på timer fra hjemmetjenesten. xcal:related-to Brukes for å indentifisere original timeavtale dersom uid er endret på den originale avtalen Brukes for å identifisere hvilke timeavtale som skal oppdateres. xcal:location Oppdateres og fjernes hvis blank Oppdateres uansett, blank tolkes som sletting xcal:attendee Oppdateres og fjernes hvis blank. Oppdateres uansett, blank tolkes som sletting Brukes kun for hjemmetjeneste xcal:organizer Oppdateres og fjernes hvis blank Oppdateres uansett, blank tolkes som sletting xcal:x-available-at Ikke relevant med endring Tidspunkt avtalen blir tilgjengelig. Dette feltet gir ikke mening ved oppdatering av en timeavtale, da det brukes før en avtale bookes. xcal:x-servicetype Oppdateres og fjernes hvis blank Oppdateres uansett, blank tolkes som sletting xcal:x-contact-type Oppdateres og fjernes hvis blank Oppdateres uansett, blank tolkes som sletting

For å kunne angi referanse til intern henvisningsid i meldingen mellom og spesialisthelsetjenesten er det lagt til et egendefinert element «x-referral-id» i xCal for dette. Element «x-referral-id» er definert i en egen xsd (iCalendar-DigitalDialogSpesialist-extensions.xsd) som må inkluderes fra iCalendar.xsd. Denne metoden for å legge til egendefinerte elementer er i henhold til slik det er beskrevet i selve xCal/iCalendar standarden. For å kunne bruke element «x-referral-id» i XML-meldinger må exstensions-skjemaet iCalendar-DigitalDialogSpesialist-extensions.xsd være inkludert fra iCalendar.xsd, og iCalendar-DigitalDialogSpesialist-extensions.xsd må være tilgjengelig. XML eksempel på iCalendar med informasjon om en time som har henvisning: <xcal:vcalendar> <xcal:properties> <xcal:prodid> <xcal:text>System NN</xcal:text> </xcal:prodid> <xcal:version> <xcal:text>2.0</xcal:text> </xcal:version> </xcal:properties> <xcal:components> <xcal:vevent> <xcal:properties> <xcal:dtstart> <xcal:date-time>2015-08-13T09:00:00</xcal:date-time> </xcal:dtstart> <xcal:dtend> <xcal:date-time>2015-08-13T10:30:00</xcal:date-time> </xcal:dtend> <xcal:summary> <xcal:text>Kontrolltime</xcal:text> </xcal:summary> <xcal:uid> <xcal:text>abc123</xcal:text> </xcal:uid> <xcal:x-referral-id> <xcal:text>xyz789</xcal:text> </xcal:x-referral-id > </xcal:properties> <xcal:components/> </xcal:vevent> </xcal:components> </xcal:vcalendar>

EPJ-systemet kan kategorisere avtaler for å angi mer detaljert type avtale. For dette er det etablert et kodeverk "Timetype Innbyggerportal" med id 7617: . Elementet «categories» i iCalendar skal brukes til å angi timetype, dersom det ikke behøves eller er angitt noen spesifikk timetype skal elementet «categories» ikke brukes. Kodeverket som benyttes angis ikke i Categories. Det er støtte for flere timetyper samtidig, men bare noen kombinasjoner er tillatt. Per i dag er den eneste tillatte kombinasjonen ved avtaleutsending “Hastetime” og “Video“. Dersom flere kategories sendes, er det kun den første angitte som benyttes. Følgende verdier av timetype er tatt i bruk: "Ordinær". Ordinær time, ved fravær av timetype benyttes denne som default - (brukes ved bestilling, timevisning og varsling). "Hastetime". Benyttes for hastetimer - (brukes kun ved timebestilling) "Video". Avtalen er en videotime - (brukes ved bestilling, timevisning og varsling) “Telefon”: Avtalen gjennomføres på telefon - (brukes ved bestilling, timevisning og varsling) "Tidsvindu". Benyttes for hjemmebesøk - (brukes kun ved timevisning) "Gruppetime". Avtaler som inneholder flere pasienter Alle under, - brukes ved bestilling, timevisning og varsling: "Vaksine". Time for vaksinering, Kan gi eget varsel og visning til innbygger "Lab".  Time på lab, Kan gi eget varsel og visning til innbygger "Koronatest". Kan gi eget varsel for time for koronatest, innført for pandemien "Koronavaksine". Kan gi eget varsel for time for koronavaksine, innført for pandemien Et eksempel på angivelse av en hastetime på video er vist under. <xcal:categories> <xcal:text>Hastetime</xcal:text> <xcal:text>Video</xcal:text> </xcal:categories>

EPJ-systemet kan angi om en planlagt avtale er et tidsvindu når informasjon om planlagte avtaler sendes til . Med tidsvindu menes en avtale der start og stopp indikerer en forventet periode der avtalen inntreffer, uten at avtalen forventes å vare hele perioden. Et eksempel på et tidsvindu er en avtale som inntreffer en gang mellom 10:00 og 12:00 og forventes å vare i 30 minutter. Timene vil vises ulikt for innbygger på for å tydeliggjøre dette. Dersom timen er et tidsvindu kan også forventet varighet på avtalen angis. For standard avtaler kan start og stopp eller start og duration angis, det er ikke mulig å oppgi start, stopp og duration. Det er derfor lagt til en custom extension for å støtte dette, x-expected duration. Merk: Inntil 31.10.2023 var eksempelet for duration feil i henhold til Iso spesifikasjonen. Tidligere var det angitt “P30M” for å angi 30 minutter, riktig er “PT30M” Angivelse av et tidsvindu med en avtale med antatt varighet på 30 min er vist under: <xcal:categories> <xcal:text>Tidsvindu</xcal:text> </xcal:categories> <xcal:x-expected-duration> <xcal:duration>PT30M</xcal:duration> </xcal:x-expected-duration>

Timeboken kan angi tidspunktet for når avtalen blir tilgjengelig for bestilling. Timen gjøres først valgbar for innbygger når dagens tidspunkt er likt eller overstiger tidspunktet angitt. Før dette tidspunktet vises avtalen som ikke bestillbar. Elementet er en utvidelse av iCalandar standarden, XML eksempel er vist under. <xcal:x-available-at> <xcal:date-time>2018-07-25T08:00:00</xcal:date-time> </xcal:x-available-at> Elementet skal ikke benyttes sammen med timer som ikke kan bestilles på nett. Det vil si timer som har kategori="Must-call" skal ikke ha dette feltet angitt, og vil overse elementet i dette tilfellet.

Ved henting av ledige timer kan timeboken angi at en time ikke kan bestilles elektronisk. Elementet «categories» i iCalendar skal brukes til å angi ikke bestillbar time. Følgende verdi skal benyttes for dette. "MustCall". Benyttes for å vise at en time ikke er tilgjengelig for elektronisk bestilling og innbygger må kontakte behandler på annen måte. Denne verdien er bare relevant ved henting av ledige timer, ved overføring av bekreftede timer skal denne ikke benyttes.

Kategorien "MustCall" som angir en time som ikke kan bookes på nett kan kombineres med andre timetyper. I tillegg kan noen timetype kombineres med tidspunkt for tilgjengeliggjøring. Tabellen under viser lovlige kombinasjoner og funksjonell betydning. Kombinasjonene benyttes kun ved henting av ledige timer, dersom en time allerede er bekreftet skal MustCall og available-at ikke benyttes. Timetype Bestillbar available-at Betydning (Ingen) (ingen) Vanlig konsultasjon, timetype ikke angitt (Ingen) Tidspunkt Vanlig konsultasjon, tilgjengelig for booking etter angitt tidspunkt (Ingen) MustCall N/A Vanlig konsultasjon som ikke kan bookes på nett Hastetime (ingen) Hastetime Hastetime Tidspunkt Hastetime, tilgjengelig for booking etter angitt tidspunkt Hastetime MustCall N/A Hastetime som ikke kan bookes på nett Video (ingen) Videotime Video Tidspunkt Videotime, tilgjengelig for booking etter angitt tidspunkt. Video MustCall N/A Videotime som ikke kan bookes på nett

Tilsvarende som beskrevet i under Referanse til helsekontakt- Sakstype kan det angis en referanse til helsekontakt i et kalenderelement. Dette behøves for eksempel der en melding har flere kalenderelement, og hvert kalenderobjekt må spesifisere referanse.    Elementet «categories» i iCalendar benyttes til å angi ID til tjenesten, med prefiks "Tjenesteid:". Angivelse av et en avtale som er et tidsvindu og som leveres av tjenesteId=12 vises under: <xcal:categories> <xcal:text>Tidsvindu</xcal:text> <xcal:text>TjenesteId:12</xcal:text> </xcal:categories>

Standarden for regelmessige avtaler i iCal benyttes for å angi timer som gjentas, dette gjelder typisk for besøk innen Pleie og omsorg. Følgende elementer fra standarden er støttet: Element Lovlige verdier Kommentar Freq DAILY, WEEKLY Regelmessige avtaler støttes for avtaler som inntreffer hver dag, eller ukentlig. Måned og år er ikke implementert. Skjema støtter timer, minutter og sekunder, det er heller ikke implementert Count (alle) Antall ganger avtale gjentas Interval (alle) Intervall mellom hver gjentagelse, f.eks. for å angi at en avtale inntreffer hver andre uke Byday (alle) Angivelse av hvilke ukedager avtale inntreffer på Elementet «recur» i iCalendar skal brukes når en time er regelmessig. Et eksempel for en avtale som gjentas daglig hver ukedag 103 ganger er vist under. <xcal:dtstart> <xcal:date-time>2017-05-16T09:15:00</xcal:date-time> </xcal:dtstart> <xcal:rrule> <xcal:recur> <xcal:freq>WEEKLY</xcal:freq > <xcal:count >103</xcal:count > <xcal:byday> MO,TU,WE,TH,FR</xcal:byday > </xcal:recur> </xcal:rrule> Et eksempel for en avtale som gjentas ukentlig annenhver onsdag uten sluttdato er vist under. <xcal:dtstart> <xcal:date-time>2017-05-16T09:15:00</xcal:date-time> </xcal:dtstart> <xcal:rrule> <xcal:recur> <xcal:freq>WEEKLY</xcal:freq > <xcal:interval >2</xcal:interval > <xcal:byday> WE</xcal:byday > </xcal:recur> </xcal:rrule> For å angi unntak fra regler om gjentagelse benyttes exdate, et eksempel på dette er vist under med et unntak for 17.5.2017 og 24.5 <xcal:dtstart> <xcal:date-time>2017-05-16T09:15:00</xcal:date-time> </xcal:dtstart> <xcal:rrule> <xcal:recur> <xcal:freq>WEEKLY</xcal:freq > <xcal:byday> WE</xcal:byday > </xcal:recur> </xcal:rrule> <xcal:exdate> <xcal:date-time>2017-05-17T09:15:00</xcal:date-time> </xcal:exdate> <xcal:exdate> <xcal:date-time>2017-05-24T09:15:00</xcal:date-time> </xcal:exdate>

EPJ-systemet kan angi status for en avtale, og vil benytte stauts for visning. Elementet «Status» i iCalendar skal brukes for å indikere dette, med lovlige verdier TENTATIVE. Avtale er planlagt men ikke bekreftet CONFIRMED: Avtale er bekreftet CANCELLED: Avtale er avlyst I tillegg benyttes følgende status for utførte hjemmebesøk: COMPLETED: Avtale er utført Et eksempel er vist under: <xcal:status> <xcal:text>TENTATIVE</xcal:text> </xcal:status>

Dersom status er avlyst «CANCELLED» kan årsak til avlysning angis i x-cancelllation-reason. Dette er en utvidelse av iCalendar og følgende verdier kan benyttes for årsak til avlysning: Avlyst av tjeneste. Avtalen ble avlyst av organisasjonen som skulle utføre avtalen Avlyst - ikke hjemme: Avtalen ble avlyst fordi ingen var hjemme, «Bomtur» Avlyst av innbygger. Avtalen ble avlyst av innbygger, enten elektronisk eller fysisk Avlyst på vegne av innbygger: Avtalen ble avlyst av person med fullmakt for innbygger Et eksempel er vist under: <status> <text>CANCELLED</text> </status> <x-cancellation-reason> <text> Avlyst av innbygger</text> </x-cancellation-reason>

Dersom en helseaktør har tatt i bruk en videoløsning og videoløsningen krever overføring av en lenke til videoventerom, kan lenken sendes med som et attributt på avtalen. Dersom det sendes med en videolenke, skal timetype settes til "Videotime" og lenken til venterommet legges inn i feltet url. Videoproduktet som benyttes sendes i extensionfeltet x-videoproduct som er lagt til iCal definisjonen. URL benyttes for uthopp fra Helsenorge, videoprodukt benyttes for å validere lenke og gi produkveiledning til innbygger. Et eksempel er vist under: <url> <uri>https://videoventerom.video.no</uri> </url> <x-videoproduct> <text>Videoprodukt</text> </x-videoproduct> <categories> <text>Video</text> </categories>

For å angi hvilken konsultasjonstype en avtale gjelder kan det legget ved et attributt x-servicetype. Dette angir en kodet verdi for hvilken tjeneste som er planlagt. iCal standarden har ingen god representasjon av kodeverk, verdien som angis skal oppgis som <kodeverkId>:<Kodeverdi>. Foreløpig er denne kun benyttet for kodeverk 9505 Alderstrinn og for å angi faste konsultasjoner for helsestasjon og skolehelsetjeneste. Utvidelsen er basert på feltet servicetype i FHIR appointment, slik at samme informasjon skal kunne overføres også ved bruk av FHIR. Et eksempel er vist under for en konsultasjon etter 4 uker på helsestasjon. <x-servicetype> <text>9505:4U</text> </x-servicetype> Helsenorge benytter denne koden til å hente ytterligere informasjon om timen basert på nasjonale retningslinjer.